- removed /{datasource} from web service urls, since they are not required anymore

- updated name_catalogue documentation with Andreas' comments

diff --git a/src/site/apt/remote/name-catalogue-default.apt b/src/site/apt/remote/name-catalogue-default.apt
index 0a57e3c3b2c758326f44c57924db823bce4eb27a..2ac61e549e7efc408fa7d91b0c977ed11049e860 100755 (executable)
--- a/src/site/apt/remote/name-catalogue-default.apt
+++ b/src/site/apt/remote/name-catalogue-default.apt
@@ -18,7 +18,7 @@ CDM Taxonomic Name Search API
                                                                        
        The response format can be set by appending the format extension to the service endpoint. Currently this web service supports JSON (fully implemented) and XML (partially implemented).
        
-       The response returned by this web service endpoint is described as,
+       The response objects returned by this web service endpoint have the following structure:
                          
                * <<<request>>>
                
@@ -45,23 +45,23 @@ CDM Taxonomic Name Search API
                
                * Base scientific name search :         
                                
-                       * {{{./name_catalogue.json?query=Abies Alba} /{datasource-name}/name_catalogue.json?query=Abies Alba}}
+                       * {{{./name_catalogue.json?query=Abies Alba} /name_catalogue.json?query=Abies Alba}}
                        
                * Complete scientific name search : 
                
-                       * {{{./name_catalogue.json?query=Abies Alba Mill.&type=title} /{datasource-name}/name_catalogue.json?query=Abies Alba Mill.&type=title}}
+                       * {{{./name_catalogue.json?query=Abies Alba Mill.&type=title} /name_catalogue.json?query=Abies Alba Mill.&type=title}}
                        
                * Multiple queries :
                        
-                       * {{{./name_catalogue.json?query=Abies Alba&query=Manihot esculenta} /{datasource-name}/name_catalogue.json?query=Abies Alba&query=Manihot esculenta}}
+                       * {{{./name_catalogue.json?query=Abies Alba&query=Manihot esculenta} /name_catalogue.json?query=Abies Alba&query=Manihot esculenta}}
                        
-                       * {{{./name_catalogue.json?query=Abies Alba Mill.&query=Manihot esculenta Crantz&type=title} /{datasource-name}/name_catalogue.json?query=Abies Alba Mill.&query=Manihot esculenta Crantz&type=title}}
+                       * {{{./name_catalogue.json?query=Abies Alba Mill.&query=Manihot esculenta Crantz&type=title} /name_catalogue.json?query=Abies Alba Mill.&query=Manihot esculenta Crantz&type=title}}
                        
                * Errors :
                
-                       * {{{./name_catalogue.json?query=Abies Alb} /{datasource-name}/name_catalogue.json?query=Abies Alb}}
+                       * {{{./name_catalogue.json?query=Abies Alb} /name_catalogue.json?query=Abies Alb}}
                        
-                       * {{{./name_catalogue.json?query=Abies Alba&query=Manihot escenta} /{datasource-name}/name_catalogue.json?query=Abies Alba&query=Manihot escenta}}
+                       * {{{./name_catalogue.json?query=Abies Alba&query=Manihot escenta} /name_catalogue.json?query=Abies Alba&query=Manihot escenta}}
                
                        
                        

diff --git a/src/site/apt/remote/name-catalogue-name-info.apt b/src/site/apt/remote/name-catalogue-name-info.apt
index b10fe1c08a4ddf2ee40bed4b075163eb0f9779c1..4b01dcd9c69be674e2cbc203d04ce73ff5334622 100755 (executable)
--- a/src/site/apt/remote/name-catalogue-name-info.apt
+++ b/src/site/apt/remote/name-catalogue-name-info.apt
@@ -13,7 +13,7 @@ CDM Taxonomic Name Information API
                                                                        
        The response format can be set by appending the format extension to the service endpoint. Currently this web service supports JSON (fully implemented) and XML (partially implemented).
        
-       The response returned by this web service endpoint is described as,
+       The response objects returned by this web service endpoint have the following structure:
                          
                * <<<request>>>
                
@@ -48,15 +48,15 @@ CDM Taxonomic Name Information API
                
                * Single name uuid request :    
                                
-                       * {{{../name_catalogue/name.json?nameUuid=cd4bc51f-ddcd-4e9c-aa02-4301fd78debf} /{datasource-name}/name_catalogue/name.json?nameUuid=cd4bc51f-ddcd-4e9c-aa02-4301fd78debf}}
+                       * {{{../name_catalogue/name.json?nameUuid=cd4bc51f-ddcd-4e9c-aa02-4301fd78debf} /name_catalogue/name.json?nameUuid=cd4bc51f-ddcd-4e9c-aa02-4301fd78debf}}
                        
                * Multiple name uuid request : 
                
-                       * {{{../name_catalogue/name.json?nameUuid=cd4bc51f-ddcd-4e9c-aa02-4301fd78debf&nameUuid=0d5e07b6-2646-4210-80e0-fcd449e26b57} /{datasource-name}/name_catalogue/name.json?nameUuid=cd4bc51f-ddcd-4e9c-aa02-4301fd78debf&nameUuid=0d5e07b6-2646-4210-80e0-fcd449e26b57}}
+                       * {{{../name_catalogue/name.json?nameUuid=cd4bc51f-ddcd-4e9c-aa02-4301fd78debf&nameUuid=0d5e07b6-2646-4210-80e0-fcd449e26b57} /name_catalogue/name.json?nameUuid=cd4bc51f-ddcd-4e9c-aa02-4301fd78debf&nameUuid=0d5e07b6-2646-4210-80e0-fcd449e26b57}}
                        
                * Errors :
                
-                       * {{{../name_catalogue/name.json?nameUuid=cd4bc51f-ddcd-4e9c-aa02} /{datasource-name}/name_catalogue/name.json?nameUuid=cd4bc51f-ddcd-4e9c-aa02}}
+                       * {{{../name_catalogue/name.json?nameUuid=cd4bc51f-ddcd-4e9c-aa02} /name_catalogue/name.json?nameUuid=cd4bc51f-ddcd-4e9c-aa02}}
                
                        
                        

diff --git a/src/site/apt/remote/name-catalogue-taxon-info.apt b/src/site/apt/remote/name-catalogue-taxon-info.apt
index 256c6867f9af0e19a7c8599c759143a97be76fdf..39a7bf7e724525f4295061d8001f1a709bdf7947 100755 (executable)
--- a/src/site/apt/remote/name-catalogue-taxon-info.apt
+++ b/src/site/apt/remote/name-catalogue-taxon-info.apt
@@ -21,7 +21,7 @@ CDM Taxonomic Taxon Information API
                                                                        
        The response format can be set by appending the format extension to the service endpoint. Currently this web service supports JSON (fully implemented) and XML (partially implemented).
        
-       The response returned by this web service endpoint is described as,
+       The response objects returned by this web service endpoint have the following structure:
                          
                * <<<request>>>
                
@@ -62,20 +62,20 @@ CDM Taxonomic Taxon Information API
                
                * Single taxon uuid request :   
                                
-                       * {{{../name_catalogue/taxon.json?taxonUuid=6d2a61d0-3167-4f19-840a-4280dc3751d9} /{datasource-name}/name_catalogue/taxon.json?taxonUuid=6d2a61d0-3167-4f19-840a-4280dc3751d9}}
+                       * {{{../name_catalogue/taxon.json?taxonUuid=6d2a61d0-3167-4f19-840a-4280dc3751d9} /name_catalogue/taxon.json?taxonUuid=6d2a61d0-3167-4f19-840a-4280dc3751d9}}
                        
                * Single taxon uuid request with all possible classifications :
                
-                       * {{{../name_catalogue/taxon.json?taxonUuid=6d2a61d0-3167-4f19-840a-4280dc3751d9&classification=all} /{datasource-name}/name_catalogue/taxon.json?taxonUuid=6d2a61d0-3167-4f19-840a-4280dc3751d9&classification=all}}
+                       * {{{../name_catalogue/taxon.json?taxonUuid=6d2a61d0-3167-4f19-840a-4280dc3751d9&classification=all} /name_catalogue/taxon.json?taxonUuid=6d2a61d0-3167-4f19-840a-4280dc3751d9&classification=all}}
 
                        
                * Multiple taxon uuid request : 
                
-                       * {{{../name_catalogue/taxon.json?taxonUuid=6d2a61d0-3167-4f19-840a-4280dc3751d9&taxonUuid=1e331521-8db2-4da0-926a-fe7e0425ae03} /{datasource-name}/name_catalogue/taxon.json?taxonUuid=6d2a61d0-3167-4f19-840a-4280dc3751d9&taxonUuid=1e331521-8db2-4da0-926a-fe7e0425ae03}}
+                       * {{{../name_catalogue/taxon.json?taxonUuid=6d2a61d0-3167-4f19-840a-4280dc3751d9&taxonUuid=1e331521-8db2-4da0-926a-fe7e0425ae03} /name_catalogue/taxon.json?taxonUuid=6d2a61d0-3167-4f19-840a-4280dc3751d9&taxonUuid=1e331521-8db2-4da0-926a-fe7e0425ae03}}
                        
                * Errors :
                
-                       * {{{../name_catalogue/taxon.json?taxonUuid=6d2a61d0-3167-4f19-840a-4280dc3751} /{datasource-name}/name_catalogue/taxon.json?taxonUuid=6d2a61d0-3167-4f19-840a-4280dc3751}}
+                       * {{{../name_catalogue/taxon.json?taxonUuid=6d2a61d0-3167-4f19-840a-4280dc3751} /name_catalogue/taxon.json?taxonUuid=6d2a61d0-3167-4f19-840a-4280dc3751}}
                
                        
                        

diff --git a/src/site/apt/rest-api.apt b/src/site/apt/rest-api.apt
index 3d2661c895e4ce55d0a456f9fd335df44ff4f845..688439101af6e6e9f6ea94390819a8fd06391a29 100644 (file)
--- a/src/site/apt/rest-api.apt
+++ b/src/site/apt/rest-api.apt
@@ -197,7 +197,7 @@ In the following the generic URIs are documented first followed by type specific
 "$"
 ----
 
-*** /\{datasource-name\}/\{base-type\}/
+*** /\{base-type\}/
 
        Depending on the URI parameters used, this service returns either a Pager on or a List of the \{base-type\} entities identified by the \{uuid\}. 
 The returned \{base-type\} instances are initialized by the <default initialisation strategy>. 
@@ -221,7 +221,7 @@ The returned \{base-type\} instances are initialized by the <default initialisat
        * <type> Further restricts the type of entities to return. If null the type mapped by \{base-type\} is being used. - <optional parameter>
 
 
-*** /\{datasource-name\}/\{base-type\}/name/\{uuid\}
+*** /\{base-type\}/name/\{uuid\}
 
        Get the \{base-type\} entity identified by the \{uuid\}. 
 
@@ -229,7 +229,7 @@ The returned \{base-type\} instances are initialized by the <default initialisat
 
        The returned \{base-type\} entity is initialized by the <default initialisation strategy>. 
 
-*** /\{datasource-name\}/\{base-type\}/name/\{uuid\}/annotation
+*** /\{base-type\}/name/\{uuid\}/annotation
 
        Get the a Pager on the Annotations for the \{base-type\} entity identified by the \{uuid\}. 
 
@@ -240,7 +240,7 @@ The returned \{base-type\} instances are initialized by the <default initialisat
 
 
 
-*** /\{datasource-name\}/name/\{name-uuid\}/typeDesignations
+*** /name/\{name-uuid\}/typeDesignations
 
        Get the list of TypeDesignationBases of the TaxonNameBase instance identified by the \{name-uuid\}. 
 
@@ -254,7 +254,7 @@ The returned \{base-type\} instances are initialized by the <default initialisat
 "typifiedNames.taggedName"
 ----
 
-*** /\{datasource-name\}/taxon/\{taxon-uuid\}/accepted
+*** /taxon/\{taxon-uuid\}/accepted
 
        Get the set of accepted Taxon entities for a given \{@link TaxonBase\} entity identified by the <code>\{taxon-uuid\}</code>.
 
@@ -264,13 +264,13 @@ The returned \{base-type\} instances are initialized by the <default initialisat
 
 ** Portal Service
 
-*** /\{datasource-name\}/portal/name/\{name-uuid\} 
+*** /portal/name/\{name-uuid\} 
 
        The TaxonNameBase instance identified by the \{name-uuid\}. 
        The returned TaxonNameBase is initialized by the following strategy 
 
 
-*** /\{datasource-name\}/portal/name/\{name-uuid\}/descriptions
+*** /portal/name/\{name-uuid\}/descriptions
 
        Get the list of TaxonNameDescriptions of the Name associated with the TaxonNameBase instance identified by the \{name-uuid\}.
 
@@ -286,7 +286,7 @@ The returned \{base-type\} instances are initialized by the <default initialisat
 "elements.media.representations.parts"
 ----
 
-*** /\{datasource-name\}/portal/name/\{name-uuid\}/typeDesignations
+*** /portal/name/\{name-uuid\}/typeDesignations
 
        Get the list of TypeDesignationBases of the TaxonNameBase instance identified by the \{name-uuid\}. 
 
@@ -303,7 +303,7 @@ The returned \{base-type\} instances are initialized by the <default initialisat
 ----
 
 
-*** /\{datasource-name\}/portal/taxon/\{taxon-uuid\}
+*** /portal/taxon/\{taxon-uuid\}
 
        Get the TaxonBase instance identified by the \{taxon-uuid\}. 
        The returned Taxon is initialized by the following strategy TAXON_INIT_STRATEGY 
@@ -322,7 +322,7 @@ The returned \{base-type\} instances are initialized by the <default initialisat
 "descriptions.elements.media.representations.parts",
 ----
 
-*** /\{datasource-name\\}/portal/taxon/find 
+*** /portal/taxon/find 
 
        Find Taxa, Synonyms, Common Names by name, either globally or in a specific geographic area. 
 
@@ -359,7 +359,7 @@ The returned \{base-type\} instances are initialized by the <default initialisat
 "name.status.type.representations"
 ----
 
-*** /\{datasource-name\}/portal/taxon/\{taxon-uuid\}/synonymy
+*** /portal/taxon/\{taxon-uuid\}/synonymy
 
        Get the synonymy for a taxon identified by the \{taxon-uuid\}. The synonymy consists of two parts: The group of homotypic synonyms of the taxon and the heterotypic synonymy groups of the taxon. The synonymy is ordered historically by the type designations and by the publication date of the nomenclatural reference 
 
@@ -387,7 +387,7 @@ The returned \{base-type\} instances are initialized by the <default initialisat
 "name.homotypicalGroup.typifiedNames.taxonBases.name.taggedName"
 ----
 
-*** /\{datasource-name\}/portal/taxon/\{taxon-uuid\}/accepted
+*** /portal/taxon/\{taxon-uuid\}/accepted
 
        Get the set of accepted Taxon entities for a given \{@link TaxonBase\} entity identified by the <code>\{taxon-uuid\}</code>.
 
@@ -415,7 +415,7 @@ The returned \{base-type\} instances are initialized by the <default initialisat
 "name.homotypicalGroup.typifiedNames.taxonBases.name.taggedName"
 ----
 
-***  /\{datasource-name\}/portal/taxon/\{taxon-uuid\}/taxonRelationships 
+***  /portal/taxon/\{taxon-uuid\}/taxonRelationships 
 
        Get the list of TaxonRelationships for the given TaxonBase instance identified by the \{taxon-uuid\}. 
 
@@ -430,7 +430,7 @@ The returned \{base-type\} instances are initialized by the <default initialisat
 "fromTaxon.name.taggedName"
 ----
 
-*** /\{datasource-name\}/portal/taxon/\{taxon-uuid\}/nameRelationships
+*** /portal/taxon/\{taxon-uuid\}/nameRelationships
 
        Get the list of NameRelationships of the Name associated with the TaxonBase instance identified by the \{taxon-uuid\}. 
 
@@ -444,7 +444,7 @@ The returned \{base-type\} instances are initialized by the <default initialisat
 "fromName.taggedName"
 ----
 
-*** /\{datasource-name\}/portal/taxon/\{taxon-uuid\}/nameTypeDesignations
+*** /portal/taxon/\{taxon-uuid\}/nameTypeDesignations
 
        Get the list of TypeDesignationBases of the TaxonBase instance identified by the \{taxon-uuid\}. 
 
@@ -459,7 +459,7 @@ The returned \{base-type\} instances are initialized by the <default initialisat
 "typeName.taggedName"
 ----
 
-*** /\{datasource-name\}/portal/taxon/\{taxon-uuid\}/descriptions
+*** /portal/taxon/\{taxon-uuid\}/descriptions
 
        Get the list of TaxonDescriptions of the Taxon instance identified by the \{taxon-uuid\}. 
 
@@ -475,13 +475,13 @@ The returned \{base-type\} instances are initialized by the <default initialisat
 "elements.media.representations.parts"
 ----
 
-*** /\{datasource-name\}/portal/taxon/\{taxon-uuid\}/media/\{mime type list\}/\{size\}[,[widthOrDuration\}][,\{height\}]/
+*** /portal/taxon/\{taxon-uuid\}/media/\{mime type list\}/\{size\}[,[widthOrDuration\}][,\{height\}]/
 
        Get the list of TaxonDescriptions of the Taxon instance identified by the \{taxon-uuid\}. 
 
        <Usage:>
 
-       /\{datasource-name\}/portal/taxon/\{taxon-uuid\}/media/\{mime type list\}/\{size\}[,[widthOrDuration\}][,\{height\}]/ 
+       /portal/taxon/\{taxon-uuid\}/media/\{mime type list\}/\{size\}[,[widthOrDuration\}][,\{height\}]/ 
  
        <Whereas>
        
@@ -503,7 +503,7 @@ The returned \{base-type\} instances are initialized by the <default initialisat
 "elements.media.representations.parts"
 ----
 
-*** datasource-name\}/portal/taxontree
+*** /portal/taxontree
 
        Lists all available TaxonomicTrees. 
 
@@ -515,7 +515,7 @@ The returned \{base-type\} instances are initialized by the <default initialisat
 "reference.authorTeam.titleCache"
 ----
 
-*** /\{datasource-name\}/portal/taxontree/\{tree-uuid\},\{rank-uuid\}
+*** /portal/taxontree/\{tree-uuid\},\{rank-uuid\}
 
        Lists all TaxonNodes of the specified TaxonomicTree for a given Rank. If a branch does not contain a TaxonNode with a TaxonName at the given Rank the node associated with the next lower Rank is taken as root node. If the rank is null the absolute root nodes will be returned. 
 
@@ -536,7 +536,7 @@ The returned \{base-type\} instances are initialized by the <default initialisat
 "taxon.name.taggedName"
 ----
 
-***  /\{datasource-name\}/portal/taxontree/\{tree-uuid\},\{rank- uuid\}/\{taxon-uuid\}
+***  /portal/taxontree/\{tree-uuid\},\{rank- uuid\}/\{taxon-uuid\}
 
        Lists all child-TaxonNodes of the specified Taxon in the TaxonomicTree. The a given Rank is ignored in this method but for consistency reasons it has been allowed to included it into the URI. 
 
@@ -559,7 +559,7 @@ The returned \{base-type\} instances are initialized by the <default initialisat
 "taxon.name.taggedName"
 ----
 
-***  /\{datasource-name\}/portal/taxontree/\{tree-uuid\},\{rank-uuid\}/\{taxon-uuid\}/path
+***  /portal/taxontree/\{tree-uuid\},\{rank-uuid\}/\{taxon-uuid\}/path
 
        Provides path of TaxonNodes from the base node to the node of the specified taxon. 
 
@@ -584,7 +584,7 @@ The returned \{base-type\} instances are initialized by the <default initialisat
 
 ** External Service
 
-*** /\{datasource-name\}/geo/map/distribution/\{taxon-uuid\}
+*** /geo/map/distribution/\{taxon-uuid\}
 
        Assembles and returns URI parameter Strings for the EDIT Map Service. 
 The distribution areas for the Taxon instance identified by the \{taxon-uuid\} are found and are translated into an valid URI parameter String.