1 # Drupal core's extension relation types.
2 # See https://tools.ietf.org/html/rfc5988#section-4.2.
4 uri: https://drupal.org/link-relations/add-form
5 description: A form where a resource of this type can be created.
7 uri: https://drupal.org/link-relations/delete-form
8 description: A form where a resource of this type can be deleted.
10 uri: https://drupal.org/link-relations/revision
11 description: A particular version of this resource.
13 uri: https://drupal.org/link-relations/create
14 description: A REST resource URL where a resource of this type can be created.
16 uri: https://drupal.org/link-relations/enable
17 description: A REST resource URL where a resource of this type can be enabled.
19 uri: https://drupal.org/link-relations/disable
20 description: A REST resource URL where a resource of this type can be disabled.
21 edit-permissions-form:
22 uri: https://drupal.org/link-relations/edit-permissions-form
23 description: A form where permissions assigned to a resource of this type can be edited.
25 uri: https://drupal.org/link-relations/overview-form
26 description: A form where an overview of the collection of resources belonging to a resource of this type can be edited in bulk.
28 uri: https://drupal.org/link-relations/reset-form
29 description: A form where an overview of the collection of resources belonging to a resource of this type can be reset.
31 uri: https://drupal.org/link-relations/cancel-form
32 description: A form where a resource of this type can be canceled.
34 uri: https://drupal.org/link-relations/flush-form
35 description: A form where a resource of this type can be flushed.
37 # All registered relation types.
38 # See https://tools.ietf.org/html/rfc5988#section-4.1.
39 # See https://www.iana.org/assignments/link-relations/link-relations.xhtml.
41 description: "Refers to a resource that is the subject of the link's context."
42 reference: '[RFC6903], section 2'
44 description: 'Refers to a substitute for this context'
45 reference: '[http://www.w3.org/TR/html5/links.html#link-type-alternate]'
47 description: 'Refers to an appendix.'
48 reference: '[http://www.w3.org/TR/1999/REC-html401-19991224]'
50 description: "Refers to a collection of records, documents, or other materials of historical interest."
51 reference: '[http://www.w3.org/TR/2011/WD-html5-20110113/links.html#rel-archives]'
53 description: "Refers to the context's author."
54 reference: '[http://www.w3.org/TR/html5/links.html#link-type-author]'
56 description: "Identifies the entity that blocks access to a resource following receipt of a legal demand."
57 reference: '[RFC7725]'
59 description: 'Gives a permanent link to use for bookmarking purposes.'
60 reference: '[http://www.w3.org/TR/html5/links.html#link-type-bookmark]'
62 description: 'Designates the preferred version of a resource (the IRI and its contents).'
63 reference: '[RFC6596]'
65 description: 'Refers to a chapter in a collection of resources.'
66 reference: '[http://www.w3.org/TR/1999/REC-html401-19991224]'
68 description: 'The target IRI points to a resource which represents the collection resource for the context IRI.'
69 reference: '[RFC6573]'
71 description: 'Refers to a table of contents.'
72 reference: '[http://www.w3.org/TR/1999/REC-html401-19991224]'
74 description: "Refers to a copyright statement that applies to the link's context."
75 reference: '[http://www.w3.org/TR/1999/REC-html401-19991224]'
77 description: 'The target IRI points to a resource where a submission form can be obtained.'
78 reference: '[RFC6861]'
80 description: "Refers to a resource containing the most recent item(s) in a collection of resources."
81 reference: '[RFC5005]'
83 description: "The target URI points to a resource where a submission form for customizing associated resource can be obtained."
84 reference: '[RFC6861]'
86 description: 'The target IRI points to a resource from which this material was derived.'
87 reference: '[draft-hoffman-xml2rfc]'
89 description: "Refers to a resource providing information about the link's context."
90 reference: '[http://www.w3.org/TR/powder-dr/#assoc-linking]'
92 description: "The relationship A 'describes' B asserts that resource A provides a description of resource B. There are no constraints on the format or representation of either A or B, neither are there any further constraints on either resource."
93 reference: '[RFC6892]'
94 notes: "This link relation type is the inverse of the 'describedby' relation type. While 'describedby' establishes a relation from the described resource back to the resource that describes it, 'describes' established a relation from the describing resource to the resource it describes. If B is 'describedby' A, then A 'describes' B."
96 description: "Refers to a list of patent disclosures made with respect to material for which 'disclosure' relation is specified."
97 reference: '[RFC6579]'
99 description: "Used to indicate an origin that will be used to fetch required resources for the link context, and that the user agent ought to resolve as early as possible."
100 reference: '[https://www.w3.org/TR/resource-hints/]'
102 description: "Refers to a resource whose available representations are byte-for-byte identical with the corresponding representations of the context IRI."
103 reference: '[RFC6249]'
104 notes: "This relation is for static resources. That is, an HTTP GET request on any duplicate will return the same representation. It does not make sense for dynamic or POSTable resources and should not be used for them."
106 description: "Refers to a resource that can be used to edit the link's context."
107 reference: '[RFC5023]'
109 description: "The target IRI points to a resource where a submission form for editing associated resource can be obtained."
110 reference: '[RFC6861]'
112 description: "Refers to a resource that can be used to edit media associated with the link's context."
113 reference: '[RFC5023]'
115 description: "Identifies a related resource that is potentially large and might require special handling."
116 reference: '[RFC4287]'
118 description: "An IRI that refers to the furthest preceding resource in a series of resources."
119 reference: '[RFC5988]'
120 notes: "This relation type registration did not indicate a reference. Originally requested by Mark Nottingham in December 2004."
122 description: 'Refers to a glossary of terms.'
123 reference: '[http://www.w3.org/TR/1999/REC-html401-19991224]'
125 description: 'Refers to context-sensitive help.'
126 reference: '[http://www.w3.org/TR/html5/links.html#link-type-help]'
128 description: "Refers to a resource hosted by the server indicated by the link context."
129 reference: '[RFC6690]'
130 notes: "This relation is used in CoRE where links are retrieved as a \"/.well-known/core\" resource representation, and is the default relation type in the CoRE Link Format."
132 description: "Refers to a hub that enables registration for notification of updates to the context."
133 reference: '[http://pubsubhubbub.googlecode.com]'
134 notes: 'This relation type was requested by Brett Slatkin.'
136 description: "Refers to an icon representing the link's context."
137 reference: '[http://www.w3.org/TR/html5/links.html#link-type-icon]'
139 description: 'Refers to an index.'
140 reference: '[http://www.w3.org/TR/1999/REC-html401-19991224]'
142 description: 'The target IRI points to a resource that is a member of the collection represented by the context IRI.'
143 reference: '[RFC6573]'
145 description: "An IRI that refers to the furthest following resource in a series of resources."
146 reference: '[RFC5988]'
147 notes: "This relation type registration did not indicate a reference. Originally requested by Mark Nottingham in December 2004."
149 description: "Points to a resource containing the latest (e.g., current) version of the context."
150 reference: '[RFC5829]'
152 description: 'Refers to a license associated with this context.'
153 reference: '[RFC4946]'
154 notes: "For implications of use in HTML, see: http://www.w3.org/TR/html5/links.html#link-type-license"
156 description: "Refers to further information about the link's context, expressed as a LRDD (\"Link-based Resource Descriptor Document\") resource. See [RFC6415] for information about processing this relation type in host-meta documents. When used elsewhere, it refers to additional links and other metadata. Multiple instances indicate additional LRDD resources. LRDD resources MUST have an \"application/xrd+xml\" representation, and MAY have others."
157 reference: '[RFC6415]'
159 description: 'The Target IRI points to a Memento, a fixed resource that will not change state anymore.'
160 reference: '[RFC7089]'
161 notes: "A Memento for an Original Resource is a resource that encapsulates a prior state of the Original Resource."
163 description: 'Refers to a resource that can be used to monitor changes in an HTTP resource.'
164 reference: '[RFC5989]'
166 description: 'Refers to a resource that can be used to monitor changes in a specified group of HTTP resources.'
167 reference: '[RFC5989]'
169 description: "Indicates that the link's context is a part of a series, and that the next in the series is the link target."
170 reference: '[http://www.w3.org/TR/html5/links.html#link-type-next]'
172 description: 'Refers to the immediately following archive resource.'
173 reference: '[RFC5005]'
175 description: 'Indicates that the context’s original author or publisher does not endorse the link target.'
176 reference: '[http://www.w3.org/TR/html5/links.html#link-type-nofollow]'
178 description: 'Indicates that no referrer information is to be leaked when following the link.'
179 reference: '[http://www.w3.org/TR/html5/links.html#link-type-noreferrer]'
181 description: 'The Target IRI points to an Original Resource.'
182 reference: '[RFC7089]'
183 notes: "An Original Resource is a resource that exists or used to exist, and for which access to one of its prior states may be required."
185 description: 'Indicates a resource where payment is accepted.'
186 reference: '[RFC5988]'
187 notes: "This relation type registration did not indicate a reference. Requested by Joshua Kinberg and Robert Sayre. It is meant as a general way to facilitate acts of payment, and thus this specification makes no assumptions on the type of payment or transaction protocol. Examples may include a web page where donations are accepted or where goods and services are available for purchase. rel=\"payment\" is not intended to initiate an automated transaction. In Atom documents, a link element with a rel=\"payment\" attribute may exist at the feed/channel level and/or the entry/item level. For example, a rel=\"payment\" link at the feed/channel level may point to a \"tip jar\" URI, whereas an entry/ item containing a book review may include a rel=\"payment\" link that points to the location where the book may be purchased through an online retailer."
189 description: 'Gives the address of the pingback resource for the link context.'
190 reference: '[http://www.hixie.ch/specs/pingback/pingback]'
192 description: "Used to indicate an origin that will be used to fetch required resources for the link context. Initiating an early connection, which includes the DNS lookup, TCP handshake, and optional TLS negotiation, allows the user agent to mask the high latency costs of establishing a connection."
193 reference: '[https://www.w3.org/TR/resource-hints/]'
195 description: "Points to a resource containing the predecessor version in the version history."
196 reference: '[RFC5829]'
198 description: "The prefetch link relation type is used to identify a resource that might be required by the next navigation from the link context, and that the user agent ought to fetch, such that the user agent can deliver a faster response once the resource is requested in the future."
199 reference: '[http://www.w3.org/TR/resource-hints/]'
201 description: "Refers to a resource that should be loaded early in the processing of the link's context, without blocking rendering."
202 reference: '[http://www.w3.org/TR/preload/]'
203 notes: 'Additional target attributes establish the detailed fetch properties of the link.'
205 description: "Used to identify a resource that might be required by the next navigation from the link context, and that the user agent ought to fetch and execute, such that the user agent can deliver a faster response once the resource is requested in the future."
206 reference: '[https://www.w3.org/TR/resource-hints/]'
208 description: "Indicates that the link's context is a part of a series, and that the previous in the series is the link target."
209 reference: '[http://www.w3.org/TR/html5/links.html#link-type-prev]'
211 description: "Refers to a resource that provides a preview of the link's context."
212 reference: '[RFC6903], section 3'
214 description: "Refers to the previous resource in an ordered series of resources. Synonym for \"prev\"."
215 reference: '[http://www.w3.org/TR/1999/REC-html401-19991224]'
217 description: 'Refers to the immediately preceding archive resource.'
218 reference: '[RFC5005]'
220 description: "Refers to a privacy policy associated with the link's context."
221 reference: '[RFC6903], section 4'
223 description: "Identifying that a resource representation conforms to a certain profile, without affecting the non-profile semantics of the resource representation."
224 reference: '[RFC6906]'
225 notes: "Profile URIs are primarily intended to be used as identifiers, and thus clients SHOULD NOT indiscriminately access profile URIs."
227 description: 'Identifies a related resource.'
228 reference: '[RFC4287]'
230 description: "Identifies a resource that is a reply to the context of the link."
231 reference: '[RFC4685]'
233 description: "Refers to a resource that can be used to search through the link's context and related resources."
234 reference: '[http://www.opensearch.org/Specifications/OpenSearch/1.1]'
236 description: 'Refers to a section in a collection of resources.'
237 reference: '[http://www.w3.org/TR/1999/REC-html401-19991224]'
239 description: "Conveys an identifier for the link's context."
240 reference: '[RFC4287]'
242 description: "Indicates a URI that can be used to set a resource as the default."
243 reference: '[RFC5023]'
245 description: "Indicates a URI that can be used to retrieve a service document."
246 reference: '[RFC5023]'
247 notes: "When used in an Atom document, this relation type specifies Atom Publishing Protocol service documents by default. Requested by James Snell."
249 description: "Refers to the first resource in a collection of resources."
250 reference: '[http://www.w3.org/TR/1999/REC-html401-19991224]'
252 description: 'Refers to a stylesheet.'
253 reference: '[http://www.w3.org/TR/html5/links.html#link-type-stylesheet]'
255 description: "Refers to a resource serving as a subsection in a collection of resources."
256 reference: '[http://www.w3.org/TR/1999/REC-html401-19991224]'
258 description: "Points to a resource containing the successor version in the version history."
259 reference: '[RFC5829]'
261 description: "Gives a tag (identified by the given address) that applies to the current document."
262 reference: '[http://www.w3.org/TR/html5/links.html#link-type-tag]'
264 description: "Refers to the terms of service associated with the link's context."
265 reference: '[RFC6903], section 5'
267 description: 'The Target IRI points to a TimeGate for an Original Resource.'
268 reference: '[RFC7089]'
269 notes: "A TimeGate for an Original Resource is a resource that is capable of datetime negotiation to support access to prior states of the Original Resource."
271 description: 'The Target IRI points to a TimeMap for an Original Resource.'
272 reference: '[RFC7089]'
273 notes: "A TimeMap for an Original Resource is a resource from which a list of URIs of Mementos of the Original Resource is available."
275 description: "Refers to a resource identifying the abstract semantic type of which the link's context is considered to be an instance."
276 reference: '[RFC6903], section 6'
278 description: "Refers to a parent document in a hierarchy of documents."
279 reference: '[RFC5988]'
280 notes: "This relation type registration did not indicate a reference. Requested by Noah Slater."
282 description: "Points to a resource containing the version history for the context."
283 reference: '[RFC5829]'
285 description: "Identifies a resource that is the source of the information in the link's context."
286 reference: '[RFC4287]'
288 description: "Identifies a target URI that supports the Webmention protcol. This allows clients that mention a resource in some form of publishing process to contact that endpoint and inform it that this resource has been mentioned."
289 reference: '[http://www.w3.org/TR/webmention/]'
290 notes: "This is a similar \"Linkback\" mechanism to the ones of Refback, Trackback, and Pingback. It uses a different protocol, though, and thus should be discoverable through its own link relation type."
292 description: 'Points to a working copy for this resource.'
293 reference: '[RFC5829]'
295 description: "Points to the versioned resource from which this working copy was obtained."
296 reference: '[RFC5829]'