Changes between Version 5 and Version 6 of GAPI_AM_API_V3_DETAILS


Ignore:
Timestamp:
05/07/12 11:27:08 (7 years ago)
Author:
Aaron Helsinger
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • GAPI_AM_API_V3_DETAILS

    v5 v6  
    2222
    2323Sample output:
    24 
    25 '''FIXME FIXME'''
    2624
    2725{{{
     
    7068    An integer indicating the revision of the Aggregate Manager API that an aggregate supports. This page documents version 2 of the API. This value is duplicated here and within the {{{value}}} return struct for backwards compatibility with AM API v1 clients.
    7169
    72 {{{code}}}, {{{value}}}, and {{{output}}} together provide the [#ReturnStruct standard return from all AM API methods], which has a specific [#ReturnStruct structure and semantics described below], including specifics of the {{{code}}} and {{{output}}} members.
     70{{{code}}}, {{{value}}}, and {{{output}}} together provide the [wiki:GAPI_AM_API_V3/CommonConcepts#ReturnStruct standard return from all AM API methods], which has a specific [wiki:GAPI_AM_API_V3/CommonConcepts#ReturnStruct structure and semantics described on the Common Concepts page], including specifics of the {{{code}}} and {{{output}}} members.
    7371
    7472  `value`::
     
    7674
    7775==== !GetVersion return codes ====
    78 Aggregates shall return consistent values for {{{geni_code}}} as described here. Success is always indicated using a {{{geni_code}}} value of {{{0}}}. On error, return the appropriate GENI error code in {{{geni_code}}}, as listed in this table. These error codes are part of a [#ReturnStruct larger set of codes with specific meanings required by this API, described below].
     76Aggregates shall return consistent values for {{{geni_code}}} as described here. Success is always indicated using a {{{geni_code}}} value of {{{0}}}. On error, return the appropriate GENI error code in {{{geni_code}}}, as listed in this table. These error codes are part of a [wiki:GAPI_AM_API_V3/CommonConcepts#ReturnStruct larger set of codes with specific meanings required by this API, described on the Common Concepts page].
    7977
    8078|| '''''Error''''' || '''''Condition''''' ||
     
    8684
    8785 `geni_api_versions`::
    88     An XML-RPC struct indicating the versions of the Aggregate Manager API supported at this aggregate, and the URLs at which those API versions can be contacted. This element is required, and shall include at least 1 entry indicating the local aggregate manager URL and the version of the API supported at that URL. Aggregates supporting multiple versions of the Aggregate Manager API should [#SupportingMultipleAPIVersions conform to the guidelines specified below].
     86    An XML-RPC struct indicating the versions of the Aggregate Manager API supported at this aggregate, and the URLs at which those API versions can be contacted. This element is required, and shall include at least 1 entry indicating the local aggregate manager URL and the version of the API supported at that URL. Aggregates supporting multiple versions of the Aggregate Manager API should [wiki:GAPI_AM_API_V3/CommonConcepts#SupportingMultipleAPIVersions conform to the guidelines specified on the Common Concepts page].
    8987{{{
    9088geni_api_versions: an XML-RPC struct containing 1+ entries of:
     
    9492
    9593 `geni_request_rspec_versions`::
    96     An array of data structures indicating the RSpec types accepted by this AM in a request. The [#RSpecs contract for RSpec versions is described with links to further reading below].
     94    An array of data structures indicating the RSpec types accepted by this AM in a request. The [wiki:GAPI_AM_API_V3/CommonConcepts#RSpecdatatypes contract for RSpec versions is described with links to further reading on the Common Concepts page].
    9795
    9896 `geni_ad_rspec_versions`::
    9997    An array of data structures indicating what types of RSpec advertisements may be produced by this AM in !ListResources.
    10098
    101 {{{geni_request_rspec_versions}}} and {{{geni_ad_rspec_versions}}} refer to the RSpec formats supported at this aggregate. The [#RSpecs contract for RSpec versions is described with links to further reading below].
     99{{{geni_request_rspec_versions}}} and {{{geni_ad_rspec_versions}}} refer to the RSpec formats supported at this aggregate. The [wiki:GAPI_AM_API_V3/CommonConcepts#RSpecdatatypes contract for RSpec versions is described with links to further reading on the Common Concepts page].
    102100 
    103101
     
    121119
    122120 `geni_compressed`::
    123     Optional. An [http://www.xmlrpc.com/spec XML-RPC] boolean value indicating whether the caller would like the result to be compressed. If the value is {{{true}}}, the returned resource list will be compressed according to [http://www.ietf.org/rfc/rfc1950.txt RFC 1950]. If the value is {{{false}}} or unspecified, the return will be text.
     121    Optional. An [http://www.xmlrpc.com/spec XML-RPC] boolean value indicating whether the caller would like the result to be compressed. If the value is true (1), the returned resource list will be compressed according to [http://www.ietf.org/rfc/rfc1950.txt RFC 1950]. If the value is false (0) or unspecified, the return will be text.
    124122
    125123 `geni_rspec_version`::
    126     Required. An [http://www.xmlrpc.com/spec XML-RPC] struct indicating the type and version of Advertisement or Manifest RSpec to return. The struct contains 2 members, {{{type}}} and {{{version}}}. {{{type}}} and {{{version}}} are ''case-insensitive'' strings, matching those in {{{geni_ad_rspec_versions}}} as returned by !GetVersion at this aggregate. This option is ''required'', and aggregates are expected to return a {{{geni_code}}} of {{{1}}} ('Bad Arguments') if it is missing. Aggregates should return a {{{geni_code}}} of {{{4}}} ({{{BADVERSION}}}) if the requested RSpec version is not one advertised in !GetVersion as supported. The [#RSpecs contract for RSpec versions is described with links to further reading below].
     124    Required. An [http://www.xmlrpc.com/spec XML-RPC] struct indicating the type and version of Advertisement or Manifest RSpec to return. The struct contains 2 members, {{{type}}} and {{{version}}}. {{{type}}} and {{{version}}} are ''case-insensitive'' strings, matching those in {{{geni_ad_rspec_versions}}} as returned by !GetVersion at this aggregate. This option is ''required'', and aggregates are expected to return a {{{geni_code}}} of {{{1}}} ('Bad Arguments') if it is missing. Aggregates should return a {{{geni_code}}} of {{{4}}} ({{{BADVERSION}}}) if the requested RSpec version is not one advertised in !GetVersion as supported. The [wiki:GAPI_AM_API_V3/CommonConcepts#RSpecdatatypes contract for RSpec versions is described with links to further reading on the Common Concepts page].
    127125
    128126
     
    130128!ListResources returns an RSpec listing and describing resources at this aggregate. Depending on the arguments, this may be all local resources, only available local resources, or a manifest of resources reserved for a particular slice.
    131129
    132 !ListResources returns the [#ReturnStruct standard return from all AM API methods], which has a specific [#ReturnStruct structure and semantics described below], including specific requirements for the {{{code}}} and {{{output}}} members.
     130!ListResources returns the [wiki:GAPI_AM_API_V3/CommonConcepts#ReturnStruct standard return from all AM API methods], which has a specific [wiki:GAPI_AM_API_V3/CommonConcepts#ReturnStruct structure and semantics described on the Common Concepts page], including specific requirements for the {{{code}}} and {{{output}}} members.
    133131
    134132
     
    140138
    141139==== !ListResources return codes ====
    142 On error, return the appropriate GENI error code in {{{geni_code}}}, as listed in this table. These error codes are part of a [#ReturnStruct larger set of codes with specific meanings required by this API, described below].
     140On error, return the appropriate GENI error code in {{{geni_code}}}, as listed in this table. These error codes are part of a [wiki:GAPI_AM_API_V3/CommonConcepts#ReturnStruct larger set of codes with specific meanings required by this API, described on the Common Concepts page].
    143141
    144142|| '''''Error''''' || '''''Condition''''' ||