Changes between Version 13 and Version 14 of GAPI_AM_API_V3_DETAILS

Timestamp:

05/16/12 13:03:40 (12 years ago)

Author:

Aaron Helsinger

Comment:

--

GAPI_AM_API_V3_DETAILS

@@ -129 +129 @@
 
 === Return ===
-!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.
+!ListResources returns a `value` containing an RSpec listing and describing resources at this aggregate. Depending on the arguments, this may be all local resources, only available local resources.
 
 !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.
@@ -161 +161 @@
 For details on options to `Describe`, see !ListResources above, and the Common Concepts page.
 
-Sample Return:
+Sample Return `value`:
 {{{
 {
@@ -204 +204 @@
 If `geni_end_time` is supplied, the experimenter is requesting a particular sliver reservation expiration date. Local policy may however dictate the expiration date. The AM therefore may ignore this argument; the `Allocate` call should still succeed, even if the date argument cannot be satisfied.
 
-At some aggregates, experimenters may call `Allocate` multiple times, to add resources to the existing reservation for the same slice. Other aggregates may limit such requests or forbid them entirely. See the Common Concepts page for details on Operations on Individual Slivers.
+At some aggregates, experimenter tools may call `Allocate` multiple times, to add resources to the existing reservation for the same slice. Other aggregates may limit such requests or forbid them entirely. See the Common Concepts page for details on Operations on Individual Slivers.
 
 Error codes:
@@ -221 +221 @@
 `Renew` requests a changed expiration for one or more slivers in a slice. At some aggregates, this expiration may be shorter. This method applies both to slivers that are `geni_allocated` and to those that are already `geni_provisioned`. Depending on local aggregate configuration, the aggregate may only support `Renew` on all current slivers in the slice, or may permit renewing only some slivers. Local policy will dictate maximum expiration times. These times are typically quite short (~ 10 minutes initially, ~120 minutes maximum) for reservations (`geni_allocated`), and longer for provisioned slivers (~ 5-8 days initially). Since these expiration times are different, typically `Renew` is used only for slivers in the same allocation state.
 
-Sample Return:
+Sample Return `value`:
 {{{
     [
@@ -256 +256 @@
 As with the `Allocate` method, some aggregates may not support provisioning only some reserved resources. Also as with the `Allocate` method, experimenters may request a sliver expiration time; aggregates may succeed the operation while ignoring the requested expiration time or granting a different expiration time.
 
-Some resources types allow experimenter access. The `geni_users` option allows specifying login key material to be installed on the resources (e.g. SSH public keys).
+Some resource types allow experimenter access. The `geni_users` option allows specifying login key material to be installed on the resources (e.g. SSH public keys).
 
  `geni_error`::
@@ -276 +276 @@
 Get dynamic status about one or more slivers in a given slice. In contrast to `Describe`, `Status` is used to query dynamic state information about slivers. Aggregates may include detailed configuration information at their own discretion.
 
-Sample Return:
+Sample Return `value`:
 {{{
 {