< draft-wilde-service-link-rel-09.txt   draft-wilde-service-link-rel-10.txt >
Network Working Group E. Wilde Network Working Group E. Wilde
Internet-Draft December 28, 2018 Internet-Draft January 11, 2019
Intended status: Informational Intended status: Informational
Expires: July 1, 2019 Expires: July 15, 2019
Link Relation Types for Web Services Link Relation Types for Web Services
draft-wilde-service-link-rel-09 draft-wilde-service-link-rel-10
Abstract Abstract
Many resources provided on the Web are part of sets of resources that 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 are provided in a context that is managed by one particular service
provider. Often, these sets of resources are referred to as "Web provider. Often, these sets of resources are referred to as "Web
Services" or "Web APIs". This specification defines link relations Services" or "Web APIs". This specification defines link relations
for representing relationships from those resources to ones that for representing relationships from those resources to ones that
provide documentation, descriptions, or metadata for these Web provide documentation, descriptions, or metadata for these Web
services. Documentation is primarily intended for human consumers, services. Documentation is primarily intended for human consumers,
skipping to change at page 1, line 40 skipping to change at page 1, line 40
Internet-Drafts are working documents of the Internet Engineering Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF). Note that other groups may also distribute Task Force (IETF). Note that other groups may also distribute
working documents as Internet-Drafts. The list of current Internet- working documents as Internet-Drafts. The list of current Internet-
Drafts is at https://datatracker.ietf.org/drafts/current/. Drafts is at https://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months Internet-Drafts are draft documents valid for a maximum of six months
and may be updated, replaced, or obsoleted by other documents at any and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet-Drafts as reference time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress." material or to cite them other than as "work in progress."
This Internet-Draft will expire on July 1, 2019. This Internet-Draft will expire on July 15, 2019.
Copyright Notice Copyright Notice
Copyright (c) 2018 IETF Trust and the persons identified as the Copyright (c) 2019 IETF Trust and the persons identified as the
document authors. All rights reserved. document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents Provisions Relating to IETF Documents
(https://trustee.ietf.org/license-info) in effect on the date of (https://trustee.ietf.org/license-info) in effect on the date of
publication of this document. Please review these documents publication of this document. Please review these documents
carefully, as they describe your rights and restrictions with respect carefully, as they describe your rights and restrictions with respect
to this document. Code Components extracted from this document must to this document. Code Components extracted from this document must
include Simplified BSD License text as described in Section 4.e of include Simplified BSD License text as described in Section 4.e of
the Trust Legal Provisions and are provided without warranty as the Trust Legal Provisions and are provided without warranty as
skipping to change at page 3, line 35 skipping to change at page 3, line 35
resources could be interlinked, but since they are intended for resources could be interlinked, but since they are intended for
different audiences, it can make sense to provide entry points for different audiences, it can make sense to provide entry points for
both of them. both of them.
In addition, while both documentation and descriptions may be In addition, while both documentation and descriptions may be
provided as part of a Web service, there may be other information as provided as part of a Web service, there may be other information as
well. Generally speaking, a Web service may have any metadata/ well. Generally speaking, a Web service may have any metadata/
resources associated with it (with documentation/description just resources associated with it (with documentation/description just
being two specific kinds of resource). If there is a way how all of being two specific kinds of resource). If there is a way how all of
these metadata/resources are represented, then it should be possible these metadata/resources are represented, then it should be possible
to discover such a resource of general Web service metadata. to discover such a resource providing access to general Web service
metadata.
In addition to these resources about mostly static aspects of a Web In addition to these resources about mostly static aspects of a Web
service, this memo also defines a link relation that allows providers service, this memo also defines a link relation that allows providers
of a Web service to link to a resource that represents status of a Web service to link to a resource that represents status
information about the service. This information often represents information about the service. This information often represents
operational information that allows service consumers to retrieve operational information that allows service consumers to retrieve
information about "service health" and related issues. information about "service health" and related issues.
This memo places no constraints on the specific representations used This memo places no constraints on the specific representations used
for all of these resources. It simply allows providers of a Web for all of these resources. It simply allows providers of a Web
skipping to change at page 6, line 35 skipping to change at page 6, line 35
many cases, it is provided in a representation that is consumed by many cases, it is provided in a representation that is consumed by
tools, code libraries, or similar components. tools, code libraries, or similar components.
4.3. The service-meta Link Relation Type 4.3. The service-meta Link Relation Type
The "service-meta" link relation type is used to link to available The "service-meta" link relation type is used to link to available
metadata for the service context of a resource. Service metadata is metadata for the service context of a resource. Service metadata is
any kind of data that may be of interest to existing or potential any kind of data that may be of interest to existing or potential
service users, with documentation/description only being two possible service users, with documentation/description only being two possible
facets of service metadata. The target resource is expected to facets of service metadata. The target resource is expected to
provide a service description that is primarily intended for machine provide a representation that is primarily intended for machine
consumption. In many cases, it is provided in a representation that consumption. In many cases, it is provided in a representation that
is consumed by tools, code libraries, or similar components. is consumed by tools, code libraries, or similar components.
Since service metadata can be for many different purposes, and use Since service metadata can be for many different purposes, and use
many different representations, it may make sense for representations many different representations, it may make sense for representations
using the "service-meta" link relation to add additional hints about using the "service-meta" link relation to add additional hints about
the specific kind or format of metadata that is being linked. This the specific kind or format of metadata that is being linked. This
definition of the "service-meta" link relation makes no specific definition of the "service-meta" link relation makes no specific
assumptions about how these link hints will be represented, and the assumptions about how these link hints will be represented, and the
specific mechanism will depend on the context where the "service- specific mechanism will depend on the context where the "service-
skipping to change at page 9, line 34 skipping to change at page 9, line 34
October 2007, <https://www.rfc-editor.org/info/rfc5023>. October 2007, <https://www.rfc-editor.org/info/rfc5023>.
[W3C.REC-webarch-20041215] [W3C.REC-webarch-20041215]
Jacobs, I. and N. Walsh, "Architecture of the World Wide Jacobs, I. and N. Walsh, "Architecture of the World Wide
Web, Volume One", World Wide Web Consortium Web, Volume One", World Wide Web Consortium
Recommendation REC-webarch-20041215, December 2004, Recommendation REC-webarch-20041215, December 2004,
<http://www.w3.org/TR/2004/REC-webarch-20041215>. <http://www.w3.org/TR/2004/REC-webarch-20041215>.
Appendix A. Acknowledgements Appendix A. Acknowledgements
Thanks for comments and suggestions provided by Mike Amundsen, Oliver Thanks for comments and suggestions provided by Mike Amundsen, Ben
Gierke, Sebastien Lambla, and Darrell Miller. Campbell, Alissa Cooper, Oliver Gierke, Benjamin Kaduk, Sebastien
Lambla, Darrell Miller, and Adam Roach.
Author's Address Author's Address
Erik Wilde Erik Wilde
Email: erik.wilde@dret.net Email: erik.wilde@dret.net
URI: http://dret.net/netdret/ URI: http://dret.net/netdret/
 End of changes. 8 change blocks. 
9 lines changed or deleted 11 lines changed or added

This html diff was produced by rfcdiff 1.48. The latest version is available from http://tools.ietf.org/tools/rfcdiff/