Changes between Version 43 and Version 44 of UniformClearinghouseAPI

Timestamp:

08/29/13 06:35:16 (11 years ago)

Author:

mbrinn@bbn.com

Comment:

Add comments about URNs and object=>authority URNs

UniformClearinghouseAPI

@@ -53 +53 @@
  * Each Registry or Authority provides a get_version method, which describes the version number of the API provided, credential types supported, supplementary object fields and other data for interpreting API call returns.
  * A Registry or Authority is free to implement additional methods beyond those specified in this document.
- * The URN is the fundamental identifier in all Federation API’s. URN’s are globally unique at any given time, though not necessarily unique over time. Disambiguation for entities with the same URN over time may be provided by an optional UUID argument for certain API methods.
+ * The URN is the fundamental identifier in all Federation API’s. URN’s are globally unique at any given time, though not necessarily unique over time. Disambiguation for entities with the same URN over time may be provided by an optional UUID argument for certain API methods. The format of URN's is documented at http://groups.geni.net/geni/wiki/GeniApiIdentifiers.
 
 These API’s are provided in pseudo-code (i.e. language independent) format, with inputs and outputs (optional and required) described by comments, e.g.
@@ -423 +423 @@
 This requires extracting the authority from the URN and then looking up the authority in the Registry's set of services.
 
+Note that the transformation from the URN's of objects (e.g. slice, project, member) to the URN's of their authority is a simple one, for example:
+ * Slice: urn:publicid:IDN+sa_name+slice+slice_name => SA : urn:publicid:IDN+sa_name+authority+sa
+ * Member : urn:publicid:IDN+ma_name+user+user_name => MA: urn:publicid:IDN+ma_name+authority+ma 
+
 NB: This is an unprotected call, no client cert required.