Changes between Version 69 and Version 70 of UniformClearinghouseAPI

Timestamp:

09/25/13 10:59:34 (11 years ago)

Author:

mbrinn@bbn.com

Comment:

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

UniformClearinghouseAPI

@@ -56 +56 @@
 
 {{{
-/*
-Perform method fed_func
-
-Arguments:
-  argl : ...
-  credentials : list of {type : credential} tuples representing credentials provided by caller to support AuthZ on method call.
-      [NB: This argument will be omitted in descriptions below. ]
-  options : … [ Recognized options: ….]
-
-Return: 
-  E.g. a list of dictionaries with these fields mandatory (…) and these fields optional (…)
-*/
-function fed_func (arg1, arg2, credentials, options)
-
+#!python
+# Perform method fed_func
+#
+# Arguments:
+#  argl : ...
+#  credentials : list of {type : credential} tuples representing credentials provided by caller to support AuthZ on method call.
+#      [NB: This argument will be omitted in descriptions below. ]
+#  options : … [ Recognized options: ….]
+#
+# Return: 
+#  E.g. a list of dictionaries with these fields mandatory (…) and these fields optional (…)
+def fed_func (arg1, arg2, credentials, options)
 }}}
 
@@ -353 +351 @@
 
 {{{
-/*
-Provide a structure detailing the version information as well as details of accepted options for Registry API calls.
-
-Arguments:
-   None
-
-Return:
-   get_version structure information as described above
-
-*/
-
-function get_version()
+#!python
+# Provide a structure detailing the version information as well as details of accepted options for Registry API calls.
+#
+# Arguments:
+#   None
+#
+# Return:
+#   get_version structure information as described above
+def get_version()
 }}}
 
 {{{
-/*
-
-Return information about all aggregates associated with the Federation
-
-Arguments:
-   options: 'match' and 'filter' options   as described in standard lookup methods
-
-Return:
-   List of dictionaries of name/value pairs for each returned AM
-
-*/
-function lookup_aggregates(options)
+#!python
+# Return information about all aggregates associated with the Federation
+#
+# Arguments:
+#  options: 'match' and 'filter' options   as described in standard lookup methods
+#
+# Return:
+ #  List of dictionaries of name/value pairs for each returned AM
+def lookup_aggregates(options)
 }}}
 
 {{{
-/*
-
-Return information about all MA’s associated with the Federation
-
-Arguments:
-  options: 'match' and 'filter' options   as described in standard lookup methods
-
-Return:
-  List of dictionaries of name/value pairs for each returned MA
-
-*/
-function lookup_member_authorities(options)
+#!python
+#
+# Return information about all MA’s associated with the Federation#
+#
+# Arguments:
+#  options: 'match' and 'filter' options   as described in standard lookup methods
+#
+#Return:
+#  List of dictionaries of name/value pairs for each returned MA
+def lookup_member_authorities(options)
 }}}
 
 {{{
-/*
-
-Return information about all SA’s associated with the Federation
-
-Arguments:
-   options: 'match' and 'filter' options   as described in standard lookup methods
-
-Return:
-   List of dictionaries of name/value pairs for each returned SA
-
-*/
-function lookup_slice_authorities(options)
+#!python
+# Return information about all SA’s associated with the Federation
+#
+# Arguments:
+#   options: 'match' and 'filter' options   as described in standard lookup methods
+#
+# Return:
+#   List of dictionaries of name/value pairs for each returned SA
+def lookup_slice_authorities(options)
 }}}
 
@@ -420 +407 @@
 
 {{{
-/*
-
-Lookup the authorities for a given URNs
-
-There should be at most one (potentially none) per URN. 
-
-This requires extracting the authority from the URN and then looking up the authority in the Registry's set of services.
-
-
-Arguments:
-   urns: URNs of entities for which the authority is requested
-
-Return:
-   List of dictionaries {urn : url} mapping URLs of Authorities to given URN's
-
-*/
-function lookup_authorities_for_urns(urns)
+#!python
+# Lookup the authorities for a given URNs
+#
+# There should be at most one (potentially none) per URN. 
+# 
+# This requires extracting the authority from the URN and then looking up the authority in the Registry's set of services.
+#
+# Arguments:
+#   urns: URNs of entities for which the authority is requested
+#
+# Return:
+#   List of dictionaries {urn : url} mapping URLs of Authorities to given URN's
+def lookup_authorities_for_urns(urns)
 }}}
 
 {{{
-/*
-
-Return list of trust roots (certificates) associated with this Federation.
-
-Often this is a concatenatation of the trust roots of the included authorities.
-
-Arguments:
-   None
-
-Return:
-   List of certificates representing trust roots of this Federation.
-
-*/
-function get_trust_roots()
+#!python
+# Return list of trust roots (certificates) associated with this Federation.
+#
+# Often this is a concatenatation of the trust roots of the included authorities.
+#
+# Arguments:
+#   None
+#
+# Return:
+#   List of certificates representing trust roots of this Federation.
+def get_trust_roots()
 }}}