Changes between Version 25 and Version 26 of UniformClearinghouseAPI


Ignore:
Timestamp:
08/16/13 06:26:46 (11 years ago)
Author:
mbrinn@bbn.com
Comment:

Cleanup up formatting

Legend:

Unmodified
Added
Removed
Modified

  • UniformClearinghouseAPI

    v25 v26  
    5757These API’s are provided in pseudo-code (i.e. language independent) format, with inputs and outputs (optional and required) described by comments, e.g.
    5858
     59
    5960/*
    6061
    6162''Perform method ‘ch_func’''
    6263
    63 '''Arguments'''
    64    argl ''' : ''' ...
    65 
    66 credentials : list of {type : credential} tuples representing credentials provided by caller to support AuthZ on method call.
    67 [NB: This argument will be omitted in descriptions below. ]
    68 options : … [ Recognized options: ….]
    69 
    70 ''' Return ''': E.g. a list of dictionaries with these fields mandatory (…) and these fields optional (…)
    71 
    72 */
    73 
    74 function ''' ch_func ''' (arg1, arg2, credentials, options)
     64'''Arguments:'''
     65[[BR]]   argl : ...
     66[[BR]]   credentials : list of {type : credential} tuples representing credentials provided by caller to support AuthZ on method call.
     67[[BR]]  [NB: This argument will be omitted in descriptions below. ]
     68[[BR]]  options : … [ Recognized options: ….]
     69
     70''' Return: ''' E.g. a list of dictionaries with these fields mandatory (…) and these fields optional (…)
     71*/
     72function '''ch_func ''' (arg1, arg2, credentials, options)
     73
    7574
    7675== API 'get_version' methods ==
    … …  
    969968|| KEY || SSH or SSL public or private key (contents, not filename) || Key-specific format ||
    970969|| BOOLEAN || True or False (case insensitive) || '''Example:''' True ||
    971 || CREDENTIALS || List of credentials, tagged with credential type (as indicated in the GENI AM API specification || Details: Credentials = { { geni_type: <string, case insensitive>, geni_version: <string containing an integer>, geni_value : <string>, <others> } } ||
    972 || CERTIFICATE || X509 certificate (contents, not filename) || ||
     970|| CREDENTIALS || List of credentials, tagged with credential type (as indicated in the GENI AM API specification || '''Details:''' Credentials = { { geni_type: <string, case insensitive>, geni_version: <string containing an integer>, geni_value : <string>, <others> } } ||
     971|| CERTIFICATE || X509 certificate (contents, not filename) || Standard X509 certificate format ||
    973972
    974973As noted above, this list is subject to change as the API develops over time.