Changes between Version 63 and Version 64 of UniformClearinghouseAPI


Ignore:
Timestamp:
09/25/13 10:11:49 (6 years ago)
Author:
mbrinn@bbn.com
Comment:

Clarify version semantics, fix typo defalit => default, change example supplemental fields.

Legend:

Unmodified
Added
Removed
Modified
  • UniformClearinghouseAPI

    v63 v64  
    7777
    7878Each Registry or Authority API provides a ‘get_version’ method, which provides information to the caller (or a tool composing calls for a tool user) about versions and options supported by that API. The call takes no argument and is unguarded (anyone can call it). The return from the get_version call will be a dictionary including the following entries (by key):
    79  * VERSION: The version number of the API (e.g. “10.0.7”)
     79 * VERSION: The version number of the Federation API (e.g. “10.0.7”). Note: this is the version of the API not the version of the implementation.
    8080 * SERVICES: The set of services the given URL supports
    8181 * CREDENTIAL_TYPES: A list of recognized credential types (e.g. [ABAC, SFA]) and list of supported credential versions on protected API methods.
    8282 * ROLES : A list of recognized roles for slice/project membership (optional for those Slice Authorities supporting membership)
    83  * OBJECTS : List of additional supported objects (e.g. PROJECT in SA, KEY in MA). Not needed if only defaiit objects handled (e.g. SLICE in SA, MEMBER in MA, SERVICE in Registry).
     83 * OBJECTS : List of additional supported objects (e.g. PROJECT in SA, KEY in MA). Not needed if only default objects handled (e.g. SLICE in SA, MEMBER in MA, SERVICE in Registry).
    8484 * FIELDS: A dictionary of '''''supplementary''''' object field names (i.e. in additional to the required fields) and associated attributes including:
    8585     * “OBJECT” provides the object to which the field belongs (if not the default authority object, i.e. SLICE for Slice Authority, MEMBER for Member Authority, Service for Registry)
     
    113113
    114114“FIELDS”: {
    115       “PROJECT_URN”: {“TYPE”: “URN”, “CREATE”: “REQUIRED”, “UPDATE”: FALSE},
    116115     
    117       “SLICE_EMAIL”: {“TYPE”: “EMAIL”, “CREATE”: “REQUIRED”, “UPDATE”: TRUE}
     116     "_GENI_PROJECT_UID": {"TYPE" : "UID", "UPDATE" : FALSE},
     117
     118     “_GENI_SLICE_EMAIL”: {“TYPE”: “EMAIL”, “CREATE”: “REQUIRED”, “UPDATE”: TRUE}
    118119     
    119       “PROJECT_EMAIL”: {“TYPE”: “EMAIL”, “CREATE”: “REQUIRED”, “UPDATE”: TRUE, “OBJECT”: “PROJECT”}
     120      “_GENI_PROJECT_EMAIL”: {“TYPE”: “EMAIL”, “CREATE”: “REQUIRED”, “UPDATE”: TRUE, “OBJECT”: “PROJECT”}
    120121       
    121122      }