Changes between Version 13 and Version 14 of GAPI_AM_API_DRAFT

Timestamp:

10/24/11 09:09:19 (13 years ago)

Author:

Aaron Helsinger

Comment:

--

GAPI_AM_API_DRAFT

@@ -256 +256 @@
 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. 
 
-The three required entries in the return structure are {{{code}}}, {{{value}}}, and {{{option}}}:
+The three required entries in the return structure are {{{code}}}, {{{value}}}, and {{{output}}}:
  * {{{code}}}: An error code: integer, non-zero on error. 
   * 0 = Success
@@ -274 +274 @@
   * For !SliverStatus, the {{{value}}} is an XMLRPC struct
   * For Shutdown, the {{{value}}} is a boolean
- * {{{option}}}: On failure or error, this is required. Optional on success. This is a String with a human readable message explaining the result. Specifically, this might include an error string, a stacktrace, or other useful messages to help the Experimenter resolve or report the failure or error. It is not defined on success, though aggregates are free to use it.
+ * {{{output}}}: On failure or error, this is required. Optional on success. This is a String with a human readable message explaining the result. Specifically, this might include an error string, a stacktrace, or other useful messages to help the Experimenter resolve or report the failure or error. It is not defined on success, though aggregates are free to use it.
 
 Aggregates are encouraged to use {{{code}}} values and {{{output}}} messages that help experimenters and tools distinguish between bad input, other experimenter error, temporary server errors, or server bugs. 
@@ -301 +301 @@
 }
 
-  option: <none>
+  output: <none>
 }
 }}}
@@ -310 +310 @@
   code: 1
   value: False
-  option: 'No such slice here'
-}
-}}}
-(That code and option are merely examples.)
+  output: 'No such slice here'
+}
+}}}
+(That code and output are merely examples.)
 
 An exception:
@@ -337 +337 @@
         <lots of other options follow>
       }
-  option = <None>
+  output = <None>
 }
 
@@ -345 +345 @@
    code=0
    value= <GENI V3 Ad or Manifest RSpec string>
-   option = <None>
+   output = <None>
 }
 
@@ -357 +357 @@
    code=0
    value= <GENI V3 Manifest RSpec string>
-   option = <None>
+   output = <None>
 }
 
@@ -365 +365 @@
    code=0
    value= boolean
-   option = <None>
+   output = <None>
 }
 
@@ -373 +373 @@
    code=0
    value= struct (as defined in V1)
-   option = <None>
+   output = <None>
 }
 
@@ -383 +383 @@
    code=0
    value= boolean
-   option = <None>
+   output = <None>
 }
 
@@ -391 +391 @@
    code=0
    value= boolean
-   option = <None>
+   output = <None>
 }
 }}}
@@ -426 +426 @@
    code=0
    value= <GENI V3 Manifest RSpec string>
-   option = <None>
+   output = <None>
 }
 }}}