XML Hypertext Application Language
draft-michaud-xml-hal-01

Document Type Active Internet-Draft (individual)
Last updated 2017-02-08
Stream (None)
Intended RFC status (None)
Formats plain text pdf html bibtex
Stream Stream state (No stream defined)
Consensus Boilerplate Unknown
RFC Editor Note (None)
IESG IESG state I-D Exists
Telechat date
Responsible AD (None)
Send notices to (None)
Network Working Group                                         J. Michaud
Internet-Draft                                          February 8, 2017
Intended status: Informational                                          
Expires: August 12, 2017                                                

                   XML Hypertext Application Language
                        draft-michaud-xml-hal-01

Abstract

   This document proposes a media type for representing resources and
   their relations with hyperlinks.

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."

Copyright Notice

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

 

Michaud                 Expires August 12, 2017                 [Page 1]
Internet-Draft     XML Hypertext Application Language   February 8, 2017

Table of Contents

   1.  Introduction . . . . . . . . . . . . . . . . . . . . . . . . .  2
   2.  Requirements . . . . . . . . . . . . . . . . . . . . . . . . .  3
   3.  HAL Documents  . . . . . . . . . . . . . . . . . . . . . . . .  3
   4.  Resource . . . . . . . . . . . . . . . . . . . . . . . . . . .  4
     4.1.  Reserved Elements  . . . . . . . . . . . . . . . . . . . .  4
       4.1.1.  link . . . . . . . . . . . . . . . . . . . . . . . . .  4
       4.1.2.  resource . . . . . . . . . . . . . . . . . . . . . . .  4
   5.  Link . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  4
     5.1.  rel  . . . . . . . . . . . . . . . . . . . . . . . . . . .  4
     5.1.  href . . . . . . . . . . . . . . . . . . . . . . . . . . .  5
     5.2.  templated  . . . . . . . . . . . . . . . . . . . . . . . .  5
     5.3.  type . . . . . . . . . . . . . . . . . . . . . . . . . . .  5
     5.4.  deprecation  . . . . . . . . . . . . . . . . . . . . . . .  5
     5.5.  name . . . . . . . . . . . . . . . . . . . . . . . . . . .  5
     5.6.  profile  . . . . . . . . . . . . . . . . . . . . . . . . .  6
     5.7.  title  . . . . . . . . . . . . . . . . . . . . . . . . . .  6
     5.8.  hreflang . . . . . . . . . . . . . . . . . . . . . . . . .  6
   6.  Example  . . . . . . . . . . . . . . . . . . . . . . . . . . .  7
   7.  Media Type Parameters  . . . . . . . . . . . . . . . . . . . .  8
     7.1.  profile  . . . . . . . . . . . . . . . . . . . . . . . . .  8
   8.  Recommendations  . . . . . . . . . . . . . . . . . . . . . . .  8
     8.1.  Self Link  . . . . . . . . . . . . . . . . . . . . . . . .  8
     8.2.  Link relations . . . . . . . . . . . . . . . . . . . . . .  8
     8.3.  Hypertext Cache Pattern  . . . . . . . . . . . . . . . . .  8
     8.4.  Namespace and prefix . . . . . . . . . . . . . . . . . . .  9
   9.  Security Considerations  . . . . . . . . . . . . . . . . . . .  9
   10.  IANA Considerations . . . . . . . . . . . . . . . . . . . . .  9
   11.  Normative References  . . . . . . . . . . . . . . . . . . . .  9
   Appendix A.  Acknowledgements  . . . . . . . . . . . . . . . . . . 10
   Appendix B.  Frequently Asked Questions  . . . . . . . . . . . . . 11
     B.1.  How should a client know the
           meaning/structure/semantics/type of a  . . . . . . . . . . 11
     B.2.  Where can I find libraries for working with HAL? . . . . . 11
     B.3.  Why does HAL have no forms?  . . . . . . . . . . . . . . . 11
   Author's Address . . . . . . . . . . . . . . . . . . . . . . . . . 11

1.  Introduction

   There is an emergence of non-HTML HTTP applications ("Web APIs")
   which use hyperlinks to direct clients around their resources.

   The XML Hypertext Application Language (HAL) is a standard which
   establishes conventions for expressing hypermedia controls, such as
Show full document text