Changes between Version 12 and Version 13 of AaronHelsinger/GAPI_AM_API_DRAFT


Ignore:
Timestamp:
03/22/12 16:01:43 (7 years ago)
Author:
Aaron Helsinger
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • AaronHelsinger/GAPI_AM_API_DRAFT

    v12 v13  
    134134{{{
    135135{
    136   string ticket=<ticket>
    137   string geni_status=<sliver state - ticketed>,
     136  ticket: <string, the ticket>
     137  geni_status: <string, the sliver state - ticketed>,
    138138 <others that are AM specific>
    139139}
     
    471471value = [
    472472  {
    473    geni_sliver_urn,
    474    geni_allocation_status,
    475    geni_expires <time when the sliver expires from its current state>,
     473   geni_sliver_urn: <string>,
     474   geni_allocation_status: <string>,
     475   geni_expires: <time when the sliver expires from its current state>,
    476476   <others AM or method specific>
    477477   <ProvisionSlivers returns geni_operational_status>
     
    487487These methods all take a new option (aggregates must support it, clients do not need to supply it):
    488488{{{
    489    geni_best_effort = True/False, default False
     489   geni_best_effort: <True/False, default False>
    490490}}}
    491491If false, the client is requesting that the aggregate either fully satisfy the request, moving all listed slivers to the desired state, or fully fail the request, leaving all slivers in their original state.
     
    571571geni_credential_types = <a list of structs>: [
    572572  {
    573    geni_type = <string, case insensitive>,
    574    geni_version = <string containing an integer>,
     573   geni_type: <string, case insensitive>,
     574   geni_version: <string containing an integer>,
    575575   <others fields optionally. EG A URL for more info, or a schema>
    576576  }
     
    611611credentials = [
    612612   {
    613     geni_type = <string>,
    614     geni_version = <string>,
    615     geni_value = <string>,
     613    geni_type: <string>,
     614    geni_version: <string>,
     615    geni_value: <string>,
    616616    <others>
    617617   }
     
    697697{{{
    698698{
    699  string rspec=<manifest>,
    700  string geni_start_time=<optional (may be omitted altogether): now if not specified>,
    701  string geni_expires=<RFC3339 sliver expiration, as in geni_expires from SliversStatus>,
    702  string geni_status=<sliver state - allocated or changing or ready>,
     699 rspec: <string manifest>,
     700 geni_expires: =<RFC3339 sliver expiration string, as in geni_expires from SliversStatus>,
     701 geni_allocation_status: <string sliver state - allocated or changing or ready>,
    703702 <others that are AM specific>
    704703}
     
    912911credentials = [
    913912   {
    914     geni_type = <string>,
    915     geni_version = <string>,
    916     geni_value = <string>,
     913    geni_type: <string>,
     914    geni_version: <string>,
     915    geni_value: <string>,
    917916    <others>
    918917   }
     
    923922{{{
    924923{
    925    string geni_rspec (ad or Manifest - may be empty though)
    926    string geni_urn, (slice or sliver as requested)
    927    geni_expires=<RFC3339 allocation expiration, as in geni_expires from SliversStatus>,
    928    string geni_allocation_status=<sliver state - allocated or ?? >,
     924   geni_rspec: <string, ad or Manifest - may be empty though)>
     925   geni_urn: <string urn, slice or sliver as requested>
     926   geni_expires: <RFC3339 allocation expiration string, as in geni_expires from SliversStatus>,
     927   geni_allocation_status: <string sliver state - allocated or ?? >,
    929928}
    930929}}}
     
    945944credentials = [
    946945   {
    947     geni_type = <string>,
    948     geni_version = <string>,
    949     geni_value = <string>,
     946    geni_type: <string>,
     947    geni_version: <string>,
     948    geni_value: <string>,
    950949    <others>
    951950   }
     
    956955{{{
    957956{
    958   string geni_end_time <datetime> (optional)
     957  [optional geni_end_time: <string datetime>]
    959958}
    960959}}}
     
    963962{{{
    964963{
    965  string rspec=<manifest>,
    966  geni_expires=<RFC3339 allocation expiration, as in geni_expires from SliversStatus>,
    967  string geni_allocation_status=<sliver state - allocated or ?? >,
     964 rspec: <string manifest>,
     965 geni_expires: <RFC3339 allocation expiration string, as in geni_expires from SliversStatus>,
     966 geni_allocation_status: <string sliver state - allocated or ?? >,
    968967 <others that are AM specific>
    969968}
     
    984983credentials = [
    985984   {
    986     geni_type = <string>,
    987     geni_version = <string>,
    988     geni_value = <string>,
     985    geni_type: <string>,
     986    geni_version: <string>,
     987    geni_value: <string>,
    989988    <others>
    990989   }
     
    992991}}}
    993992
    994 Options include {{{geni_best_effort = True/False, default false}}}
     993Options include {{{geni_best_effort: <True/False, default false>}}}
    995994
    996995Return list of structs:
     
    998997[
    999998  {
    1000    geni_sliver_urn,
    1001    geni_allocation_status,
    1002    geni_expires <time when the sliver expires from its current state>,
     999   geni_sliver_urn: <string>,
     1000   geni_allocation_status: <string>,
     1001   geni_expires: <time when the sliver expires from its current state>,
    10031002   <others AM or method specific>
    10041003  },
     
    10171016credentials = [
    10181017   {
    1019     geni_type = <string>,
    1020     geni_version = <string>,
    1021     geni_value = <string>,
     1018    geni_type: <string>,
     1019    geni_version: <string>,
     1020    geni_value: <string>,
    10221021    <others>
    10231022   }
     
    10251024}}}
    10261025
    1027 Options include {{{geni_end_time}}} and {{{geni_best_effort = True/False, default false}}}
     1026Options include {{{geni_end_time}}} and {{{geni_best_effort: <True/False, default false>}}}
    10281027
    10291028Return a list of structs:
     
    10311030[
    10321031  {
    1033    geni_sliver_urn,
    1034    geni_allocation_status,
    1035    geni_expires <time when the sliver expires from its current state>,
     1032   geni_sliver_urn: <string>,
     1033   geni_allocation_status: <string>,
     1034   geni_expires: <time when the sliver expires from its current state>,
    10361035   <others AM or method specific>
    10371036  },
     
    10501049credentials = [
    10511050   {
    1052     geni_type = <string>,
    1053     geni_version = <string>,
    1054     geni_value = <string>,
     1051    geni_type: <string>,
     1052    geni_version: <string>,
     1053    geni_value: <string>,
    10551054    <others>
    10561055   }
     
    10641063[
    10651064  {
    1066    geni_sliver_urn,
    1067    geni_allocation_status,
    1068    geni_operational_status,
    1069    [optional: 'geni_resource_status' : string]
     1065   geni_sliver_urn: <string>,
     1066   geni_allocation_status: <string>,
     1067   geni_operational_status: <string>,
    10701068   geni_expires <time when the sliver expires from its current state>,
     1069   [optional: geni_resource_status: <string>]
    10711070   <others AM or method specific>
    10721071  },
     
    10881087credentials = [
    10891088   {
    1090     geni_type = <string>,
    1091     geni_version = <string>,
    1092     geni_value = <string>,
     1089    geni_type: <string>,
     1090    geni_version: <string>,
     1091    geni_value: <string>,
    10931092    <others>
    10941093   }
     
    10961095}}}
    10971096
    1098 Options include {{{geni_end_time}}} and {{{geni_best_effort = True/False, default false}}}
     1097Options include {{{geni_end_time}}} and {{{geni_best_effort: <True/False, default false>}}}
    10991098
    11001099Return struct:
    11011100{{{
    11021101{
    1103   string ticket=<ticket>
    1104   string geni_status=<sliver state - ticketed>,
     1102  rspec: <string rspec>
     1103  geni_allocation_status: <sliver state - allocated>,
     1104  geni_expires: <datetime>.
    11051105 <others that are AM specific>
    11061106}
     
    11201120credentials = [
    11211121   {
    1122     geni_type = <string>,
    1123     geni_version = <string>,
    1124     geni_value = <string>,
     1122    geni_type: <string>,
     1123    geni_version: <string>,
     1124    geni_value: <string>,
    11251125    <others>
    11261126   }
     
    11281128}}}
    11291129
    1130 Options include {{{geni_best_effort = True/False, default false}}}
     1130Options include {{{geni_best_effort: <True/False, default false>}}}
    11311131
    11321132Return list of structs:
     
    11341134[
    11351135  {
    1136    geni_sliver_urn,
    1137    geni_allocation_status,
    1138    geni_expires <time when the sliver expires from its current state>,
     1136   geni_sliver_urn: <string>,
     1137   geni_allocation_status: <string>,
     1138   geni_expires: <time when the sliver expires from its current state>,
    11391139   <others AM or method specific>
    11401140  },
     
    11521152credentials = [
    11531153   {
    1154     geni_type = <string>,
    1155     geni_version = <string>,
    1156     geni_value = <string>,
     1154    geni_type: <string>,
     1155    geni_version: <string>,
     1156    geni_value: <string>,
    11571157    <others>
    11581158   }
     
    11631163{{{
    11641164{
    1165   string geni_urn: <slice URN>
    1166   string geni_allocation_status: provisioned (optional field)
    1167   string geni_operational_status: ready (optional field)
     1165  geni_urn: <slice URN>
     1166  [optional: geni_allocation_status: <string, eg provisioned>]
     1167  [optional: geni_operational_status: <string, eg ready >]
    11681168  geni_expires: <datetime of expiration>
    11691169  struct geni_resources: [ { geni_urn: <sliver URN>
    1170                       geni_allocation_status: provisioned
    1171                       geni_operational_status: ready
    1172                       [optional: 'geni_resource_status' : string]
     1170                      geni_allocation_status: <string, eg provisioned>
     1171                      geni_operational_status: <string, eg ready>
    11731172                      geni_expires: <datetime of individual sliver expiration>
    1174                       geni_error: ''},
     1173                      geni_error: <string, eg ''>,
     1174                      [optional: 'geni_resource_status' : <string>]
     1175                    },
    11751176                    { geni_urn: <sliver URN>
    1176                       geni_allocation_status: provisioned
    1177                       geni_operational_status: ready
    1178                       [optional: 'geni_resource_status' : string]
     1177                      geni_allocation_status: <string, eg provisioned>
     1178                      geni_operational_status: <string, eg ready>
    11791179                      geni_expires: <datetime of individual sliver expiration>
    1180                       geni_error: ''}
     1180                      geni_error: <string, eg ''>,
     1181                      [optional: 'geni_resource_status' : <string>]
     1182                      }
    11811183                  ]
    11821184}
     
    11921194credentials = [
    11931195   {
    1194     geni_type = <string>,
    1195     geni_version = <string>,
    1196     geni_value = <string>,
     1196    geni_type: <string>,
     1197    geni_version: <string>,
     1198    geni_value: <string>,
    11971199    <others>
    11981200   }
     
    12001202}}}
    12011203
    1202 Options include: {{{geni_best_effort = True/False, default false}}}
     1204Options include: {{{geni_best_effort: <True/False, default false>}}}
    12031205
    12041206Return list of structs:
    12051207{{{
    12061208[ {
    1207         'geni_urn' : string,
    1208         'geni_operational_status' : string,
    1209         [optional: 'geni_resource_status' : string]
     1209        geni_urn : <string>,
     1210        geni_operational_status : <string>,
     1211        [optional: geni_resource_status' : <string>]
    12101212        },
    12111213        ...
     
    12231225credentials = [
    12241226   {
    1225     geni_type = <string>,
    1226     geni_version = <string>,
    1227     geni_value = <string>,
     1227    geni_type: <string>,
     1228    geni_version: <string>,
     1229    geni_value: <string>,
    12281230    <others>
    12291231   }
     
    12311233}}}
    12321234
    1233 Options include: {{{geni_best_effort = True/False, default false}}}
     1235Options include: {{{geni_best_effort: <True/False, default false>}}}
    12341236
    12351237Return list of structs:
     
    12371239[
    12381240  {
    1239    geni_sliver_urn,
    1240    geni_allocation_status,
    1241    geni_expires <time when the sliver expires from its current state>,
     1241   geni_sliver_urn: <string>,
     1242   geni_allocation_status: <string>,
     1243   geni_expires: <time when the sliver expires from its current state>,
    12421244   <others AM or method specific>
    12431245  },
     
    12551257credentials = [
    12561258   {
    1257     geni_type = <string>,
    1258     geni_version = <string>,
    1259     geni_value = <string>,
     1259    geni_type: <string>,
     1260    geni_version: <string>,
     1261    geni_value: <string>,
    12601262    <others>
    12611263   }
     
    12671269[
    12681270  {
    1269    geni_sliver_urn,
    1270    geni_allocation_status,
    1271    geni_expires <time when the sliver expires from its current state>,
     1271   geni_sliver_urn: <string>,
     1272   geni_allocation_status: <string>,
     1273   geni_expires: <time when the sliver expires from its current state>,
    12721274   <others AM or method specific>
    12731275  },