Skip to content

Commit 849c574

Browse files
committed
Remove link params object and multiple link rels.
1 parent d9a964d commit 849c574

File tree

1 file changed

+4
-33
lines changed

1 file changed

+4
-33
lines changed

_format/1.1/index.md

Lines changed: 4 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -756,8 +756,6 @@ Within this object, a link **MUST** be represented as either:
756756
to the link's context. By default, the context of a link is the
757757
[top-level object][top level], [resource object][resource objects], or
758758
[relationship object][relationships] in which the link appears.
759-
* `params`: a [link parameter object][link parameters] describing additional
760-
information about the link or its target.
761759
* `describedby`: a [link] to a description document (e.g. OpenAPI or JSON
762760
Schema) for the link target.
763761
* `meta`: a meta object containing non-standard meta-information about the
@@ -787,18 +785,12 @@ document for that collection:
787785

788786
##### <a href="#document-links-link-relation-type" id="document-links-link-relation-type" class="headerlink"></a> Link relation type
789787

790-
The value of the `rel` member **MUST** be a string or an array of strings that
791-
represent link relation type(s). Valid link relation types are defined by
788+
The value of the `rel` member **MUST** be a string that represents a link relation
789+
type. Valid link relation types are defined by
792790
[RFC8288 Section 2.1](https://tools.ietf.org/html/rfc8288#section-2.1).
793791

794-
If a link is represented as a string, or the `rel` member is not given on a
795-
link object, the link's relation type **SHOULD** be inferred from the name of
796-
the link object.
797-
798-
An array of link relationship types establishes multiple links that share the
799-
same context, target, and target attributes and a client **MUST** treat these
800-
links as separate, distinct links. A client **MUST NOT** infer additional
801-
semantics for the link based on a composition of link relation types alone.
792+
If a `rel` member is not given on a link object, the link's relation type
793+
**SHOULD** be inferred from the name of the link object.
802794

803795
In order to represent a link with reversed semantics, it is **RECOMMENDED**
804796
that an alternate link relation type be used or, less preferably, that the
@@ -807,26 +799,6 @@ that an alternate link relation type be used or, less preferably, that the
807799
> Note: Historically, a `rev` link parameter was used for this purpose but has
808800
> since been deprecated by [RFC8288 Section 3.3](https://tools.ietf.org/html/rfc8288#section-3.3).
809801
810-
##### <a href="#document-links-link-parameters" id="document-links-link-parameters" class="headerlink"></a> Link parameters
811-
812-
The value of the `params` member **MUST** be an object (a “link parameter
813-
object”). Members of the link parameter object (“link parameters”) describe
814-
the [link][link] on which they are defined or its target. These link parameters
815-
are also known as [target attributes](https://tools.ietf.org/html/rfc8288#section-2.2).
816-
817-
Link parameter names **MUST** be defined by their accompanying link relation
818-
type. Additionally, parameter names **SHOULD** be valid JSON:API
819-
[member names][member names] and **MUST** be valid target attribute names as defined
820-
by [RFC8288 Section 2.2](https://tools.ietf.org/html/rfc8288#section-2.2).
821-
822-
Link parameters **MAY** contain any valid JSON value. However, parameters that
823-
have a cardinality greater than one **MUST** be represented as an array of
824-
values.
825-
826-
> Note: This means that a target attribute with multiple string values should
827-
not be represented as a single concatenated string with its values separated by
828-
whitespace as might be the case in a [`Link` header serialization](https://tools.ietf.org/html/rfc8288#section-3.5).
829-
830802
### <a href="#document-jsonapi-object" id="document-jsonapi-object" class="headerlink"></a> JSON:API Object
831803

832804
A JSON:API document **MAY** include information about its implementation
@@ -2237,7 +2209,6 @@ request as equivalent to one in which the square brackets were percent-encoded.
22372209
[link]: #document-links-link
22382210
[link object]: #document-links-link-object
22392211
[link relation type]: #document-links-link-relation-type
2240-
[link parameters]: #document-links-link-parameters
22412212
[extensions]: #extensions
22422213
[profiles]: #profiles
22432214
[error details]: #errors

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy