Link Relation Types for Web Services
draft-wilde-service-link-rel-03

Document Type Active Internet-Draft (individual)
Last updated 2017-03-13
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                                           E. Wilde
Internet-Draft                                           CA Technologies
Intended status: Informational                            March 13, 2017
Expires: September 14, 2017

                  Link Relation Types for Web Services
                    draft-wilde-service-link-rel-03

Abstract

   Many resources provided on the Web are part of sets of resources that
   are provided in a context that is managed by one particular service
   provider.  Often, these sets of resources are referred to as "Web
   Services" or "Web APIs".  This specification defines link relations
   for representing relationships from those resources to ones that
   provide documentation or descriptions of the Web services.  The
   difference between these concepts is that documentation is primarily
   intended for human consumers, whereas descriptions are primarily
   intended for automated consumers.  It also defines a link relation to
   identify a status resource that is used to represent operational
   information about a service's status.

Note to Readers

   Please discuss this draft on the ART mailing list
   (<https://www.ietf.org/mailman/listinfo/art>).

   Online access to all versions and files is available on GitHub
   (<https://github.com/dret/I-D/tree/master/service-link-rel>).

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 September 14, 2017.

Wilde                  Expires September 14, 2017               [Page 1]
Internet-Draft    Link Relation Types for Web Services        March 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  . . . . . . . . . . . . . . . . . . . . . . . .   2
   2.  Terminology . . . . . . . . . . . . . . . . . . . . . . . . .   3
   3.  Web Services  . . . . . . . . . . . . . . . . . . . . . . . .   4
     3.1.  Documenting Web Services  . . . . . . . . . . . . . . . .   4
     3.2.  Describing Web Services . . . . . . . . . . . . . . . . .   5
     3.3.  Unified Documentation/Description . . . . . . . . . . . .   5
   4.  Link Relations for Web Services . . . . . . . . . . . . . . .   5
     4.1.  The service-doc Link Relation Type  . . . . . . . . . . .   5
     4.2.  The service-desc Link Relation Type . . . . . . . . . . .   6
   5.  Web Service Status Resources  . . . . . . . . . . . . . . . .   6
   6.  IANA Considerations . . . . . . . . . . . . . . . . . . . . .   6
     6.1.  Link Relation Type: service-doc . . . . . . . . . . . . .   6
     6.2.  Link Relation Type: service-desc  . . . . . . . . . . . .   7
     6.3.  Link Relation Type: status  . . . . . . . . . . . . . . .   7
   7.  Security Considerations . . . . . . . . . . . . . . . . . . .   7
   8.  References  . . . . . . . . . . . . . . . . . . . . . . . . .   7
     8.1.  Normative References  . . . . . . . . . . . . . . . . . .   7
     8.2.  Informative References  . . . . . . . . . . . . . . . . .   7
   Appendix A.  Acknowledgements . . . . . . . . . . . . . . . . . .   7
   Author's Address  . . . . . . . . . . . . . . . . . . . . . . . .   8

1.  Introduction

   One of the defining aspects of the Web is that it is possible to
   interact with Web resources without any prior knowledge of the
   specifics of the resource.  Following Web Architecture
   [W3C.REC-webarch-20041215] by using URIs, HTTP, and media types, the
   Web's uniform interface allows interactions with resources without
   the more complex binding procedures of other approaches.
Show full document text