Changes between Version 12 and Version 13 of DASISH/XSD and XML

Timestamp:

04/12/13 11:31:37 (11 years ago)

Author:

mwindhouwer

Comment:

--

DASISH/XSD and XML

@@ -405 +405 @@
 }}}
 
+=== Remarks by Menzo ===
+
+{{{<ownerRef>...</ownerRef>}}} is inconsistent with how other references are represented. I would propose {{{<owner ref="..."/>}}}
+
+I'm missing the reference for targetSource, i.e., {{{<targetSource ref="...">...</targetSource>}}}
+
+I also think versionString is superfluous here, the reference will allow the client to get that information if she wants.
+
+I don't think we should use a kind of [[http://en.wikipedia.org/wiki/Hungarian_notation|Hunagrian notation]] by including information on the type in the element/attribute names.
+
 == Responding GET api/annotations/AID02 (example usage for resolvable target sources) == 
 
@@ -440 +450 @@
 }}}
 
+=== Remarks by Menzo ===
+
+This one should be equivalent (in structure not content) to GET api/annotations/AID01 below.
+
 == Responding GET api/annotations/AID01 (example usage for unresolvable target sources) == 
 
@@ -447 +461 @@
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://www.dasish.eu/ns/addit file:/Users/olhsha/repositories/DASISH/t5.6/docs/XMLandXSD/DASISH-schema.xsd" 
- xml:id="AID002" 
- URI="http://www.dasish.eu/DB/AID002" 
+ xml:id="AID01" 
+ URI="http://www.dasish.eu/DB/AID01" 
  timeStamp="2010-05-04T18:13:51.0Z">
     <owner ref="ID01"/>
@@ -517 +531 @@
 }}}
 
+=== Remarks by Menzo ===
+
+The versions list contains the version you looking at as well, e.g., the version list of SID005 consists of SID005 and SID015. Is this so because the list is ordered and we can determine the position of the version under consideration?
+
+For very dynamic and popular target sources the version list might become big, that could be a reason to move it to a separate call. Actually we have already GET api/sources/<sid>/versions, so I would leave them out here.
+
+I would make {{{<versionString/>}}} just {{{<version/>}}}, see a previous remark.
+
 == Responding GET api/sources/SID05/cached (example usage for unresolvable target sources) ==
 
@@ -529 +551 @@
 }}}
 
+=== Remarks by Menzo ===
+
+As the cached representations are included in the sources response, this call would be superfluous in the Scenario.
+
 == Responding GET api/sources/SID05/cached/CID005A (example usage for unresolvable target sources) == 
 
@@ -539 +565 @@
 }}}
 
+=== Remarks by Menzo ===
+
+According to the API this would be the response of GET api/sources/SID05/cached/CID005A/metadata
+
 == Request body for POST api/annotations ==
 
@@ -547 +577 @@
  xsi:schemaLocation="http://www.dasish.eu/ns/addit file:/Users/olhsha/repositories/DASISH/t5.6/docs/XMLandXSD/DASISH-schema.xsd" 
  xml:id="AID0010" 
- URI="http://www.dasish.eu/ns/addit/DB" 
+ URI="http://www.dasish.eu/addit/DB" 
  timeStamp="2013-05-04T18:13:51.0Z">
     <owner ref="ID02"/>
@@ -570 +600 @@
 </newAnnotation>
 }}}
+
+=== Remarks by Menzo ===
+
+{{{@xml:id}}}s won't be known by the client yet, so leave out any {{{@xml:id}}} or give it a temp value if we need that for document internal referential integrity.
+
+As before I would replace {{{versionString}}} by {{{version}}}.
+
+I miss the result of this POST, which is interesting as it might signal the client to provide a cached representation for the unknown target source. Could be something like:
+
+{{{#!xml
+<?xml version="1.0" encoding="UTF-8"?>
+<annotation xmlns="http://www.dasish.eu/ns/addit"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://www.dasish.eu/ns/addit file:/Users/olhsha/repositories/DASISH/t5.6/docs/XMLandXSD/DASISH-schema.xsd" 
+ xml:id="AID123" 
+ URI="http://www.dasish.eu/addit/DB/AID123" 
+ timeStamp="2013-05-04T18:13:51.0Z">
+    <targetSources>
+        <targetSource xml:id="SID018">
+            <URI>http://en.wikipedia.org/wiki/Sagrada_Fam%C3%ADlia#Organ</URI>
+            <action>CREATE_CACHED_REPRESENTATION</action>
+        </targetSource>
+    </targetSources>
+</annotation>
+}}}