Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Info
titleProposed for LC consideration; not yet approved

...

Approved Guideline

Approved by the LC on 31 Aug 2011.

Temporary URL Labeling in Technical Specifications

Table of Contents
minLevel3
maxLevel3
typeflat
separatorpipe

Requirements

Kantara Work Groups that produce Technical Specifications often need to give unique labels to various components in those specifications, such as XML namespace names, or identifiers for fields in XRD descriptive data. Although these labels are intended to be temporary until the specs are eventually completed at a standards development organization (SDO), software implementers often need to code features that use these draft labels in the interim.

...

Following is an example from the UMA 1.0 Core Protocol as of 31 Aug 2011, illustrating the need for labels in its XRD formats (using entirely made-up URLsit had invented these URL strings in the absence of a Kantara policy):

Code Block
<!-- Applies to both hosts and requesters -->

<Property
  type="http://kantarainitiative.org/ns/uma/1.0/token_formats">artifact
</Property>
<Property
  type="http://kantarainitiative.org/ns/uma/1.0/claim_formats">claims2
</Property>

<!-- Host protection API -->

<!-- AM as authorization server to host-as-client -->
<Link
  rel="http://kantarainitiative.org/ns/uma/1.0/host_token_uri"
  href="https://am.example.com/host/token_uri">
</Link>
<Link
  rel="http://kantarainitiative.org/ns/uma/1.0/host_user_uri"
  href="https://am.example.com/host/user_uri">
</Link>
...

LC Guideline

...

Kantara should will make available the following area on its site that Work Groups can use for temporary URL-based labels that appear in their Technical Specifications and, optionally, web resources that correspond to these labels: http://docs.kantarainitiative.org/.

Each Work Group shouldwill, by request to Kantara staff, be given the opportunity to control URLs and content in an area named with the same affix given to their Confluence wiki area (or a modified affix by mutual arrangement). For example, the UMA Work Group could request http://docs.kantarainitiative.org/umawg/ or http://docs.kantarainitiative.org/uma/.

Within such an area, the Work Group would have has the opportunity to manage the namespace as it sees fit, for example, including version or date numbers or spec module names as URL path components.

Technical Specifications that make use of such URLs must make clear that they are to be considered temporary until such time as the specification is finalized in an SDO.

Work Groups could can choose to use some other system of labeling, such as URNs, or URLs in a non-Kantara-related domain (with permission of the domain owner), but if they want to use the kantarainitiative.org domain, it must be as prescribed in this policy.

References

For somewhat similar policies, see:

...