Home Documents for HTTP APIs
draft-nottingham-json-home-06
|
| Document |
Type |
|
Active Internet-Draft (individual)
|
|
Last updated |
|
2017-02-14
|
|
Stream |
|
(None)
|
|
Intended RFC status |
|
(None)
|
|
Formats |
|
plain text
xml
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 M. Nottingham
Internet-Draft February 15, 2017
Intended status: Informational
Expires: August 19, 2017
Home Documents for HTTP APIs
draft-nottingham-json-home-06
Abstract
This document proposes a "home document" format for non-browser HTTP
clients.
Note to Readers
The issues list for this draft can be found at
https://github.com/mnot/I-D/labels/json-home .
The most recent (often, unpublished) draft is at
https://mnot.github.io/I-D/json-home/ .
Recent changes are listed at https://github.com/mnot/I-D/commits/gh-
pages/json-home .
For information about implementations, see https://github.com/mnot/I-
D/wiki/json-home .
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 19, 2017.
Nottingham Expires August 19, 2017 [Page 1]
Internet-Draft Home Documents for HTTP APIs February 2017
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.
Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 3
1.1. Notational Conventions . . . . . . . . . . . . . . . . . 4
2. API Home Documents . . . . . . . . . . . . . . . . . . . . . 4
3. API Objects . . . . . . . . . . . . . . . . . . . . . . . . . 7
4. Resource Objects . . . . . . . . . . . . . . . . . . . . . . 7
4.1. Resolving Templated Links . . . . . . . . . . . . . . . . 8
5. Resource Hints . . . . . . . . . . . . . . . . . . . . . . . 8
5.1. allow . . . . . . . . . . . . . . . . . . . . . . . . . . 9
5.2. formats . . . . . . . . . . . . . . . . . . . . . . . . . 9
5.3. acceptPatch . . . . . . . . . . . . . . . . . . . . . . . 9
5.4. acceptPost . . . . . . . . . . . . . . . . . . . . . . . 10
5.5. acceptPut . . . . . . . . . . . . . . . . . . . . . . . . 10
5.6. acceptRanges . . . . . . . . . . . . . . . . . . . . . . 10
5.7. acceptPrefer . . . . . . . . . . . . . . . . . . . . . . 11
5.8. docs . . . . . . . . . . . . . . . . . . . . . . . . . . 11
5.9. preconditionRequired . . . . . . . . . . . . . . . . . . 11
5.10. authSchemes . . . . . . . . . . . . . . . . . . . . . . . 11
5.11. status . . . . . . . . . . . . . . . . . . . . . . . . . 12
6. Security Considerations . . . . . . . . . . . . . . . . . . . 12
7. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 12
7.1. HTTP Resource Hint Registry . . . . . . . . . . . . . . . 12
7.2. Media Type Registration . . . . . . . . . . . . . . . . . 13
8. References . . . . . . . . . . . . . . . . . . . . . . . . . 13
8.1. Normative References . . . . . . . . . . . . . . . . . . 13
8.2. Informative References . . . . . . . . . . . . . . . . . 14
Appendix A. Acknowledgements . . . . . . . . . . . . . . . . . . 15
Appendix B. Creating and Serving Home Documents . . . . . . . . 15
B.1. Managing Change in Home Documents . . . . . . . . . . . . 15
B.2. Evolving and Mixing APIs with Home Documents . . . . . . 16
Appendix C. Consuming Home Documents . . . . . . . . . . . . . . 16
Appendix D. Frequently Asked Questions . . . . . . . . . . . . . 17
Nottingham Expires August 19, 2017 [Page 2]
Internet-Draft Home Documents for HTTP APIs February 2017
Show full document text