Changes between Version 12 and Version 13 of DASISH/Scenario

Timestamp:

04/12/13 14:06:18 (11 years ago)

Author:

olhsha

Comment:

--

DASISH/Scenario

@@ -12 +12 @@
 
 
-'''ToDo:''' (general): add example XML serializations of requests/responses to serve as basis for (modifications of) the schemata
+'''ToDo:''' (general): add example XML serializations of requests/responses to serve as basis for (modifications of) the schemata. 
+
+'''Status'''. Partially done.
 
 = Authentication =
-* User logs-in to annotation service, so the UID gets known by the server.
-
-'''ToDo:''' Add to API the "who-am-I" service that allows the user to obtain his/her UID and list of notebooks(read and write), incl. their id's and rendering names.
-
-'''Status''': done, pls check [[SpecificationDocument#Userrealm]] and [[XSD and XML#RespondingGETapiuser]]
+* User logs-in to annotation service, so the UID gets known by the server. See [[SpecificationDocument#Userrealm]] and [[XSD and XML#RespondingGETapiuser]]
 
 = Visiting an annotated web page =
 
-* User: visits the page <...>. 
+* User: visits the page  http://en.wikipedia.org/wiki/Sagrada_Fam%C3%ADlia (for example).
 * Client: requests the lists of annotations to which the user has "read" access. 
- * GET api/annotations?source=<...>&access=read
+ * GET api/annotations?source="http://en.wikipedia.org/wiki/Sagrada_Fam%C3%ADlia"&access=read
 * 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. 
-
-'''Status'''. Done, pls check [[XSD and XML#RespondingGETapiannotationssourcehttp:en.wikipedia.orgwikiSagrada_FamC3ADliaaccessread]]
+See [[XSD and XML#RespondingGETapiannotationssourcehttp:en.wikipedia.orgwikiSagrada_FamC3ADliaaccessread]]
 
 * Client: Resolving fragments (mapping) happens after the response. There are two internal lists for the client: the resolvable and unresolvable target.
@@ -42 +38 @@
 * Service: returns the annotation 
 
-'''ToDo:''' Olha: xml.
-
-'''Status'''. Done, pls check [[XSD and XML#RespondingGETapiannotationsAID02exampleusageforresolvabletargetsources]].
+See [[XSD and XML#RespondingGETapiannotationsAID02exampleusageforresolvabletargetsources]].
 
 == Unresolvable target ==
@@ -55 +49 @@
 * GET api/sources/<sid>/cached/<cid> 
 
-'''ToDo:''' Olha: examples XML+schema of the respond, for all 4 calls.
-
-'''Status'''. Done, pls check [[XSD and XML#RespondingGETapiannotationsAID01exampleusageforunresolvabletargetsources]], [[XSD and XML#RespondingGETapiannotationsAID01sourcesexampleusageforunresolvabletargetsources]], [[XSD and XML#RespondingGETapisourcesSID05cachedexampleusageforunresolvabletargetsources]], [[XSD and XML#RespondingGETapisourcesSID05cachedCID005Aexampleusageforunresolvabletargetsources]].
+See [[XSD and XML#RespondingGETapiannotationsAID01exampleusageforunresolvabletargetsources]], [[XSD and XML#RespondingGETapiannotationsAID01sourcesexampleusageforunresolvabletargetsources]], [[XSD and XML#RespondingGETapisourcesSID05cachedexampleusageforunresolvabletargetsources]], [[XSD and XML#RespondingGETapisourcesSID05cachedCID005Aexampleusageforunresolvabletargetsources]].
 
 = Annotation creation =
@@ -63 +55 @@
 * Client: sends the annotation to the server
 * POST api/annotation 
-
-'''ToDo:''' Olha: input example XML+schema of the body.
-
-'''Status'''. Done, pls check [[XSD and XML#RequestbodyforPOSTapiannotations]].
+See  [[XSD and XML#RequestbodyforPOSTapiannotations]], two versions, with and without action "CREATE_CACHED_REPRESENTATION". 
 
 * 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.
 * Client: sends cached representation
  * POST/api/cources/<sid>/cached
+
+The serialisation is an instance of the same element as the serialization of the respond on GET api/sources/<sid>/cached/<cid>
+=== Olha's question ===
+Agree??
+
+
 * Service: store representation