MUST meet all of the following conditions: When an extension defines new query parameters or document members, theĮxtension MUST define a namespace to guarantee that extensions will neverĬonflict with current or future versions of this specification. The rules for extension member names are coveredĪn extension MAY define new query parameters. Object member requirements defined in this specification or other extensions.Īn extension MAY define new members within the document structure defined by Rules for ExtensionsĪn extension MAY impose additional processing rules or further restrictionsĪnd it MAY define new object members as described below.Īn extension MUST NOT lessen or remove any processing rules, restrictions or Specification requires that parameter values be surrounded by quotation marks ![]() Note: When serializing the ext or profile media type parameters, the HTTP (U+0020 SPACE, “ “) list of extension or profile URIs, respectively. Values of the ext and profile parameters MUST equal a space-separated Profile’s URI SHOULD return documentation that describes its usage. ![]() The ext parameter is used to supportĮxtensions and the profile parameter is used to support profiles.Įxtensions and profiles are each uniquely identified by a The JSON:API media type MUST NOT be specified with any media type parameters Profiles can specify implementation semantics, but cannot alter,Īdd to, or remove specification semantics. Profiles provide a means to share a particular usage of the specification among For example, in the headerĬontent-Type: text/html charset="utf-8", the media type is text/html andĮxtensions provide a means to “extend” the base specification by definingĮxtensions cannot alter or remove specification semantics, nor can they specify Note: A media type parameter is an extra piece of information that canĪccompany a media type. Profile, which are used to specify extensions and profiles, respectively. The JSON:API specification supports two media type parameters: ext and ![]() The JSON:API Media TypeĪpplication/vnd.api+json. When, and only when, they appear in all capitals, as shown here. “SHOULD NOT”, “RECOMMENDED”, “NOT RECOMMENDED”, “MAY”, and “OPTIONAL” in thisĭocument are to be interpreted as described in The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, These are called “implementationĪll other semantics are reserved for potential future use by this specification. This specification are collectively called “specification semantics”.Ĭertain document members, query parameters, and processing rules are reservedįor implementors to define at their discretion. JSON:API requires use of the JSON:API media typeĪll document members, query parameters, and processing rules defined by Without compromising readability, flexibility, or discoverability. JSON:API is designed to minimize both the number of requests and the amount ofĭata transmitted between clients and servers. JSON:APIĬan be easily extended with extensions and profiles. JSON:API is a specification for how a client should request that resources beįetched or modified, and how a server should respond to those requests. Implementation, please let us know by opening an issue or pull request at our If you catch an error in the specification’s text, or if you write an ![]() New versions of JSON:API willĪlways be backwards compatible using a never remove, only add strategy.Īdditions can be proposed in our discussion forum. This page presents the latest published version of JSON:API, which isĬurrently version 1.1.
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |