Internet DRAFT - draft-lanthaler-profile-registry
draft-lanthaler-profile-registry
Network Working Group M. Lanthaler
Internet-Draft January 21, 2014
Intended status: Informational
Expires: July 25, 2014
The Profile URI Registry
draft-lanthaler-profile-registry-05
Abstract
This document defines a registry for profile URIs to be used in
specifications standardizing profiles.
Status of this Memo
This Internet-Draft is submitted in full conformance with the
provisions of BCP 78 and BCP 79.
Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF). Note that other groups may also distribute
working documents as Internet-Drafts. The list of current Internet-
Drafts is at http://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months
and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress."
This Internet-Draft will expire on July 25, 2014.
Copyright Notice
Copyright (c) 2014 IETF Trust and the persons identified as the
document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents
(http://trustee.ietf.org/license-info) in effect on the date of
publication of this document. Please review these documents
carefully, as they describe your rights and restrictions with respect
to this document. Code Components extracted from this document must
include Simplified BSD License text as described in Section 4.e of
the Trust Legal Provisions and are provided without warranty as
described in the Simplified BSD License.
Lanthaler Expires July 25, 2014 [Page 1]
Internet-Draft The Profile URI Registry January 2014
Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 3
2. Registration Process . . . . . . . . . . . . . . . . . . . . . 3
3. Example Registration Request . . . . . . . . . . . . . . . . . 3
4. IANA Considerations . . . . . . . . . . . . . . . . . . . . . . 4
4.1. Initial Registry Contents . . . . . . . . . . . . . . . . . 4
5. Security Considerations . . . . . . . . . . . . . . . . . . . . 5
6. Change Log . . . . . . . . . . . . . . . . . . . . . . . . . . 5
6.1. From -04 to -05 . . . . . . . . . . . . . . . . . . . . . . 5
6.2. From -03 to -04 . . . . . . . . . . . . . . . . . . . . . . 5
6.3. From -02 to -03 . . . . . . . . . . . . . . . . . . . . . . 6
6.4. From -01 to -02 . . . . . . . . . . . . . . . . . . . . . . 6
6.5. From -00 to -01 . . . . . . . . . . . . . . . . . . . . . . 6
7. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . . 6
8. Normative References . . . . . . . . . . . . . . . . . . . . . 6
Author's Address . . . . . . . . . . . . . . . . . . . . . . . . . 7
Lanthaler Expires July 25, 2014 [Page 2]
Internet-Draft The Profile URI Registry January 2014
1. Introduction
Profiles, as defined by [RFC6906], can be used to signal support for
additional semantics, such as constraints, conventions, extensions,
or any other aspects that do not alter the basic media type
semantics. Profiles are identified by a URI and can thus be created
without central coordination.
Similarly to media types and link relation types it is, in some
cases, beneficial to centrally manage profile URIs to ensure
interoperability and decrease the coupling between clients and
servers. This allows the independent evolution of clients and
servers as both are coupled to these central contracts instead of
being coupled to each other. Therefore, this document establishes an
IANA registry for profile URIs.
2. Registration Process
All elements in this registry require a URI in order to be
registered. The meaning of the profile URI should be documented in a
permanent and readily available public specification in sufficient
detail so that interoperability between independent implementations
is possible (see the registration template in Section 4).
An exemplary registration request can be found in Section 3.
3. Example Registration Request
The following is an example registration request for the profile URI
http://example.com/profiles/example.
This is a request to IANA to please register the profile URI
"http://example.com/profiles/example" in the Profile URI Registry
according [this document].
o Profile URI: http://example.com/profiles/example
o Common Name: Exemplary Profile URI
o Description: An exemplary profile URI registration.
o Specification Document: [this document]
Lanthaler Expires July 25, 2014 [Page 3]
Internet-Draft The Profile URI Registry January 2014
4. IANA Considerations
This document establishes the Profile URI registry. The registration
procedure for new entries requires a request in the form of the
following template and is "First Come First Served" per [RFC5226].
Instructions for a registrant to request the registration of a
profile URI are in Section 2.
The underlying registry data (e.g., the XML file) must include
Simplified BSD License text as described in Section 4.e of the Trust
Legal Provisions (<http://trustee.ietf.org/license-info>).
The registration template is:
o Profile URI: The URI that identifies the registered profile.
o Common Name: The name by which the profile being registered is
generally known.
o Description: A relatively short description of the profile. For
simple profiles, this might be all the documentation that is
required and there might be no reference document. In those
cases, be sure this description adequately documents the profile
and is suitable for interoperable implementation.
o Specification Document: Reference to the document that specifies
the URI, preferably including a URI that can be used to retrieve a
copy of the document. An indication of the relevant sections may
also be included. This is recommended, but can be left blank if
the "Description" field provides sufficient documentation.
o Notes: [optional]
4.1. Initial Registry Contents
The Profile URI registry's initial contents are:
o Profile URI: urn:example:profile-uri
o Common Name: Exemplary Profile
o Description: A profile to be used in examples.
o Specification Document: [this document]
o Profile URI: http://dublincore.org/documents/2008/08/04/dc-html/
o Common Name: Dublin Core HTML meta data profile
o Description: A set of conventions by which a Dublin Core metadata
description set can be can be represented within an (X)HTML Web
page using (X)HTML elements and attributes.
Lanthaler Expires July 25, 2014 [Page 4]
Internet-Draft The Profile URI Registry January 2014
o Specification Document: [DC-HTML]
o Profile URI: http://www.w3.org/ns/json-ld#expanded
o Common Name: Expanded JSON-LD
o Description: A profile URI to request or signal expanded JSON-LD
document form.
o Specification Document: [JSON-LD]
o Profile URI: http://www.w3.org/ns/json-ld#compacted
o Common Name: Compacted JSON-LD
o Description: A profile URI to request or signal compacted JSON-LD
document form.
o Specification Document: [JSON-LD]
o Profile URI: http://www.w3.org/ns/json-ld#flattened
o Common Name: Flattened JSON-LD
o Description: A profile URI to request or signal flattened JSON-LD
document form.
o Specification Document: [JSON-LD]
5. Security Considerations
There are no additional security considerations beyond those already
inherent to using URIs. Security considerations for URIs in general
can be found in [RFC3986].
6. Change Log
Note to RFC Editor: Please remove this section before publication.
6.1. From -04 to -05
o Change registration process from "Specification Required" to
"First Come First Served".
o Update JSON-LD reference.
o Update acknowledgements.
6.2. From -03 to -04
o Change title from "The IETF Profile URI Registry" to just "The
Profile URI Registry".
Lanthaler Expires July 25, 2014 [Page 5]
Internet-Draft The Profile URI Registry January 2014
o Update JSON-LD reference.
6.3. From -02 to -03
o Seed registry with the profile URIs defined in [DC-HTML] and
[JSON-LD].
6.4. From -01 to -02
o Do not establish a new IETF URN Sub-namespace anymore.
6.5. From -00 to -01
o Use HTTP URI instead of URN in example registration request to
make it clearer that not only URNs can be registered.
o Move security considerations to the end.
7. Acknowledgements
Thanks to Dave Cridland, Barry Leiba, and Nevil Brownlee for valuable
comments and suggestions.
8. Normative References
[DC-HTML] Johnston, P. and A. Powell, "Expressing Dublin Core
metadata using HTML/XHTML meta and link elements", Dublin
Core Metadata Initiative Recommendation, August 2008,
<http://dublincore.org/documents/2008/08/04/dc-html/>.
[JSON-LD] Sporny, M., Kellogg, G., and M. Lanthaler, "JSON-LD 1.0",
World Wide Web Consortium Recommendation, January 2014,
<http://www.w3.org/TR/json-ld/>.
[RFC3986] Berners-Lee, T., Fielding, R., and L. Masinter, "Uniform
Resource Identifier (URI): Generic Syntax", STD 66,
RFC 3986, January 2005.
[RFC5226] Narten, T. and H. Alvestrand, "Guidelines for Writing an
IANA Considerations Section in RFCs", BCP 26, RFC 5226,
May 2008.
[RFC6906] Wilde, E., "The 'profile' Link Relation Type", RFC 6906,
March 2013.
Lanthaler Expires July 25, 2014 [Page 6]
Internet-Draft The Profile URI Registry January 2014
Author's Address
Markus Lanthaler
Email: mail@markus-lanthaler.com
URI: http://www.markus-lanthaler.com/
Lanthaler Expires July 25, 2014 [Page 7]
