datatracker.ietf.org
Sign in
Version 5.6.2.p1, 2014-07-22
Report a bug

Home Documents for HTTP Services: XML Syntax
draft-wilde-home-xml-03

Document type: Active Internet-Draft (individual)
Document stream: No stream defined
Last updated: 2014-02-12
Intended RFC status: Unknown
Other versions: plain text, xml, pdf, html

Stream State:No stream defined
Document shepherd: No shepherd assigned

IESG State: I-D Exists
Responsible AD: (None)
Send notices to: No addresses provided

Network Working Group                                           E. Wilde
Internet-Draft                                               UC Berkeley
Intended status: Informational                         February 12, 2014
Expires: August 16, 2014

              Home Documents for HTTP Services: XML Syntax
                        draft-wilde-home-xml-03

Abstract

   The current draft for HTTP Home Documents provides a JSON syntax
   only.  This draft provides an XML syntax for the same underlying data
   model, so that the concept of HTTP Home Documents can be consistently
   exposed in both JSON- and XML-based HTTP services.

Note to Readers

   Please discuss this draft on the apps-discuss mailing list [1].

   Online access to all versions and files is available on github [2].

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 August 16, 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

Wilde                    Expires August 16, 2014                [Page 1]
Internet-Draft             Home Documents XML              February 2014

   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.

Table of Contents

   1.  Introduction . . . . . . . . . . . . . . . . . . . . . . . . .  3
   2.  XML Example  . . . . . . . . . . . . . . . . . . . . . . . . .  3
   3.  XML Schema . . . . . . . . . . . . . . . . . . . . . . . . . .  4
   4.  IANA Considerations  . . . . . . . . . . . . . . . . . . . . .  6
     4.1.  Media Type application/home+xml  . . . . . . . . . . . . .  6
   5.  Implementation Status  . . . . . . . . . . . . . . . . . . . .  7
   6.  Security Considerations  . . . . . . . . . . . . . . . . . . .  8
   7.  Open Issues  . . . . . . . . . . . . . . . . . . . . . . . . .  8
   8.  Change Log . . . . . . . . . . . . . . . . . . . . . . . . . .  8
     8.1.  From -02 to -03  . . . . . . . . . . . . . . . . . . . . .  9
     8.2.  From -01 to -02  . . . . . . . . . . . . . . . . . . . . .  9
     8.3.  From -00 to -01  . . . . . . . . . . . . . . . . . . . . .  9
   9.  References . . . . . . . . . . . . . . . . . . . . . . . . . .  9
     9.1.  Normative References . . . . . . . . . . . . . . . . . . .  9
     9.2.  Informative References . . . . . . . . . . . . . . . . . . 10
   Appendix A.  XML-to-HTML for Home Documents  . . . . . . . . . . . 10
   Author's Address . . . . . . . . . . . . . . . . . . . . . . . . . 12

Wilde                    Expires August 16, 2014                [Page 2]
Internet-Draft             Home Documents XML              February 2014

1.  Introduction

   An Internet Draft currently under development
   [I-D.nottingham-json-home] proposes the concept of "Home Documents
   for HTTP APIs" and described them as follows:

   "This document proposes a 'home document' format for non-browser HTTP
   clients. [...]  The goal of home documents is to serve as a starting
   point for hypermedia APIs, where clients need to have an entry point,
   and then can use the API by following links.  Home documents thus
   serve the same purpose as home pages on web sites: They are stable
   entry points that provide starting points for clients with some
   knowledge of the services linked from them."

   While this general concept of a home document is independent of the
   representation format, the current draft only defines a JSON syntax.
   In order to make this concept available across representations, this
   draft defines an XML syntax for the concepts defined in
   [I-D.nottingham-json-home].

[include full document text]