Changes between Version 3 and Version 4 of DASISH/Scenario


Ignore:
Timestamp:
04/11/13 07:00:12 (11 years ago)
Author:
twagoo
Comment:

structured sub-scenarios

Legend:

Unmodified
Added
Removed
Modified

  • DASISH/Scenario

    v3 v4  
    1010= Web-annotator/API interaction scenarios =
    1111
    12 '''TODO''' add example XML serializations of requests/responses to serve as basis for (modifications of) the schemata
     12'''TODO''' (general): add example XML serializations of requests/responses to serve as basis for (modifications of) the schemata
    1313
    1414== Authentication ==
    … …  
    2020
    2121* User: visits the page <...>.
    22 * The client: requests the lists of annotations to which the user has "read" access.
    23 * GET api/annotations?source=<...>&access=read
    24 * The call returns list of annotation id-s with the corresponding headlines, notebooks, owners, and target sources URI's ('''TODO''' Olha: example XML +schema of the respond).
    25 * Resolving fragments (mapping) happens after the response. There are two internal lists for the client: the resolvable and unresolvable target.
     22* Client: requests the lists of annotations to which the user has "read" access.
     23 * GET api/annotations?source=<...>&access=read
     24* Service: returns list of annotation id-s with the corresponding headlines, notebooks, owners, and target sources URI's ('''TODO''' Olha: example XML +schema of the respond).
     25* Client: Resolving fragments (mapping) happens after the response. There are two internal lists for the client: the resolvable and unresolvable target.
    2626
    2727== Viewing an individual annotation ==
    … …  
    2929=== Resolvable target ===
    3030* User: selects an annotation with "at least one resolvable" (debatable) target for reading. 
    31 * The client GET api/annotations/<aid> (Olha, to do: XML of the respond)
     31* Client: retrieves the annotation
     32 * GET api/annotations/<aid>
     33* Service: returns the annotation
     34 * (Olha, to do: XML of the respond)
    3235
    3336=== Unresolvable target ===
    3437* User: select an annotation with unresolvable targets for reading.
    35 * The client: GET api/annotations/<aid> (Olha, to do: example XML+schema of the respond, for all 4 calls),
    36 * GET api/annotations/<aid>/sources
    37 * GET api/sources/<sid>/cached
    38 * GET api/sources/<sid>/cached/<cid>
     38* Client: get annotation and its target sources
     39 *GET api/annotations/<aid> (Olha, to do: example XML+schema of the respond, for all 4 calls),
     40 * GET api/annotations/<aid>/sources
     41* Client: get cached representations for target sources
     42 * GET api/sources/<sid>/cached
     43 * GET api/sources/<sid>/cached/<cid>
    3944
    4045== Annotation creation ==
    4146* User: creates a text note on a selected text.
    42 * The client: POST api/annotation (Olha, to do: input example XML+schema of the body, like in the example)
    43 * Response: the annotation <aid>, with temp id-s replaced by the permanent ones, the full URI for the target sources,
    44 * action:create cached representation.
    45 * Followed by POST/api/cources/<sid>/cached
     47* Client: sends the annotation to the server
     48 * POST api/annotation (Olha, to do: input example XML+schema of the body, like in the example)
     49* Service: responds with the annotation <aid>, with temp id-s replaced by the permanent ones, the full URI for the target sources,  action:create cached representation.
     50* Client: sends cached representation
     51 * POST/api/cources/<sid>/cached
     52* Service: store representation
    4653
    4754== Editing an annotation body ==