Skip to main content

The Form Link Relation
draft-ioseb-dzmanashvili-link-relation-00

The information below is for an old version of the document.
Document Type
This is an older version of an Internet-Draft that was ultimately published as RFC 6861.
Author Ioseb Dzmanashvili
Last updated 2012-04-10
RFC stream (None)
Formats
IETF conflict review conflict-review-ioseb-dzmanashvili-link-relation, conflict-review-ioseb-dzmanashvili-link-relation, conflict-review-ioseb-dzmanashvili-link-relation, conflict-review-ioseb-dzmanashvili-link-relation, conflict-review-ioseb-dzmanashvili-link-relation, conflict-review-ioseb-dzmanashvili-link-relation
Additional resources
Stream Stream state (No stream defined)
Consensus boilerplate Unknown
RFC Editor Note (None)
IESG IESG state Became RFC 6861 (Informational)
Telechat date (None)
Responsible AD (None)
Send notices to (None)
draft-ioseb-dzmanashvili-link-relation-00
Network Working Group                                    I. Dzmanashvili
Internet-Draft                                            April 10, 2012
Expires: October 12, 2012

                         The Form Link Relation
               draft-ioseb-dzmanashvili-link-relation-00

Abstract

   RFC 5988 [RFC5988] defined the way of indicating resources on the
   Web. This specification defines a pair of reciprocal link relation
   types that may be used to express the relationship between a
   collection and its members.

Editorial Note (To be removed by RFC Editor)

   Distribution of this document is unlimited.  Comments should be sent
   to the IETF Apps-Discuss mailing list (see
   <https://www.ietf.org/mailman/listinfo/apps-discuss>).

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 October 12, 2012.

Copyright Notice

   Copyright (c) 2012 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

Dzmanashvili            Expires October 12, 2012                [Page 1]
Internet-Draft           The Form Link Relation               April 2012

   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.

1.  Introduction

   RFC 5988 [RFC5988] defined the way of indicating resources on the
   Web. This specification defines a pair of reciprocal link relation
   types that may be used to express the relationship between a
   collection and its members.

   The link relation is intentionally generic, and it can be used with
   multiple media types in a wide variety of use cases.

2.  Link Relations

   The following link relation is defined.

2.1.  form

   When included in a resource which represents a collection, the 'form'
   link relation identifies a target resource that represents the form
   for adding a new member to the context collection.

   <html>
     <ul>
       <li>Entry Description 1</li>
       <li>Entry Description 2</li>
     </ul>
     <a href="..." rel="form">[Add New Entry]</a>
   </html>

   or

   { "collection": {
     "href": "...",

     "items": [{OBJECT}, {OBJECT}];

     "links": [
       {"href": "...", "rel": "form"}
     ]
   }}

   or

   <link rel="form" href="..." />

Dzmanashvili            Expires October 12, 2012                [Page 2]
Internet-Draft           The Form Link Relation               April 2012

   When included in a resource which represents a member of a
   collection, the 'form' link relation identifies a target resource
   that represents a pre-populated form for editing the context
   resource.

   <html>
     ...
     <ul>
       <li>
         Entry Description 1
         <a href="..." rel="form">[Edit Entry]</a>
       </li>
       <li>
         Entry Description 2
         <a href="..." rel="form">[Edit Entry]</a>
       </li>
     </ul>
     ...
   </html>

   or

   { "collection": {
     "href": "...",

     "items": [
       {
         "href": "...",
         "data": [ARRAY],
         "links": [
           {"href": "...", "rel": "form"}
         ]
       }
     ];
   }}

3.  IANA Considerations

   IANA is asked to register the 'form' Link Relation below as per
   [RFC5988].

   Relation Name:

      form

   Description:

Dzmanashvili            Expires October 12, 2012                [Page 3]
Internet-Draft           The Form Link Relation               April 2012

      The target IRI points to a resource that is a representation of a
      valid write form(create or edit) for the data represented by the
      context IRI.

   Reference:

      See Section 2.

   Notes:

      None.

   Application Data:

      None.

4.  Security Considerations

   See Section 7 of RFC5988 [RFC5988].

5.  Internationalisation Considerations

   See Section 8 of RFC5988 [RFC5988].

6.  Normative References

   [RFC5988]  Nottingham, M., "Web Linking", RFC 5988, October 2010.

Author's Address

   Ioseb Dzmanashvili

   EMail: ioseb.dzmanashvili@gmail.com

Dzmanashvili            Expires October 12, 2012                [Page 4]