draft-ietf-httpapi-linkset-01.txt   draft-ietf-httpapi-linkset-02.txt 
Network Working Group E. Wilde Network Working Group E. Wilde
Internet-Draft Axway Internet-Draft Axway
Intended status: Informational H. Van de Sompel Intended status: Informational H. Van de Sompel
Expires: December 2, 2021 Data Archiving and Networked Services Expires: December 6, 2021 Data Archiving and Networked Services
May 31, 2021 June 4, 2021
Linkset: Media Types and a Link Relation Type for Link Sets Linkset: Media Types and a Link Relation Type for Link Sets
draft-ietf-httpapi-linkset-01 draft-ietf-httpapi-linkset-02
Abstract Abstract
This specification defines two document formats and respective media This specification defines two document formats and respective media
types for representing sets of links as stand-alone resources. One types for representing sets of links as stand-alone resources. One
format is JSON-based, the other aligned with the format for format is JSON-based, the other aligned with the format for
representing links in the HTTP "Link" header field. This representing links in the HTTP "Link" header field. This
specification also introduces a link relation type to support specification also introduces a link relation type to support
discovery of sets of links. discovery of sets of links.
skipping to change at page 1, line 44 skipping to change at page 1, line 44
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 December 2, 2021. This Internet-Draft will expire on December 6, 2021.
Copyright Notice Copyright Notice
Copyright (c) 2021 IETF Trust and the persons identified as the Copyright (c) 2021 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
skipping to change at page 2, line 36 skipping to change at page 2, line 36
3.2. Challenges Writing to HTTP Link Header Field . . . . . . 5 3.2. Challenges Writing to HTTP Link Header Field . . . . . . 5
3.3. Large Number of Links . . . . . . . . . . . . . . . . . . 5 3.3. Large Number of Links . . . . . . . . . . . . . . . . . . 5
4. Document Formats for Sets of Links . . . . . . . . . . . . . 5 4. Document Formats for Sets of Links . . . . . . . . . . . . . 5
4.1. HTTP Link Document Format: application/linkset . . . . . 6 4.1. HTTP Link Document Format: application/linkset . . . . . 6
4.2. JSON Document Format: application/linkset+json . . . . . 6 4.2. JSON Document Format: application/linkset+json . . . . . 6
4.2.1. Set of Links . . . . . . . . . . . . . . . . . . . . 7 4.2.1. Set of Links . . . . . . . . . . . . . . . . . . . . 7
4.2.2. Link Context Object . . . . . . . . . . . . . . . . . 8 4.2.2. Link Context Object . . . . . . . . . . . . . . . . . 8
4.2.3. Link Target Object . . . . . . . . . . . . . . . . . 8 4.2.3. Link Target Object . . . . . . . . . . . . . . . . . 8
4.2.4. Link Target Attributes . . . . . . . . . . . . . . . 10 4.2.4. Link Target Attributes . . . . . . . . . . . . . . . 10
4.2.5. JSON Extensibility . . . . . . . . . . . . . . . . . 14 4.2.5. JSON Extensibility . . . . . . . . . . . . . . . . . 14
5. The "linkset" Relation Type for Linking to a Set of Links . . 14 5. The "profile" attribute for media types to Represent Sets of
6. Examples . . . . . . . . . . . . . . . . . . . . . . . . . . 15 Links . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
6.1. Set of Links Provided as application/linkset . . . . . . 15 6. The "linkset" Relation Type for Linking to a Set of Links . . 15
6.2. Set of Links Provided as application/linkset+json . . . . 16 7. Examples . . . . . . . . . . . . . . . . . . . . . . . . . . 15
6.3. Discovering a Link Set via the "linkset" Link Relation 7.1. Set of Links Provided as application/linkset . . . . . . 15
7.2. Set of Links Provided as application/linkset+json . . . . 17
7.3. Discovering a Link Set via the "linkset" Link Relation
Type . . . . . . . . . . . . . . . . . . . . . . . . . . 19 Type . . . . . . . . . . . . . . . . . . . . . . . . . . 19
7. Implementation Status . . . . . . . . . . . . . . . . . . . . 19 8. Implementation Status . . . . . . . . . . . . . . . . . . . . 20
7.1. GS1 . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 8.1. GS1 . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
7.2. FAIR Signposting Profile . . . . . . . . . . . . . . . . 20 8.2. FAIR Signposting Profile . . . . . . . . . . . . . . . . 21
7.3. Open Journal Systems (OJS) . . . . . . . . . . . . . . . 20 8.3. Open Journal Systems (OJS) . . . . . . . . . . . . . . . 21
8. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 21 9. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 21
8.1. Link Relation Type: linkset . . . . . . . . . . . . . . . 21 9.1. Link Relation Type: linkset . . . . . . . . . . . . . . . 21
8.2. Media Type: application/linkset . . . . . . . . . . . . . 21 9.2. Media Type: application/linkset . . . . . . . . . . . . . 22
8.2.1. IANA Considerations . . . . . . . . . . . . . . . . . 21 9.3. Media Type: application/linkset+json . . . . . . . . . . 23
8.3. Media Type: application/linkset+json . . . . . . . . . . 22 10. Security Considerations . . . . . . . . . . . . . . . . . . . 24
9. Security Considerations . . . . . . . . . . . . . . . . . . . 23 11. References . . . . . . . . . . . . . . . . . . . . . . . . . 24
10. References . . . . . . . . . . . . . . . . . . . . . . . . . 24 11.1. Normative References . . . . . . . . . . . . . . . . . . 24
10.1. Normative References . . . . . . . . . . . . . . . . . . 24 11.2. Informative References . . . . . . . . . . . . . . . . . 26
10.2. Informative References . . . . . . . . . . . . . . . . . 25 Appendix A. Acknowledgements . . . . . . . . . . . . . . . . . . 27
Appendix A. Acknowledgements . . . . . . . . . . . . . . . . . . 26 Appendix B. JSON-LD Context . . . . . . . . . . . . . . . . . . 27
Appendix B. JSON-LD Context . . . . . . . . . . . . . . . . . . 26 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 30
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 29
1. Introduction 1. Introduction
Resources on the Web often use typed Web Links [RFC8288], either Resources on the Web often use typed Web Links [RFC8288], either
embedded in resource representations, for example using the <link> embedded in resource representations, for example using the <link>
element for HTML documents, or conveyed in the HTTP "Link" header for element for HTML documents, or conveyed in the HTTP "Link" header for
documents of any media type. In some cases, however, providing links documents of any media type. In some cases, however, providing links
in this manner is impractical or impossible and delivering a set of in this manner is impractical or impossible and delivering a set of
links as a stand-alone document is preferable. links as a stand-alone document is preferable.
skipping to change at page 14, line 36 skipping to change at page 14, line 36
The Web linking model provides for the use of extension target The Web linking model provides for the use of extension target
attributes as discussed in Section 4.2.4.3. Extensions based on the attributes as discussed in Section 4.2.4.3. Extensions based on the
JSON syntax MUST NOT be used, and MUST be ignored when found in a JSON syntax MUST NOT be used, and MUST be ignored when found in a
JSON linkset document. JSON linkset document.
This limitation of the JSON format allows to unambiguously round trip This limitation of the JSON format allows to unambiguously round trip
between links provided in the HTTP "Link" header, sets of links between links provided in the HTTP "Link" header, sets of links
serialized according to the "application/linkset" format, and sets of serialized according to the "application/linkset" format, and sets of
links serialized according to the "application/linkset+json" format. links serialized according to the "application/linkset+json" format.
5. The "linkset" Relation Type for Linking to a Set of Links 5. The "profile" attribute for media types to Represent Sets of Links
As a means to convey specific constraints or conventions (as per
[RFC6906]) that apply to a link set document, the "profile" attribute
MAY be used in conjunction with the media types "application/linkset"
and "application/linkset+json" detailed in Section 4.1 and
Section 4.2, respectively. For example, the attribute could be used
to indicate that a link set uses a specific, limited set of link
relation types.
The value of the "profile" attribute MUST be a non-empty list of
space-separated URIs, each of which identifies specific constraints
or conventions that apply to the link set document. Profile URIs MAY
be registered in the IANA Profile URI Registry in the manner
specified by [RFC7284].
The presence of a "profile" attribute in conjunction with the
"application/linkset" and "application/linkset+json" media types does
not change the semantics of a link set. As such, clients with and
without knowledge of profile URIs can use the same representation.
The profile parameter MAY be used by clients to express their
preferences, and, if a client does so, a server SHOULD return a
document that honors the profiles it recognizes, and MUST ignore the
profiles which it does not recognize.
6. The "linkset" Relation Type for Linking to a Set of Links
The target of a link with the "linkset" relation type provides a set The target of a link with the "linkset" relation type provides a set
of links, including links in which the resource that is the link of links, including links in which the resource that is the link
context participates. context participates.
A link with the "linkset" relation type MAY be provided in the header A link with the "linkset" relation type MAY be provided in the header
and/or the body of a resource's representation. It may also be and/or the body of a resource's representation. It may also be
discovered by other means, such as through client-side information. discovered by other means, such as through client-side information.
A resource MAY provide more than one link with a "linkset" relation A resource MAY provide more than one link with a "linkset" relation
skipping to change at page 15, line 13 skipping to change at page 15, line 40
of links provided by the resource that is the target of the link can of links provided by the resource that is the target of the link can
contain links in which the resource that is the context of the link contain links in which the resource that is the context of the link
does not participate; it MAY decide to ignore those links. does not participate; it MAY decide to ignore those links.
A user agent that follows a "linkset" link and obtains links for A user agent that follows a "linkset" link and obtains links for
which anchors and targets are not expressed as absolute URIs MUST which anchors and targets are not expressed as absolute URIs MUST
properly determine what the context is for these links; it SHOULD properly determine what the context is for these links; it SHOULD
ignore links for which it is unable to unambiguously make that ignore links for which it is unable to unambiguously make that
determination. determination.
6. Examples 7. Examples
Section 6.1 and Section 6.2 show examples whereby the set of links Section 7.1 and Section 7.2 show examples whereby a set of links is
are provided as "application/linkset" and "application/linkset+json" provided as "application/linkset" and "application/linkset+json"
documents, respectively. Section 6.3 illustrates the use of the documents, respectively. Section 7.3 illustrates the use of the
"linkset" link relation type to support discovery of sets of links. "linkset" link relation type to support discovery of sets of links.
6.1. Set of Links Provided as application/linkset 7.1. Set of Links Provided as application/linkset
Figure 1 shows a client issuing an HTTP GET request against resource Figure 1 shows a client issuing an HTTP GET request against resource
<http://example.org/resource1>. <https://example.org/links/resource1>.
GET /resource1 HTTP/1.1 GET /links/resource1 HTTP/1.1
Host: example.org Host: example.org
Connection: close Connection: close
Figure 1: Client HTTP GET request Figure 1: Client HTTP GET request
Figure 2 shows the response to the GET request of Figure 1. The Figure 2 shows the response to the GET request of Figure 1. The
response contains a Content-Type header specifying that the media response contains a Content-Type header specifying that the media
type of the response is "application/linkset". A set of links, type of the response is "application/linkset". A set of links,
including links that pertain to the responding resource, is provided revealing authorship and versioning related to resource
in the response body. <https://example.org/resource1>, is provided in the response body.
The HTTP "Link" header indicates the availability of an alternate
representation of the set of links using media type "application/
linkset+json".
HTTP/1.1 200 OK HTTP/1.1 200 OK
Date: Mon, 12 Aug 2019 10:35:51 GMT Date: Mon, 12 Aug 2019 10:35:51 GMT
Server: Apache-Coyote/1.1 Server: Apache-Coyote/1.1
Content-Length: 855 Content-Length: 1023
Content-Type: application/linkset; charset=UTF-8 Content-Type: application/linkset; charset=UTF-8
Link: <https://example.org/links/resource1> ; rel="alternate"
; type="application/linkset+json"
Connection: close Connection: close
<http://authors.example.net/johndoe> <https://authors.example.net/johndoe>
; rel="author"
; type="application/rdf+xml"
; anchor="http://example.org/resource1",
<http://authors.example.net/janedoe>
; rel="author" ; rel="author"
; type="application/rdf+xml" ; type="application/rdf+xml"
; anchor="http://example.org/resource1", ; anchor="https://example.org/resource1",
<http://example.org/resource1/items/AF48EF.pdf> <https://example.org/resource1?version=3>
; rel="item"
; type="application/pdf"
; anchor="http://example.org/resource1",
<http://example.org/resource1/items/CB63DA.html>
; rel="item"
; type="text/html"
; anchor="http://example.org/resource1",
<http://example.org/resource1>
; rel="latest-version" ; rel="latest-version"
; anchor="http://example.org/resource41/", ; type="text/html"
<http://example.org/resource40> ; anchor="https://example.org/resource1",
; rel="prev" <https://example.org/resource1?version=2>
; anchor="http://example.org/resource41/", ; rel="predecessor-version"
<http://authors.example.net/alice> ; type="text/html"
; anchor="https://example.org/resource1?version=3",
<https://example.org/resource1?version=1>
; rel="predecessor-version"
; type="text/html"
; anchor="https://example.org/resource1?version=2",
<https://example.org/resource1?version=1>
; rel="memento"
; type="text/html"
; datetime="Thu, 13 Jun 2019 09:34:33 GMT"
; anchor="https://example.org/resource1",
<https://example.org/resource1?version=2>
; rel="memento"
; type="text/html"
; datetime="Sun, 21 Jul 2019 12:22:04 GMT"
; anchor="https://example.org/resource1",
<https://authors.example.net/alice>
; rel="author" ; rel="author"
; anchor="http://example.org/resource1/items/CB63DA.html#cmt-1" ; anchor="https://example.org/resource1#comment=1"
Figure 2: Response to HTTP GET includes a set of links Figure 2: Response to HTTP GET includes a set of links
6.2. Set of Links Provided as application/linkset+json 7.2. Set of Links Provided as application/linkset+json
Figure 3 shows the client issuing an HTTP GET request against Figure 3 shows the client issuing an HTTP GET request against
<http://example.com/links/article/7507>. In the request, the client <https://example.org/links/resource1>. In the request, the client
uses an "Accept" header to indicate it prefers a response in the uses an "Accept" header to indicate it prefers a response in the
"application/linkset+json" format. "application/linkset+json" format.
GET links/article/7507 HTTP/1.1 GET links/resource1 HTTP/1.1
Host: example.com Host: example.org
Accept: application/linkset+json Accept: application/linkset+json
Connection: close Connection: close
Figure 3: Client HTTP GET request expressing preference for Figure 3: Client HTTP GET request expressing preference for
"application/linkset+json" response "application/linkset+json" response
Figure 4 shows the response to the HTTP GET request of Figure 3. The Figure 4 shows the response to the HTTP GET request of Figure 3. The
set of links is serialized according to the media type "application/ set of links is serialized according to the media type "application/
linkset+json". linkset+json".
HTTP/1.1 200 OK HTTP/1.1 200 OK
Date: Mon, 12 Aug 2019 10:46:22 GMT Date: Mon, 12 Aug 2019 10:46:22 GMT
Server: Apache-Coyote/1.1 Server: Apache-Coyote/1.1
Content-Type: application/linkset+json Content-Type: application/linkset+json
Content-Length: 802 Link: <https://example.org/links/resource1> ; rel="alternate"
; type="application/linkset"
Content-Length: 1349
{ {
"linkset": [ "linkset": [
{ {
"anchor": "https://example.org/article/view/7507", "anchor": "https://example.org/resource1",
"author": [ "author": [
{ {
"href": "https://orcid.org/0000-0002-1825-0097" "href": "https://authors.example.net/johndoe",
"type": "application/rdf+xml"
} }
], ],
"item": [ "memento": [
{ {
"href": "https://example.org/article/7507/item/1", "href": "https://example.org/resource1?version=1",
"type": "application/pdf" "type": "text/html",
"datetime": "Thu, 13 Jun 2019 09:34:33 GMT"
}, },
{ {
"href": "https://example.org/article/7507/item/2", "href": "https://example.org/resource1?version=2",
"type": "text/csv" "type": "text/html",
"datetime": "Sun, 21 Jul 2019 12:22:04 GMT"
} }
], ],
"cite-as": [ "latest-version": [
{ {
"href": "https://doi.org/10.5555/12345680", "href": "https://example.org/resource1?version=3",
"title": "A Methodology for the Emulation of Architecture" "type": "text/html"
} }
] ]
}, },
{ {
"anchor": "https://example.com/links/article/7507", "anchor": "https://example.org/resource1?version=3",
"alternate": [ "predecessor-version": [
{ {
"href": "https://mirror.example.com/links/article/7507", "href": "https://example.org/resource1?version=2",
"type": "application/linkset" "type": "text/html"
}
]
},
{
"anchor": "https://example.org/resource1?version=2",
"predecessor-version": [
{
"href": "https://example.org/resource1?version=1",
"type": "text/html"
}
]
},
{
"anchor": "https://example.org/resource1#comment=1",
"author": [
{
"href": "https://authors.example.net/alice"
} }
] ]
} }
] ]
} }
Figure 4: Response to the client's request for the set of links Figure 4: Response to the client's request for the set of links
6.3. Discovering a Link Set via the "linkset" Link Relation Type 7.3. Discovering a Link Set via the "linkset" Link Relation Type
Figure 5 shows a client issuing an HTTP HEAD request against resource Figure 5 shows a client issuing an HTTP HEAD request against resource
<http://example.org/article/view/7507>. <https://example.org/resource1>.
HEAD article/view/7507 HTTP/1.1 HEAD resource1 HTTP/1.1
Host: example.org Host: example.org
Connection: close Connection: close
Figure 5: Client HTTP HEAD request Figure 5: Client HTTP HEAD request
Figure 6 shows the response to the HEAD request of Figure 5. The Figure 6 shows the response to the HEAD request of Figure 5. The
response contains a "Link" header with a link that has the "linkset" response contains an HTTP "Link" header with a link that has the
relation type. It indicates that a set of links is provided by "linkset" relation type. It indicates that a set of links is
resource <http://example.com/links/article/7507>, which provides a provided by resource <https://example.org/links/resource1>, which
representation with media type "application/linkset+json". provides a representation with media type "application/linkset+json".
HTTP/1.1 200 OK HTTP/1.1 200 OK
Date: Mon, 12 Aug 2019 10:45:54 GMT Date: Mon, 12 Aug 2019 10:45:54 GMT
Server: Apache-Coyote/1.1 Server: Apache-Coyote/1.1
Link: <http://example.com/links/article/7507> Link: <https://example.org/links/resource1>
; rel="linkset" ; rel="linkset"
; type="application/linkset+json" ; type="application/linkset+json"
Content-Length: 236 Content-Length: 236
Content-Type: text/html;charset=utf-8 Content-Type: text/html;charset=utf-8
Connection: close Connection: close
Figure 6: Response to HTTP HEAD request Figure 6: Response to HTTP HEAD request
Section 6.2 shows a client obtaining a set of links by issuing an Section 7.2 shows a client obtaining a set of links by issuing an
HTTP GET on the target of the link with the "linkset" relation type, HTTP GET on the target of the link with the "linkset" relation type,
<http://example.com/links/article/7507>. <https://example.org/links/resource1>.
7. Implementation Status 8. Implementation Status
Note to RFC Editor: Please remove this section before publication. Note to RFC Editor: Please remove this section before publication.
This section records the status of known implementations of the This section records the status of known implementations of the
protocol defined by this specification at the time of posting of this protocol defined by this specification at the time of posting of this
Internet-Draft, and is based on a proposal described in RFC 6982 Internet-Draft, and is based on a proposal described in RFC 6982
[RFC6982]. The description of implementations in this section is [RFC6982]. The description of implementations in this section is
intended to assist the IETF in its decision processes in progressing intended to assist the IETF in its decision processes in progressing
drafts to RFCs. Please note that the listing of any individual drafts to RFCs. Please note that the listing of any individual
implementation here does not imply endorsement by the IETF. implementation here does not imply endorsement by the IETF.
skipping to change at page 20, line 15 skipping to change at page 20, line 45
implementations or their features. Readers are advised to note that implementations or their features. Readers are advised to note that
other implementations may exist. other implementations may exist.
According to RFC 6982, "this will allow reviewers and working groups According to RFC 6982, "this will allow reviewers and working groups
to assign due consideration to documents that have the benefit of to assign due consideration to documents that have the benefit of
running code, which may serve as evidence of valuable experimentation running code, which may serve as evidence of valuable experimentation
and feedback that have made the implemented protocols more mature. and feedback that have made the implemented protocols more mature.
It is up to the individual working groups to use this information as It is up to the individual working groups to use this information as
they see fit". they see fit".
7.1. GS1 8.1. GS1
GS1 is a provider of barcodes (GS1 GTINs and EAN/UPC) for retail GS1 is a provider of barcodes (GS1 GTINs and EAN/UPC) for retail
products and manages an ecology of services and standards to leverage products and manages an ecology of services and standards to leverage
them at a global scale. GS1 has indicated that it will implement them at a global scale. GS1 has indicated that it will implement
this "linkset" specification as a means to allow requesting and this "linkset" specification as a means to allow requesting and
representing links pertaining to products from various retailers. representing links pertaining to products from various retailers.
Currently, the GS1 Digital Link specification makes an informative Currently, the GS1 Digital Link specification makes an informative
reference to version 03 of the "linkset" I-D. GS1 expresses reference to version 03 of the "linkset" I-D. GS1 expresses
confidence that this will become a normative reference in the next confidence that this will become a normative reference in the next
iteration of that specification, likely to be ratified as a GS1 iteration of that specification, likely to be ratified as a GS1
standard around February 2021. standard around February 2021.
7.2. FAIR Signposting Profile 8.2. FAIR Signposting Profile
The FAIR Signposting Profile is a community specification aimed at The FAIR Signposting Profile is a community specification aimed at
improving machine navigation of scholarly objects on the web through improving machine navigation of scholarly objects on the web through
the use of typed web links pointing at e.g. web resources that are the use of typed web links pointing at e.g. web resources that are
part of a specific object, persistent identifiers for the object and part of a specific object, persistent identifiers for the object and
its authors, license information pertaining to the object. The its authors, license information pertaining to the object. The
specification encourages the use of Linksets and initial specification encourages the use of Linksets and initial
implementations are ongoing, for example, for the open source implementations are ongoing, for example, for the open source
Dataverse data repository platform that was initiated by Harvard Dataverse data repository platform that was initiated by Harvard
University and is meanwhile used by research institutions, worldwide. University and is meanwhile used by research institutions, worldwide.
7.3. Open Journal Systems (OJS) 8.3. Open Journal Systems (OJS)
Open Journal Systems (OJS) is an open-source software for the Open Journal Systems (OJS) is an open-source software for the
management of peer-reviewed academic journals, and is created by the management of peer-reviewed academic journals, and is created by the
Public Knowledge Project (PKP), released under the GNU General Public Public Knowledge Project (PKP), released under the GNU General Public
License. Open Journal Systems (OJS) is a journal management and License. Open Journal Systems (OJS) is a journal management and
publishing system that has been developed by PKP through its publishing system that has been developed by PKP through its
federally funded efforts to expand and improve access to research. federally funded efforts to expand and improve access to research.
The OJS platform has implemented "linkset" support as an alternative The OJS platform has implemented "linkset" support as an alternative
way to provide links when there are more than a configured limit way to provide links when there are more than a configured limit
(they consider using about 10 as a good default, for testing purpose (they consider using about 10 as a good default, for testing purpose
it is currently set to 8). it is currently set to 8).
8. IANA Considerations 9. IANA Considerations
8.1. Link Relation Type: linkset 9.1. Link Relation Type: linkset
The link relation type below has been registered by IANA per The link relation type below has been registered by IANA per
Section 6.2.1 of Web Linking [RFC8288]: Section 6.2.1 of Web Linking [RFC8288]:
Relation Name: linkset Relation Name: linkset
Description: The Target IRI of a link with the "linkset" relation Description: The Target IRI of a link with the "linkset" relation
type provides a set of links, including links in which the Context type provides a set of links, including links in which the Context
IRI of the link participates. IRI of the link participates.
Reference: [[ This document ]] Reference: [[ This document ]]
8.2. Media Type: application/linkset 9.2. Media Type: application/linkset
8.2.1. IANA Considerations
The Internet media type [RFC6838] for a natively encoded linkset is The Internet media type [RFC6838] for a natively encoded linkset is
application/linkset. application/linkset.
Type name: application Type name: application
Subtype name: linkset Subtype name: linkset
Required parameters: none Required parameters: none
Optional parameters: none Optional parameters: profile
Encoding considerations: Linksets are encoded according to the Encoding considerations: Linksets are encoded according to the
definition of [RFC8288]. The encoding of [RFC8288] is based on definition of [RFC8288]. The encoding of [RFC8288] is based on
the general encoding rules of [RFC7230], with the addition of the general encoding rules of [RFC7230], with the addition of
allowing indicating character encoding and language for specific allowing indicating character encoding and language for specific
parameters as defined by [RFC8187]. parameters as defined by [RFC8187].
Security considerations: The security considerations of [[ This Security considerations: The security considerations of [[ This
document ]] apply. document ]] apply.
skipping to change at page 22, line 25 skipping to change at page 23, line 4
Macintosh file type code(s): TEXT Macintosh file type code(s): TEXT
Person & email address to contact for further information: Erik Person & email address to contact for further information: Erik
Wilde <erik.wilde@dret.net> Wilde <erik.wilde@dret.net>
Intended usage: COMMON Intended usage: COMMON
Restrictions on usage: none Restrictions on usage: none
Author: Erik Wilde <erik.wilde@dret.net> Author: Erik Wilde <erik.wilde@dret.net>
Change controller: IETF Change controller: IETF
8.3. Media Type: application/linkset+json 9.3. Media Type: application/linkset+json
The Internet media type [RFC6838] for a JSON-encoded linkset is The Internet media type [RFC6838] for a JSON-encoded linkset is
application/linkset+json. application/linkset+json.
Type name: application Type name: application
Subtype name: linkset+json Subtype name: linkset+json
Required parameters: none Required parameters: none
Optional parameters: none Optional parameters: profile
Encoding considerations: The encoding considerations of [RFC8259] Encoding considerations: The encoding considerations of [RFC8259]
apply apply
Security considerations: The security considerations of [[ This Security considerations: The security considerations of [[ This
document ]] apply. document ]] apply.
Interoperability considerations: The interoperability Interoperability considerations: The interoperability
considerations of [RFC8259] apply. considerations of [RFC8259] apply.
skipping to change at page 23, line 26 skipping to change at page 24, line 4
Macintosh file type code(s): TEXT Macintosh file type code(s): TEXT
Person & email address to contact for further information: Erik Person & email address to contact for further information: Erik
Wilde <erik.wilde@dret.net> Wilde <erik.wilde@dret.net>
Intended usage: COMMON Intended usage: COMMON
Restrictions on usage: none Restrictions on usage: none
Author: Erik Wilde <erik.wilde@dret.net> Author: Erik Wilde <erik.wilde@dret.net>
Change controller: IETF Change controller: IETF
9. Security Considerations 10. Security Considerations
The security considerations of Web Linking [RFC8288] apply, as long The security considerations of Web Linking [RFC8288] apply, as long
as they are not specifically discussing the risks of exposing as they are not specifically discussing the risks of exposing
information in HTTP header fields. information in HTTP header fields.
In general, links may cause information leakage when they expose In general, links may cause information leakage when they expose
information (such as URIs) that can be sensitive or private. Links information (such as URIs) that can be sensitive or private. Links
may expose "hidden URIs" that are not supposed to be openly shared, may expose "hidden URIs" that are not supposed to be openly shared,
and may not be sufficiently protected. Ideally, none of the URIs and may not be sufficiently protected. Ideally, none of the URIs
exposed in links should be supposed to be "hidden"; instead, if these exposed in links should be supposed to be "hidden"; instead, if these
skipping to change at page 24, line 17 skipping to change at page 24, line 42
o The model introduced in this specification supports "3rd party o The model introduced in this specification supports "3rd party
links", where one party can provide links that have another links", where one party can provide links that have another
party's resource as an anchor. Depending on the link semantics party's resource as an anchor. Depending on the link semantics
and the application context, it is important to verify that there and the application context, it is important to verify that there
is sufficient trust in that 3rd party to allow it to provide these is sufficient trust in that 3rd party to allow it to provide these
links. Applications may choose to treat 3rd party links links. Applications may choose to treat 3rd party links
differently than cases where a resource and the links for that differently than cases where a resource and the links for that
resource are provided by the same party. resource are provided by the same party.
10. References 11. References
10.1. Normative References 11.1. Normative References
[RFC0822] Crocker, D., "STANDARD FOR THE FORMAT OF ARPA INTERNET [RFC0822] Crocker, D., "STANDARD FOR THE FORMAT OF ARPA INTERNET
TEXT MESSAGES", STD 11, RFC 822, DOI 10.17487/RFC0822, TEXT MESSAGES", STD 11, RFC 822, DOI 10.17487/RFC0822,
August 1982, <https://www.rfc-editor.org/info/rfc822>. August 1982, <https://www.rfc-editor.org/info/rfc822>.
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", BCP 14, RFC 2119, Requirement Levels", BCP 14, RFC 2119,
DOI 10.17487/RFC2119, March 1997, DOI 10.17487/RFC2119, March 1997,
<https://www.rfc-editor.org/info/rfc2119>. <https://www.rfc-editor.org/info/rfc2119>.
skipping to change at page 25, line 5 skipping to change at page 25, line 32
[RFC6690] Shelby, Z., "Constrained RESTful Environments (CoRE) Link [RFC6690] Shelby, Z., "Constrained RESTful Environments (CoRE) Link
Format", RFC 6690, DOI 10.17487/RFC6690, August 2012, Format", RFC 6690, DOI 10.17487/RFC6690, August 2012,
<https://www.rfc-editor.org/info/rfc6690>. <https://www.rfc-editor.org/info/rfc6690>.
[RFC6838] Freed, N., Klensin, J., and T. Hansen, "Media Type [RFC6838] Freed, N., Klensin, J., and T. Hansen, "Media Type
Specifications and Registration Procedures", BCP 13, Specifications and Registration Procedures", BCP 13,
RFC 6838, DOI 10.17487/RFC6838, January 2013, RFC 6838, DOI 10.17487/RFC6838, January 2013,
<https://www.rfc-editor.org/info/rfc6838>. <https://www.rfc-editor.org/info/rfc6838>.
[RFC6906] Wilde, E., "The 'profile' Link Relation Type", RFC 6906,
DOI 10.17487/RFC6906, March 2013,
<https://www.rfc-editor.org/info/rfc6906>.
[RFC6982] Sheffer, Y. and A. Farrel, "Improving Awareness of Running [RFC6982] Sheffer, Y. and A. Farrel, "Improving Awareness of Running
Code: The Implementation Status Section", RFC 6982, Code: The Implementation Status Section", RFC 6982,
DOI 10.17487/RFC6982, July 2013, DOI 10.17487/RFC6982, July 2013,
<https://www.rfc-editor.org/info/rfc6982>. <https://www.rfc-editor.org/info/rfc6982>.
[RFC7230] Fielding, R., Ed. and J. Reschke, Ed., "Hypertext Transfer [RFC7230] Fielding, R., Ed. and J. Reschke, Ed., "Hypertext Transfer
Protocol (HTTP/1.1): Message Syntax and Routing", Protocol (HTTP/1.1): Message Syntax and Routing",
RFC 7230, DOI 10.17487/RFC7230, June 2014, RFC 7230, DOI 10.17487/RFC7230, June 2014,
<https://www.rfc-editor.org/info/rfc7230>. <https://www.rfc-editor.org/info/rfc7230>.
[RFC7231] Fielding, R., Ed. and J. Reschke, Ed., "Hypertext Transfer [RFC7231] Fielding, R., Ed. and J. Reschke, Ed., "Hypertext Transfer
Protocol (HTTP/1.1): Semantics and Content", RFC 7231, Protocol (HTTP/1.1): Semantics and Content", RFC 7231,
DOI 10.17487/RFC7231, June 2014, DOI 10.17487/RFC7231, June 2014,
<https://www.rfc-editor.org/info/rfc7231>. <https://www.rfc-editor.org/info/rfc7231>.
[RFC7284] Lanthaler, M., "The Profile URI Registry", RFC 7284,
DOI 10.17487/RFC7284, June 2014,
<https://www.rfc-editor.org/info/rfc7284>.
[RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC [RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC
2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174, 2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174,
May 2017, <https://www.rfc-editor.org/info/rfc8174>. May 2017, <https://www.rfc-editor.org/info/rfc8174>.
[RFC8187] Reschke, J., "Indicating Character Encoding and Language [RFC8187] Reschke, J., "Indicating Character Encoding and Language
for HTTP Header Field Parameters", RFC 8187, for HTTP Header Field Parameters", RFC 8187,
DOI 10.17487/RFC8187, September 2017, DOI 10.17487/RFC8187, September 2017,
<https://www.rfc-editor.org/info/rfc8187>. <https://www.rfc-editor.org/info/rfc8187>.
[RFC8259] Bray, T., Ed., "The JavaScript Object Notation (JSON) Data [RFC8259] Bray, T., Ed., "The JavaScript Object Notation (JSON) Data
Interchange Format", STD 90, RFC 8259, Interchange Format", STD 90, RFC 8259,
DOI 10.17487/RFC8259, December 2017, DOI 10.17487/RFC8259, December 2017,
<https://www.rfc-editor.org/info/rfc8259>. <https://www.rfc-editor.org/info/rfc8259>.
[RFC8288] Nottingham, M., "Web Linking", RFC 8288, [RFC8288] Nottingham, M., "Web Linking", RFC 8288,
DOI 10.17487/RFC8288, October 2017, DOI 10.17487/RFC8288, October 2017,
<https://www.rfc-editor.org/info/rfc8288>. <https://www.rfc-editor.org/info/rfc8288>.
10.2. Informative References 11.2. Informative References
[RFC4287] Nottingham, M., Ed. and R. Sayre, Ed., "The Atom [RFC4287] Nottingham, M., Ed. and R. Sayre, Ed., "The Atom
Syndication Format", RFC 4287, DOI 10.17487/RFC4287, Syndication Format", RFC 4287, DOI 10.17487/RFC4287,
December 2005, <https://www.rfc-editor.org/info/rfc4287>. December 2005, <https://www.rfc-editor.org/info/rfc4287>.
[RFC5988] Nottingham, M., "Web Linking", RFC 5988, [RFC5988] Nottingham, M., "Web Linking", RFC 5988,
DOI 10.17487/RFC5988, October 2010, DOI 10.17487/RFC5988, October 2010,
<https://www.rfc-editor.org/info/rfc5988>. <https://www.rfc-editor.org/info/rfc5988>.
[W3C.REC-json-ld-20140116] [W3C.REC-json-ld-20140116]
Sporny, M., Kellogg, G., and M. Lanthaler, "JSON-LD 1.0", Sporny, M., Kellogg, G., and M. Lanthaler, "JSON-LD 1.0",
World Wide Web Consortium Recommendation REC-json-ld- World Wide Web Consortium Recommendation REC-json-ld-
20140116, January 2014, 20140116, January 2014,
<https://www.w3.org/TR/2014/REC-json-ld-20140116>. <https://www.w3.org/TR/2014/REC-json-ld-20140116>.
10.3. URIs 11.3. URIs
[1] https://www.w3.org/TR/2014/REC-json-ld-20140116/#interpreting- [1] https://www.w3.org/TR/2014/REC-json-ld-20140116/#interpreting-
json-as-json-ld json-as-json-ld
[2] https://tools.ietf.org/html/rfc8288#appendix-A.2 [2] https://tools.ietf.org/html/rfc8288#appendix-A.2
Appendix A. Acknowledgements Appendix A. Acknowledgements
Thanks for comments and suggestions provided by Phil Archer, Thanks for comments and suggestions provided by Phil Archer,
Dominique Guinard, Mark Nottingham, Stian Soiland-Reyes, and Sarven Dominique Guinard, Mark Nottingham, Stian Soiland-Reyes, and Sarven
 End of changes. 58 change blocks. 
105 lines changed or deleted 167 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/