Changes between Version 20 and Version 21 of GAPI_AM_API_V3_DETAILS

Timestamp:

07/19/12 10:05:04 (12 years ago)

Author:

Aaron Helsinger

Comment:

--

GAPI_AM_API_V3_DETAILS

@@ -34 +34 @@
         geni_api_versions = {
              '3' = <This server's AM API absolute URL>
-             '2' = <Prior API version still supported at a slightly different URL>
+             '2' = <Prior API version still supported at a slightly different URL - optional but included here>
         }
         geni_request_rspec_versions = [{
              type = "GENI"
              version = "3"
-             schema = "http://www.geni.net/resources/rspec/3/request.xsd"
-             namespace = "http://www.geni.net/resources/rspec/3"
-             extensions = ["http://hpn.east.isi.edu/rspec/ext/stitch/0.1/stitch-schema.xsd", <other URLs here>]
+             schema = "http://www.geni.net/resources/rspec/3/request.xsd" # required but may be empty
+             namespace = "http://www.geni.net/resources/rspec/3" # required but may be empty
+             extensions = ["http://hpn.east.isi.edu/rspec/ext/stitch/0.1/stitch-schema.xsd", <other URLs here>] # required but may be empty
         }]
         geni_ad_rspec_versions = [{
              type = "GENI"
              version = "3"
-             schema = "http://www.geni.net/resources/rspec/3/ad.xsd"
-             namespace = "http://www.geni.net/resources/rspec/3"
-             extensions = ["http://hpn.east.isi.edu/rspec/ext/stitch/0.1/stitch-schema.xsd", <other URLs here>]
+             schema = "http://www.geni.net/resources/rspec/3/ad.xsd" # required but may be empty
+             namespace = "http://www.geni.net/resources/rspec/3" # required but may be empty
+             extensions = ["http://hpn.east.isi.edu/rspec/ext/stitch/0.1/stitch-schema.xsd", <other URLs here>] # required but may be empty
         }]
-        geni_credential_types = [{ # Accept only SFA style credentials for API v3
+        geni_credential_types = [{ # This AM accepts only SFA style credentials for API v3
              geni_type = "geni_sfa"
              geni_version = "3"
        }]
-       geni_single_allocation = 0 # false - can operate on individual slivers
-       geni_allocate = "geni_many" # Can do multiple Allocates
+       geni_single_allocation = 0 # false - can operate on individual slivers. This is the default, so could legally be omitted here.
+       geni_allocate = "geni_many" # Can do multiple Allocates. This is not the default value, so is required here.
       }
   output = <None>
@@ -86 +86 @@
 {{{
 geni_api_versions: an XML-RPC struct containing 1+ entries of:
-  Name: Integer - supported GENI AM API version
+  Name: Integer (encoded as a String) - supported GENI AM API version
   Value: String - Absolute URL to the XML-RPC server implementing that version of the GENI AM API
 }}}
 
  `geni_request_rspec_versions`::
-    An array of data structures indicating the RSpec types accepted by this AM in a request. The [wiki:GAPI_AM_API_V3/CommonConcepts#RSpecdatatype contract for RSpec versions is described with links to further reading on the Common Concepts page].
+    An array of data structures indicating the RSpec types accepted by this AM in a request. The [wiki:GAPI_AM_API_V3/CommonConcepts#RSpecdatatype contract for RSpec versions is described with links to further reading on the Common Concepts page]. Per that contract, AMs will produce manifest RSpecs with a schema that is based on the given request type and version.
 
  `geni_ad_rspec_versions`::
@@ -104 +104 @@
 
  `schema`::
-   An URL pointing to a schema which can be used to verify the given type of RSpec. May be empty.
+   A URL pointing to a schema which can be used to verify the given type of RSpec. May be empty.
 
  `namespace`::