Changes between Version 69 and Version 70 of UniformClearinghouseAPI


Ignore:
Timestamp:
09/25/13 10:59:34 (8 years ago)
Author:
mbrinn@bbn.com
Comment:

Add python-style formatting for pseudo-code for API's

Legend:

Unmodified
Added
Removed
Modified
  • UniformClearinghouseAPI

    v69 v70  
    5656
    5757{{{
    58 /*
    59 Perform method fed_func
    60 
    61 Arguments:
    62   argl : ...
    63   credentials : list of {type : credential} tuples representing credentials provided by caller to support AuthZ on method call.
    64       [NB: This argument will be omitted in descriptions below. ]
    65   options : … [ Recognized options: ….]
    66 
    67 Return:
    68   E.g. a list of dictionaries with these fields mandatory (…) and these fields optional (…)
    69 */
    70 function fed_func (arg1, arg2, credentials, options)
    71 
     58#!python
     59# Perform method fed_func
     60#
     61# Arguments:
     62#  argl : ...
     63#  credentials : list of {type : credential} tuples representing credentials provided by caller to support AuthZ on method call.
     64#      [NB: This argument will be omitted in descriptions below. ]
     65#  options : … [ Recognized options: ….]
     66#
     67# Return:
     68#  E.g. a list of dictionaries with these fields mandatory (…) and these fields optional (…)
     69def fed_func (arg1, arg2, credentials, options)
    7270}}}
    7371
     
    353351
    354352{{{
    355 /*
    356 Provide a structure detailing the version information as well as details of accepted options for Registry API calls.
    357 
    358 Arguments:
    359    None
    360 
    361 Return:
    362    get_version structure information as described above
    363 
    364 */
    365 
    366 function get_version()
     353#!python
     354# Provide a structure detailing the version information as well as details of accepted options for Registry API calls.
     355#
     356# Arguments:
     357#   None
     358#
     359# Return:
     360#   get_version structure information as described above
     361def get_version()
    367362}}}
    368363
    369364{{{
    370 /*
    371 
    372 Return information about all aggregates associated with the Federation
    373 
    374 Arguments:
    375    options: 'match' and 'filter' options   as described in standard lookup methods
    376 
    377 Return:
    378    List of dictionaries of name/value pairs for each returned AM
    379 
    380 */
    381 function lookup_aggregates(options)
     365#!python
     366# Return information about all aggregates associated with the Federation
     367#
     368# Arguments:
     369#  options: 'match' and 'filter' options   as described in standard lookup methods
     370#
     371# Return:
     372 #  List of dictionaries of name/value pairs for each returned AM
     373def lookup_aggregates(options)
    382374}}}
    383375
    384376{{{
    385 /*
    386 
    387 Return information about all MA’s associated with the Federation
    388 
    389 Arguments:
    390   options: 'match' and 'filter' options   as described in standard lookup methods
    391 
    392 Return:
    393   List of dictionaries of name/value pairs for each returned MA
    394 
    395 */
    396 function lookup_member_authorities(options)
     377#!python
     378#
     379# Return information about all MA’s associated with the Federation#
     380#
     381# Arguments:
     382#  options: 'match' and 'filter' options   as described in standard lookup methods
     383#
     384#Return:
     385#  List of dictionaries of name/value pairs for each returned MA
     386def lookup_member_authorities(options)
    397387}}}
    398388
    399389{{{
    400 /*
    401 
    402 Return information about all SA’s associated with the Federation
    403 
    404 Arguments:
    405    options: 'match' and 'filter' options   as described in standard lookup methods
    406 
    407 Return:
    408    List of dictionaries of name/value pairs for each returned SA
    409 
    410 */
    411 function lookup_slice_authorities(options)
     390#!python
     391# Return information about all SA’s associated with the Federation
     392#
     393# Arguments:
     394#   options: 'match' and 'filter' options   as described in standard lookup methods
     395#
     396# Return:
     397#   List of dictionaries of name/value pairs for each returned SA
     398def lookup_slice_authorities(options)
    412399}}}
    413400
     
    420407
    421408{{{
    422 /*
    423 
    424 Lookup the authorities for a given URNs
    425 
    426 There should be at most one (potentially none) per URN.
    427 
    428 This requires extracting the authority from the URN and then looking up the authority in the Registry's set of services.
    429 
    430 
    431 Arguments:
    432    urns: URNs of entities for which the authority is requested
    433 
    434 Return:
    435    List of dictionaries {urn : url} mapping URLs of Authorities to given URN's
    436 
    437 */
    438 function lookup_authorities_for_urns(urns)
     409#!python
     410# Lookup the authorities for a given URNs
     411#
     412# There should be at most one (potentially none) per URN.
     413#
     414# This requires extracting the authority from the URN and then looking up the authority in the Registry's set of services.
     415#
     416# Arguments:
     417#   urns: URNs of entities for which the authority is requested
     418#
     419# Return:
     420#   List of dictionaries {urn : url} mapping URLs of Authorities to given URN's
     421def lookup_authorities_for_urns(urns)
    439422}}}
    440423
    441424{{{
    442 /*
    443 
    444 Return list of trust roots (certificates) associated with this Federation.
    445 
    446 Often this is a concatenatation of the trust roots of the included authorities.
    447 
    448 Arguments:
    449    None
    450 
    451 Return:
    452    List of certificates representing trust roots of this Federation.
    453 
    454 */
    455 function get_trust_roots()
     425#!python
     426# Return list of trust roots (certificates) associated with this Federation.
     427#
     428# Often this is a concatenatation of the trust roots of the included authorities.
     429#
     430# Arguments:
     431#   None
     432#
     433# Return:
     434#   List of certificates representing trust roots of this Federation.
     435def get_trust_roots()
    456436}}}
    457437