[MOBY-guts] biomoby commit

[Mark Wilkinson]

mwilkinson
Wed Sep 28 18:05:58 EDT 2005
Update of /home/repository/moby/moby-live/Docs/MOBY-S_API
In directory pub.open-bio.org:/tmp/cvs-serv31107

Modified Files:
	CentralRegistry.html XMLPayloads.html 
Log Message:
updating the docs with new features added yesterday v.v. retreival of namespaces and service types.  Also a couple of doc errors fixed.

moby-live/Docs/MOBY-S_API CentralRegistry.html,1.2,1.3 XMLPayloads.html,1.2,1.3
===================================================================
RCS file: /home/repository/moby/moby-live/Docs/MOBY-S_API/CentralRegistry.html,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- /home/repository/moby/moby-live/Docs/MOBY-S_API/CentralRegistry.html	2005/08/25 16:03:20	1.2
+++ /home/repository/moby/moby-live/Docs/MOBY-S_API/CentralRegistry.html	2005/09/28 22:05:58	1.3
@@ -72,13 +72,13 @@
 <tr class=odd><td> 
 <a href="XMLPayloads.html#retrieveServiceTypes"><notimplemented>retrieveServiceTypes</notimplemented></a>
 </td>
-<td> <notimplemented>Retrieve the service ontology, showing all registered service types.</notimplemented> </td>
+<td>Retrieve the definitions and registration details of all registered service types.</td>
 </tr>
 
 <tr class=even><td> 
 <a href="XMLPayloads.html#retrieveObjectNames"><notimplemented>retrieveObjectNames</notimplemented></a>
 </td>
-<td> <notimplemented>Retrieve the object ontology, showing all registered object types.</notimplemented>
+<td>Retrieve the object ontology, showing all registered object types.
 </td>
 </tr>
 
@@ -98,7 +98,7 @@
 <tr class=odd><td> 
 <a href="XMLPayloads.html#retrieveObject"><notimplemented>retrieveObjectSchema</notimplemented></a>
 </td>
-<td> <notimplemented>Retrieve an XML schema representation of a particular object class.</notimplemented>
+<td> <notimplemented>Retrieve an XML schema representation of a particular object class.  This is currently not implemented since it appears to be impossible to represent MOBY Objects in XML Schema due to limitations of XML Schema</notimplemented>
 </td>
 </tr>
 

===================================================================
RCS file: /home/repository/moby/moby-live/Docs/MOBY-S_API/XMLPayloads.html,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- /home/repository/moby/moby-live/Docs/MOBY-S_API/XMLPayloads.html	2005/08/25 16:03:20	1.2
+++ /home/repository/moby/moby-live/Docs/MOBY-S_API/XMLPayloads.html	2005/09/28 22:05:58	1.3
@@ -221,7 +221,16 @@
        &lt;Resource name="Namespace" url="...Y..."/&gt;
    &lt;/resourceURLs&gt;
 </pre>
+
 <h4>Notes</h4>
+<ul>
+
+<li> Finds the URL from which the RDF of a MOBY Ontology
+can be retrieved by HTTP GET.  There are five possible ontology names:
+"Service", "Object", "Namespace", "ServiceInstance", or "Full" (Full
+retrieves all of the ontologies) </li>
+
+</ul>
 
 <h3><a name ="retrieveServiceNames"> retrieveServiceNames </a></h3>
 <h4>Input XML</h4>
@@ -235,16 +244,16 @@
                 ...
         &lt;/serviceNames&gt;
 </pre>
-
 <h4>Notes</h4>
 <ul>
-
-<li> Finds the URL from which the RDF of a MOBY Ontology
-can be retrieved by HTTP GET.  There are five possible ontology names:
-"Service", "Object", "Namespace", "ServiceInstance", or "Full" (Full
-retrieves all of the ontologies) </li>
-
+<li> Retrieves minimal information about all registered MOBY services </li>
+<ul>
+    <li>serviceName
+    <li>authority
+    <li>service instance LSID
 </ul>
+</ul>
+
 
 <h3><a name ="retrieveServiceTypes"> retrieveServiceTypes </a></h3>
 
@@ -256,6 +265,8 @@
         &lt;serviceTypes&gt;
            &lt;serviceType name="serviceName" lsid='urn:lsid:authority.uri:servicetype:id'&gt;
                   &lt;Description&gt;&lt;![CDATA[free text description here]]&gt;&lt;/Description&gt;
+                  &lt;contactEmail&gt;email at address here&lt;/contactEmail&gt;
+                  &lt;authURI&gt;authority.uri.here&lt;/authURI&gt;
            &lt;/serviceType&gt;
                 ...
         &lt;/serviceTypes&gt;
@@ -263,7 +274,7 @@
 <h4>Notes</h4>
 <ul>
 
-<li> Gets a full dump of the Service Type ontology (excluding
+<li> Gets a full dump of the Service Type ontology as MOBY XML (excluding
 relationships) </li>
 
 <li><notimplemented> A new API call will be created at a later date to retrieve the
@@ -343,6 +354,8 @@
         &lt;Namespaces&gt;
            &lt;Namespace name="namespace" lsid='urn:lsid:authority.uri:namespace:id'&gt;
                   &lt;Description&gt;&lt;![CDATA[free text description here]]&gt;&lt;/Description&gt;
+                  &lt;contactEmail&gt;email at address here&lt;/contactEmail&gt;
+                  &lt;authURI&gt;authority.uri.here&lt;/authURI&gt;
            &lt;/Namespace&gt;
                 ...
         &lt;/Namespaces&gt;