Skip to content

Commit

Permalink
Link relation types
Browse files Browse the repository at this point in the history
Add definitions of link relation types used in the document.

resolves #101
  • Loading branch information
cportele committed May 8, 2019
1 parent 715851e commit 679cc28
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 4 deletions.
23 changes: 22 additions & 1 deletion core/standard/clause_5_conventions.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,28 @@ Resources are modeled as UML interfaces.

=== Link relations

To express relationships between resources, <<rfc8288,RFC 8288 (Web Linking)>> and <<link-relations,registered link relation types>> are used.
To express relationships between resources, <<rfc8288,RFC 8288 (Web Linking)>> is used.

The following <<link-relations,registered link relation types>> are used in this document:

* **alternate**: Refers to a substitute for this context.
* **collection**: The target IRI points to a resource which represents the collection resource for the context IRI.
* **describedBy**: Refers to a resource providing information about the link's context.
* **item**: The target IRI points to a resource that is a member of the collection represented by the context IRI.
* **next**: Indicates that the link's context is a part of a series, and that the next in the series is the link target.
* **license**: Refers to a license associated with this context.
* **prev**: Indicates that the link's context is a part of a series, and that the previous in the series is the link target.
** This relation is only used in examples.
* **self**: Conveys an identifier for the link's context.
* **service**: Indicates a URI that can be used to retrieve a service document.
** API definitions are considered "service documents".

In addition the following link relation types are used for which no applicable
registered link relation type could be identified:

* **items**: Refers to a resource that is comprised of members of the collection represented by the link's context.
* **conformance**: Refers to a resource that lists the specifications that the link's context conforms to.
* **data**: Indicates that the link's context is a distribution of a dataset that is an API and refers to a root resource of the dataset in the API.

=== Use of HTTPS

Expand Down
6 changes: 3 additions & 3 deletions core/xml/examples/LandingPage.xml
Original file line number Diff line number Diff line change
Expand Up @@ -38,15 +38,15 @@
type="text/html"
title="Conformance Declaration as HTML"
href="http://www.acme.com/3.0/wfs/conformance?f=text%2Fhtml"/>
<atom:link rel="collections"
<atom:link rel="data"
type="application/json"
title="Collections Metadata as JSON"
href="http://www.acme.com/3.0/wfs/collections?f=application%2Fjson"/>
<atom:link rel="collections"
<atom:link rel="data"
type="application/xml"
title="Collections Metadata as XML"
href="http://www.acme.com/3.0/wfs/collections?f=application%2Fxml"/>
<atom:link rel="collections"
<atom:link rel="data"
type="text/html"
title="Collections Metadata as HTML"
href="http://www.acme.com/3.0/wfs/collections?f=text%2Fhtml"/>
Expand Down

0 comments on commit 679cc28

Please sign in to comment.