www.aleph1.co.uk Git - yaffs-website/blob - web/core/core.link_relation_types.yml

   1 # Drupal core's extension relation types.
   2 # See https://tools.ietf.org/html/rfc5988#section-4.2.
   3 add-form:
   4   uri: https://drupal.org/link-relations/add-form
   5   description: A form where a resource of this type can be created.
   6 add-page:
   7   uri: https://drupal.org/link-relations/add-page
   8   description: A page where a resource of this type and related types can be created.
   9 delete-form:
  10   uri: https://drupal.org/link-relations/delete-form
  11   description: A form where a resource of this type can be deleted.
  12 revision:
  13   uri: https://drupal.org/link-relations/revision
  14   description: A particular version of this resource.
  15 create:
  16   uri: https://drupal.org/link-relations/create
  17   description: A REST resource URL where a resource of this type can be created.
  18 enable:
  19   uri: https://drupal.org/link-relations/enable
  20   description: A REST resource URL where a resource of this type can be enabled.
  21 disable:
  22   uri: https://drupal.org/link-relations/disable
  23   description: A REST resource URL where a resource of this type can be disabled.
  24 edit-permissions-form:
  25   uri: https://drupal.org/link-relations/edit-permissions-form
  26   description: A form where permissions assigned to a resource of this type can be edited.
  27 overview-form:
  28   uri: https://drupal.org/link-relations/overview-form
  29   description: A form where an overview of the collection of resources belonging to a resource of this type can be edited in bulk.
  30 reset-form:
  31   uri: https://drupal.org/link-relations/reset-form
  32   description: A form where an overview of the collection of resources belonging to a resource of this type can be reset.
  33 cancel-form:
  34   uri: https://drupal.org/link-relations/cancel-form
  35   description: A form where a resource of this type can be canceled.
  36 flush-form:
  37   uri: https://drupal.org/link-relations/flush-form
  38   description: A form where a resource of this type can be flushed.
  39 duplicate-form:
  40   uri: https://drupal.org/link-relations/duplicate-form
  41   description: A form where a resource of this type can be duplicated.
  42
  43 # All registered relation types.
  44 # See https://tools.ietf.org/html/rfc5988#section-4.1.
  45 # See https://www.iana.org/assignments/link-relations/link-relations.xhtml.
  46 about:
  47   description: "Refers to a resource that is the subject of the link's context."
  48   reference: '[RFC6903], section 2'
  49 alternate:
  50   description: 'Refers to a substitute for this context'
  51   reference: '[http://www.w3.org/TR/html5/links.html#link-type-alternate]'
  52 appendix:
  53   description: 'Refers to an appendix.'
  54   reference: '[http://www.w3.org/TR/1999/REC-html401-19991224]'
  55 archives:
  56   description: "Refers to a collection of records, documents, or other materials of historical interest."
  57   reference: '[http://www.w3.org/TR/2011/WD-html5-20110113/links.html#rel-archives]'
  58 author:
  59   description: "Refers to the context's author."
  60   reference: '[http://www.w3.org/TR/html5/links.html#link-type-author]'
  61 blocked-by:
  62   description: "Identifies the entity that blocks access to a resource following receipt of a legal demand."
  63   reference: '[RFC7725]'
  64 bookmark:
  65   description: 'Gives a permanent link to use for bookmarking purposes.'
  66   reference: '[http://www.w3.org/TR/html5/links.html#link-type-bookmark]'
  67 canonical:
  68   description: 'Designates the preferred version of a resource (the IRI and its contents).'
  69   reference: '[RFC6596]'
  70 chapter:
  71   description: 'Refers to a chapter in a collection of resources.'
  72   reference: '[http://www.w3.org/TR/1999/REC-html401-19991224]'
  73 collection:
  74   description: 'The target IRI points to a resource which represents the collection resource for the context IRI.'
  75   reference: '[RFC6573]'
  76 contents:
  77   description: 'Refers to a table of contents.'
  78   reference: '[http://www.w3.org/TR/1999/REC-html401-19991224]'
  79 copyright:
  80   description: "Refers to a copyright statement that applies to the link's context."
  81   reference: '[http://www.w3.org/TR/1999/REC-html401-19991224]'
  82 create-form:
  83   description: 'The target IRI points to a resource where a submission form can be obtained.'
  84   reference: '[RFC6861]'
  85 current:
  86   description: "Refers to a resource containing the most recent item(s) in a collection of resources."
  87   reference: '[RFC5005]'
  88 customize-form:
  89   description: "The target URI points to a resource where a submission form for customizing associated resource can be obtained."
  90   reference: '[RFC6861]'
  91 derivedfrom:
  92   description: 'The target IRI points to a resource from which this material was derived.'
  93   reference: '[draft-hoffman-xml2rfc]'
  94 describedby:
  95   description: "Refers to a resource providing information about the link's context."
  96   reference: '[http://www.w3.org/TR/powder-dr/#assoc-linking]'
  97 describes:
  98   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."
  99   reference: '[RFC6892]'
 100   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."
 101 disclosure:
 102   description: "Refers to a list of patent disclosures made with respect to  material for which 'disclosure' relation is specified."
 103   reference: '[RFC6579]'
 104 dns-prefetch:
 105   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."
 106   reference: '[https://www.w3.org/TR/resource-hints/]'
 107 duplicate:
 108   description: "Refers to a resource whose available representations are byte-for-byte identical with the corresponding representations of the context IRI."
 109   reference: '[RFC6249]'
 110   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."
 111 edit:
 112   description: "Refers to a resource that can be used to edit the link's context."
 113   reference: '[RFC5023]'
 114 edit-form:
 115   description: "The target IRI points to a resource where a submission form for editing associated resource can be obtained."
 116   reference: '[RFC6861]'
 117 edit-media:
 118   description: "Refers to a resource that can be used to edit media associated with the link's context."
 119   reference: '[RFC5023]'
 120 enclosure:
 121   description: "Identifies a related resource that is potentially large and might require special handling."
 122   reference: '[RFC4287]'
 123 first:
 124   description: "An IRI that refers to the furthest preceding resource in a series of resources."
 125   reference: '[RFC5988]'
 126   notes: "This relation type registration did not indicate a reference.  Originally requested by Mark Nottingham in December 2004."
 127 glossary:
 128   description: 'Refers to a glossary of terms.'
 129   reference: '[http://www.w3.org/TR/1999/REC-html401-19991224]'
 130 help:
 131   description: 'Refers to context-sensitive help.'
 132   reference: '[http://www.w3.org/TR/html5/links.html#link-type-help]'
 133 hosts:
 134   description: "Refers to a resource hosted by the server indicated by the link context."
 135   reference: '[RFC6690]'
 136   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."
 137 hub:
 138   description: "Refers to a hub that enables registration for notification of updates to the context."
 139   reference: '[http://pubsubhubbub.googlecode.com]'
 140   notes: 'This relation type was requested by Brett Slatkin.'
 141 icon:
 142   description: "Refers to an icon representing the link's context."
 143   reference: '[http://www.w3.org/TR/html5/links.html#link-type-icon]'
 144 index:
 145   description: 'Refers to an index.'
 146   reference: '[http://www.w3.org/TR/1999/REC-html401-19991224]'
 147 item:
 148   description: 'The target IRI points to a resource that is a member of the collection represented by the context IRI.'
 149   reference: '[RFC6573]'
 150 last:
 151   description: "An IRI that refers to the furthest following resource in a series of resources."
 152   reference: '[RFC5988]'
 153   notes: "This relation type registration did not indicate a reference. Originally requested by Mark Nottingham in December 2004."
 154 latest-version:
 155   description: "Points to a resource containing the latest (e.g., current) version of the context."
 156   reference: '[RFC5829]'
 157 license:
 158   description: 'Refers to a license associated with this context.'
 159   reference: '[RFC4946]'
 160   notes: "For implications of use in HTML, see:  http://www.w3.org/TR/html5/links.html#link-type-license"
 161 lrdd:
 162   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."
 163   reference: '[RFC6415]'
 164 memento:
 165   description: 'The Target IRI points to a Memento, a fixed resource that will not change state anymore.'
 166   reference: '[RFC7089]'
 167   notes: "A Memento for an Original Resource is a resource that encapsulates a prior state of the Original Resource."
 168 monitor:
 169   description: 'Refers to a resource that can be used to monitor changes in an HTTP resource.'
 170   reference: '[RFC5989]'
 171 monitor-group:
 172   description: 'Refers to a resource that can be used to monitor changes in a specified group of HTTP resources.'
 173   reference: '[RFC5989]'
 174 next:
 175   description: "Indicates that the link's context is a part of a series, and that the next in the series is the link target."
 176   reference: '[http://www.w3.org/TR/html5/links.html#link-type-next]'
 177 next-archive:
 178   description: 'Refers to the immediately following archive resource.'
 179   reference: '[RFC5005]'
 180 nofollow:
 181   description: 'Indicates that the context’s original author or publisher does not endorse the link target.'
 182   reference: '[http://www.w3.org/TR/html5/links.html#link-type-nofollow]'
 183 noreferrer:
 184   description: 'Indicates that no referrer information is to be leaked when following the link.'
 185   reference: '[http://www.w3.org/TR/html5/links.html#link-type-noreferrer]'
 186 original:
 187   description: 'The Target IRI points to an Original Resource.'
 188   reference: '[RFC7089]'
 189   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."
 190 payment:
 191   description: 'Indicates a resource where payment is accepted.'
 192   reference: '[RFC5988]'
 193   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."
 194 pingback:
 195   description: 'Gives the address of the pingback resource for the link context.'
 196   reference: '[http://www.hixie.ch/specs/pingback/pingback]'
 197 preconnect:
 198   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."
 199   reference: '[https://www.w3.org/TR/resource-hints/]'
 200 predecessor-version:
 201   description: "Points to a resource containing the predecessor version in the version history."
 202   reference: '[RFC5829]'
 203 prefetch:
 204   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."
 205   reference: '[http://www.w3.org/TR/resource-hints/]'
 206 preload:
 207   description: "Refers to a resource that should be loaded early in the  processing of the link's context, without blocking rendering."
 208   reference: '[http://www.w3.org/TR/preload/]'
 209   notes: 'Additional target attributes establish the detailed fetch properties of the link.'
 210 prerender:
 211   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."
 212   reference: '[https://www.w3.org/TR/resource-hints/]'
 213 prev:
 214   description: "Indicates that the link's context is a part of a series, and that the previous in the series is the link target."
 215   reference: '[http://www.w3.org/TR/html5/links.html#link-type-prev]'
 216 preview:
 217   description: "Refers to a resource that provides a preview of the link's context."
 218   reference: '[RFC6903], section 3'
 219 previous:
 220   description: "Refers to the previous resource in an ordered series of resources.  Synonym for \"prev\"."
 221   reference: '[http://www.w3.org/TR/1999/REC-html401-19991224]'
 222 prev-archive:
 223   description: 'Refers to the immediately preceding archive resource.'
 224   reference: '[RFC5005]'
 225 privacy-policy:
 226   description: "Refers to a privacy policy associated with the link's context."
 227   reference: '[RFC6903], section 4'
 228 profile:
 229   description: "Identifying that a resource representation conforms to a certain profile, without affecting the non-profile semantics of the resource representation."
 230   reference: '[RFC6906]'
 231   notes: "Profile URIs are primarily intended to be used as identifiers, and thus clients SHOULD NOT indiscriminately access profile URIs."
 232 related:
 233   description: 'Identifies a related resource.'
 234   reference: '[RFC4287]'
 235 replies:
 236   description: "Identifies a resource that is a reply to the context of the link."
 237   reference: '[RFC4685]'
 238 search:
 239   description: "Refers to a resource that can be used to search through the link's context and related resources."
 240   reference: '[http://www.opensearch.org/Specifications/OpenSearch/1.1]'
 241 section:
 242   description: 'Refers to a section in a collection of resources.'
 243   reference: '[http://www.w3.org/TR/1999/REC-html401-19991224]'
 244 self:
 245   description: "Conveys an identifier for the link's context."
 246   reference: '[RFC4287]'
 247 set-default:
 248   description: "Indicates a URI that can be used to set a resource as the default."
 249   reference: '[RFC5023]'
 250 service:
 251   description: "Indicates a URI that can be used to retrieve a service document."
 252   reference: '[RFC5023]'
 253   notes: "When used in an Atom document, this relation type specifies Atom Publishing Protocol service documents by default.  Requested by James Snell."
 254 start:
 255   description: "Refers to the first resource in a collection of resources."
 256   reference: '[http://www.w3.org/TR/1999/REC-html401-19991224]'
 257 stylesheet:
 258   description: 'Refers to a stylesheet.'
 259   reference: '[http://www.w3.org/TR/html5/links.html#link-type-stylesheet]'
 260 subsection:
 261   description: "Refers to a resource serving as a subsection in a collection of resources."
 262   reference: '[http://www.w3.org/TR/1999/REC-html401-19991224]'
 263 successor-version:
 264   description: "Points to a resource containing the successor version in the version history."
 265   reference: '[RFC5829]'
 266 tag:
 267   description: "Gives a tag (identified by the given address) that applies to the current document."
 268   reference: '[http://www.w3.org/TR/html5/links.html#link-type-tag]'
 269 terms-of-service:
 270   description: "Refers to the terms of service associated with the link's context."
 271   reference: '[RFC6903], section 5'
 272 timegate:
 273   description: 'The Target IRI points to a TimeGate for an Original Resource.'
 274   reference: '[RFC7089]'
 275   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."
 276 timemap:
 277   description: 'The Target IRI points to a TimeMap for an Original Resource.'
 278   reference: '[RFC7089]'
 279   notes: "A TimeMap for an Original Resource is a resource from which a list of URIs of Mementos of the Original Resource is available."
 280 type:
 281   description: "Refers to a resource identifying the abstract semantic type of which the link's context is considered to be an instance."
 282   reference: '[RFC6903], section 6'
 283 up:
 284   description: "Refers to a parent document in a hierarchy of documents."
 285   reference: '[RFC5988]'
 286   notes: "This relation type registration did not indicate a reference.  Requested by Noah Slater."
 287 version-history:
 288   description: "Points to a resource containing the version history for the context."
 289   reference: '[RFC5829]'
 290 via:
 291   description: "Identifies a resource that is the source of the information in the link's context."
 292   reference: '[RFC4287]'
 293 webmention:
 294   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."
 295   reference: '[http://www.w3.org/TR/webmention/]'
 296   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."
 297 working-copy:
 298   description: 'Points to a working copy for this resource.'
 299   reference: '[RFC5829]'
 300 working-copy-of:
 301   description: "Points to the versioned resource from which this working copy was obtained."
 302   reference: '[RFC5829]'