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

The information below is for an old version of the document
Document Type Active Internet-Draft (individual)
Last updated 2016-02-22
Stream (None)
Intended RFC status (None)
Formats plain text pdf html bibtex
Reviews
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                                         February 22, 2016
Intended status: Informational
Expires: August 25, 2016

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

Abstract

   Many resources provided on the Web are part of a sets of resources
   that are provided in a context that is defined and managed by one
   particular service provider.  Often, these sets of resources are
   referred to as "Web Services" or "Web APIs".  This specification
   defines two link relations that allow to represent 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.

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 25, 2016.

Wilde                    Expires August 25, 2016                [Page 1]
Internet-Draft      Web Services Link Relation Types       February 2016

Copyright Notice

   Copyright (c) 2016 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  . . . . . . . . . . . . . . . . . . . . . . . .   3
     3.1.  Documenting Web Services  . . . . . . . . . . . . . . . .   4
     3.2.  Describing Web Services . . . . . . . . . . . . . . . . .   4
   4.  Link Relations for Web Services . . . . . . . . . . . . . . .   5
     4.1.  The service-doc Link Relation Type  . . . . . . . . . . .   5
     4.2.  The service-desc Link Relation Type . . . . . . . . . . .   5
   5.  IANA Considerations . . . . . . . . . . . . . . . . . . . . .   5
     5.1.  Link Relation Type: service-doc . . . . . . . . . . . . .   5
     5.2.  Link Relation Type: service-desc  . . . . . . . . . . . .   5
   6.  Security Considerations . . . . . . . . . . . . . . . . . . .   6
   7.  Change Log  . . . . . . . . . . . . . . . . . . . . . . . . .   6
     7.1.  From -00 to -01 . . . . . . . . . . . . . . . . . . . . .   6
   8.  References  . . . . . . . . . . . . . . . . . . . . . . . . .   6
     8.1.  Normative References  . . . . . . . . . . . . . . . . . .   6
     8.2.  Informative References  . . . . . . . . . . . . . . . . .   6
   Appendix A.  Acknowledgements . . . . . . . . . . . . . . . . . .   6
   Author's Address  . . . . . . . . . . . . . . . . . . . . . . . .   6

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 [3], 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.

   However, many resources on the Web are provided as part of a set of
   resources that are referred to as a "Web Service" or a "Web API".  In

Wilde                    Expires August 25, 2016                [Page 2]
Internet-Draft      Web Services Link Relation Types       February 2016

   many cases, these services or APIs are defined and managed as a
   whole, and it may be desirable for clients to be able to discover
   this service definition information.

   Service definition can be broadly separated into two categories: One
Show full document text