Changes between Version 18 and Version 19 of GAPI_AM_API_DRAFT


Ignore:
Timestamp:
11/04/11 08:57:14 (8 years ago)
Author:
Aaron Helsinger
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • GAPI_AM_API_DRAFT

    v18 v19  
    3131 * Method returns are modified to return at least 3 name/value pairs, with arbitrary additional such pairs.
    3232  * {{{code}}} is an integer, with non-0 indicating error.
    33   * {{{value}}} is the return value as specified in AM API v1 (RSpec, etc), and
     33  * {{{value}}} is the return value as specified in AM API v1 or as modified by Change Set A (RSpec, etc), and
    3434  * {{{output}}} is a human readable indication of the nature of the return or error.
    3535  * Aggregates are free to use other additional name/value pairs in the return struct.
     
    252252Allowing aggregates to return more information, on both errors and success, will allow for a richer client-server communication. It would also allow aggregates to give clients hints on how to use successful returns, or otherwise innovate within the bounds of the AM API.
    253253
    254 This change will modify all methods to return an XMLRPC struct (aka property list) on any application layer success, failure, and even on an error or for most exceptions. Note that a malformed XMLRPC request should still raise an XMLRPC Fault, and other Faults dictated by the XMLRPC specification should still be raised. This struct will contain the return value from the previous revision of the AM API as an entry. This struct will have 3 defined entries, and aggregates are free to include other entries to give more information to clients.
     254This change will modify all methods to return an XMLRPC struct (aka property list) on any application layer success, failure, and even on an error or for most exceptions. Note that a malformed XMLRPC request should still raise an XMLRPC Fault, and other Faults dictated by the XMLRPC specification should still be raised. This struct will contain the return value from the previous revision of the AM API as an entry (or the return value as modified by Change Set A if adopted). This struct will have 3 defined entries, and aggregates are free to include other entries to give more information to clients.
    255255
    256256The three required entries in the return structure are {{{code}}}, {{{value}}}, and {{{output}}}: