Changes between Version 29 and Version 30 of UniformClearinghouseAPIV2

Timestamp:

12/10/13 11:32:35 (10 years ago)

Author:

mbrinn@bbn.com

Comment:

Incorporation of Wim's comments through #14

UniformClearinghouseAPIV2

@@ -495 +495 @@
 || SERVICE_PEERS || List of Dictionaries || URLs and version info for other running version of same service (see below) || No || No ||
 
-The SERVICE_PEERS field is similar to that in the AM API: a list of {version", 'url'} dictionaries for other supported peer services of different versions. An example would be as follows:
+The SERVICE_PEERS field is similar to that in the AM API: a list of {version", 'url'} dictionaries for other supported peer services of different versions. 
+It is provided to allow a user/tool to determine which URL to contact without needing to poll the get_version call across a set of services.
+The current service URL (provided in the SERVICE_URL field) should always be included in the SERVICE_PEERS. An example would be as follows:
 {{{
 [ 
@@ -516 +518 @@
 #
 # Often this is a concatenatation of the trust roots of the included authorities.
+# Note: Some of this information can be retrieved by
+#   lookup(fields={"SERVICE_CERT"})
+# However certificates of federation-level certs, certificate authorities or other 
+# non-service certificate signers can only be retrieved through this call.
 #
 # Arguments:
@@ -836 +842 @@
 || '''Name''' || '''Type''' || '''Description''' || '''Match''' || '''Creation''' || '''Update''' ||
 || KEY_MEMBER || URN || URN of member associated with key pair || Yes || Required || No ||
-|| KEY_ID || STRING || Unique identifier of key: typically a fingerprint or hash of public key || Yes || No || No ||
+|| KEY_ID || STRING || Unique identifier for member/key pair: typically a fingerprint or hash of public key joined with member information || Yes || No || No ||
 || KEY_PUBLIC || KEY || Public key value || Yes || Required || No ||
 || KEY_PRIVATE || KEY || Private key value || Yes || Allowed || No ||
@@ -877 +883 @@
 || BOOLEAN || True or False (case insensitive) || '''Example:''' True ||
 || CREDENTIALS || List of dictionaries, one per credential, tagged with credential type and version (as indicated in the GENI AM API specification) || '''Details:''' Credentials = [ { geni_type: <string, case insensitive>, geni_version: <string containing an integer>, geni_value : <credential as string>, <others> } ] ||
-|| CERTIFICATE || X509 certificate (contents, not filename) || Standard X509 certificate format ||
+|| CERTIFICATE || X509 certificate (contents, not filename) || Standard X509 PEM certificate format. A chain of such certificates may be concatenated.  ||
 
 As noted above, this list is subject to change as the API develops over time.