Skip to content

Commit 5cead11

Browse files
committed
Use JSON:API instead of JSON API on the website
1 parent 6c5d9ad commit 5cead11

File tree

8 files changed

+136
-136
lines changed

8 files changed

+136
-136
lines changed

_layouts/page.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
{% else %}
2121
{% assign page_title = page.title %}
2222
{% endif %}
23-
<title>JSON API &mdash; {{page_title|strip }}</title>
23+
<title>JSON:API &mdash; {{page_title|strip }}</title>
2424

2525
<link href="/stylesheets/normalize.css" rel="stylesheet" type="text/css" />
2626
<link href="/stylesheets/all.css" rel="stylesheet" type="text/css" />
@@ -70,7 +70,7 @@
7070
{% if page.show_masthead %}
7171
<header>
7272
<div class="content">
73-
<h1>JSON API</h1>
73+
<h1>JSON:API</h1>
7474
<h2>A specification for building APIs in JSON</h2>
7575
<div class="quicklinks">
7676
{% for link in site.quicklinks %}

about/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ title: About
55

66
## <a href="#channels" id="channels" class="headerlink"></a> Channels
77

8-
JSON API is:
8+
JSON:API is:
99

1010
* [@jsonapi](http://twitter.com/jsonapi) on
1111
[Twitter](http://twitter.com)
@@ -31,7 +31,7 @@ There are five primary editors of this specification:
3131

3232
## <a href="#history" id="history" class="headerlink"></a> History
3333

34-
JSON API was originally drafted by [Yehuda Katz](http://twitter.com/wycats)
34+
JSON:API was originally drafted by [Yehuda Katz](http://twitter.com/wycats)
3535
in May 2013. This first draft was extracted from the JSON transport
3636
implicitly defined by [Ember](http://emberjs.com/) Data's REST adapter.
3737

examples/index.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Content-Type: application/vnd.api+json
2525
"type": "articles",
2626
"id": "1",
2727
"attributes": {
28-
"title": "JSON API paints my bikeshed!",
28+
"title": "JSON:API paints my bikeshed!",
2929
"body": "The shortest article. Ever.",
3030
"created": "2015-05-22T14:56:29.000Z",
3131
"updated": "2015-05-22T14:56:28.000Z"
@@ -71,7 +71,7 @@ Content-Type: application/vnd.api+json
7171
"type": "articles",
7272
"id": "1",
7373
"attributes": {
74-
"title": "JSON API paints my bikeshed!",
74+
"title": "JSON:API paints my bikeshed!",
7575
"body": "The shortest article. Ever."
7676
},
7777
"relationships": {
@@ -107,7 +107,7 @@ Content-Type: application/vnd.api+json
107107
"type": "articles",
108108
"id": "1",
109109
"attributes": {
110-
"title": "JSON API paints my bikeshed!",
110+
"title": "JSON:API paints my bikeshed!",
111111
"body": "The shortest article. Ever."
112112
}
113113
}],
@@ -150,7 +150,7 @@ Content-Type: application/vnd.api+json
150150
"type": "articles",
151151
"id": "3",
152152
"attributes": {
153-
"title": "JSON API paints my bikeshed!",
153+
"title": "JSON:API paints my bikeshed!",
154154
"body": "The shortest article. Ever.",
155155
"created": "2015-05-22T14:56:29.000Z",
156156
"updated": "2015-05-22T14:56:28.000Z"
@@ -216,7 +216,7 @@ The `status` member represents the HTTP status code associated with the problem.
216216
It's very helpful when multiple errors are returned at once (see below), as the
217217
HTTP response itself can only have one status code. However, it can also be
218218
useful for single errors, to save clients the trouble of consulting the HTTP
219-
headers, or for using JSON API over non-HTTP protocols, which may be officially
219+
headers, or for using JSON:API over non-HTTP protocols, which may be officially
220220
supported in the near future.
221221

222222
### <a href="#error-objects-multiple-errors" id="error-objects-multiple-errors" class="headerlink"></a> Multiple Errors
@@ -276,7 +276,7 @@ Content-Type: application/vnd.api+json
276276

277277
> Note: in the responses above with a 422 status code, `400 Bad Request` would
278278
also be acceptable. ([More details.](http://stackoverflow.com/a/20215807/1261879))
279-
JSON API doesn't take a position on 400 vs. 422.
279+
JSON:API doesn't take a position on 400 vs. 422.
280280

281281
### <a href="#error-objects-error-codes" id="error-objects-error-codes" class="headerlink"></a> Error Codes
282282

@@ -329,14 +329,14 @@ Content-Type: application/vnd.api+json
329329
Notice that this response includes not only the `errors` top-level member,
330330
but the `jsonapi` top-level member. Error responses may not contain the
331331
top-level `data` member, but can include all the other top-level members
332-
JSON API defines.
332+
JSON:API defines.
333333

334334
Also, notice that the third error object lacks a `detail` member (perhaps
335335
for security). Again, all error object members are optional.
336336

337337
### <a href="#error-objects-source-usage" id="error-objects-source-usage" class="headerlink"></a> Advanced `source` Usage
338338

339-
In the example below, the user is sending an invalid JSON API
339+
In the example below, the user is sending an invalid JSON:API
340340
request, because it's missing the `data` member:
341341

342342
```http
@@ -407,9 +407,9 @@ Content-Type: application/vnd.api+json
407407
}
408408
```
409409

410-
In most cases, JSON API requires the server to return an error when it encounters
411-
an invalid value for a JSON API–defined query parameter. However, for API-specific
412-
query parameters (i.e. those not defined by JSON API), a server may choose to
410+
In most cases, JSON:API requires the server to return an error when it encounters
411+
an invalid value for a JSON:API–defined query parameter. However, for API-specific
412+
query parameters (i.e. those not defined by JSON:API), a server may choose to
413413
ignore an invalid parameter and have the request succeed, rather than respond with
414414
an error. [API-specific query parameters must contain one non a-z
415415
character.](http://jsonapi.org/format/#query-parameters)

extensions/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,11 @@ show_sidebar: true
88

99
**An extension system is currently under development,** and you can view the
1010
latest work [here](https://github.com/json-api/json-api/tree/profile-extensions).
11-
There is no official support for extensions in the base JSON API specification.
11+
There is no official support for extensions in the base JSON:API specification.
1212

1313
## <a href="#prior-extensions" id="prior-extensions" class="headerlink"></a> Prior Extensions
1414

15-
JSON API previously offered experimental support for a different extension
15+
JSON:API previously offered experimental support for a different extension
1616
negotiation system than the one now being discussed, and it provided a number of
1717
extensions for use with that old negotiation system. However, this system was
1818
always experimental and has now been deprecated.

faq/index.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@ title: Frequently Asked Questions
44
show_sidebar: true
55
---
66

7-
## <a href="#what-is-the-meaning-of-json-apis-version" id="what-is-the-meaning-of-json-apis-version" class="headerlink"></a> What is the meaning of JSON API's version?
7+
## <a href="#what-is-the-meaning-of-json-apis-version" id="what-is-the-meaning-of-json-apis-version" class="headerlink"></a> What is the meaning of JSON:API's version?
88

9-
Now that JSON API has reached a stable version 1.0, it will always be
9+
Now that JSON:API has reached a stable version 1.0, it will always be
1010
backwards compatible using a _never remove, only add_ strategy.
1111

1212
A version is maintained in order to:
@@ -18,22 +18,22 @@ A version is maintained in order to:
1818

1919
There are several reasons:
2020

21-
* HAL embeds child documents recursively, while JSON API flattens the entire
21+
* HAL embeds child documents recursively, while JSON:API flattens the entire
2222
graph of objects at the top level. This means that if the same "people" are
2323
referenced from different kinds of objects (say, the author of both posts and
2424
comments), this format ensures that there is only a single representation of
2525
each person document in the payload.
26-
* Similarly, JSON API uses IDs for linkage, which makes it possible to cache
26+
* Similarly, JSON:API uses IDs for linkage, which makes it possible to cache
2727
documents from compound responses and then limit subsequent requests to only
2828
the documents that aren't already present locally. If you're lucky, this can
2929
even completely eliminate HTTP requests.
3030
* HAL is a serialization format, but says nothing about how to update
31-
documents. JSON API thinks through how to update existing records (leaning on
31+
documents. JSON:API thinks through how to update existing records (leaning on
3232
PATCH and JSON Patch), and how those updates interact with compound documents
3333
returned from GET requests. It also describes how to create and delete
3434
documents, and what 200 and 204 responses from those updates mean.
3535

36-
In short, JSON API is an attempt to formalize similar ad hoc client-server
36+
In short, JSON:API is an attempt to formalize similar ad hoc client-server
3737
interfaces that use JSON as an interchange format. It is specifically focused
3838
around using those APIs with a smart client that knows how to cache documents it
3939
has already seen and avoid asking for them again.
@@ -54,7 +54,7 @@ For instance, a client might request `HEAD /articles`, and the response could
5454
contain the header `Allow: GET,POST`, indicating that the client can GET the
5555
collection and also POST to it to create new resources.
5656

57-
JSON API is still working on a way to for resources to advertise and detail
57+
JSON:API is still working on a way to for resources to advertise and detail
5858
non-standard actions they support. Feel free to
5959
[join that discussion](https://github.com/json-api/json-api/issues/745)!
6060

@@ -71,15 +71,15 @@ Instead, PUT is supposed to completely replace the state of a resource:
7171
target resource will result in an equivalent representation being sent…”
7272

7373
The correct method for partial updates, therefore, is [PATCH](http://tools.ietf.org/html/rfc5789),
74-
which is what JSON API uses. And because PATCH can also be used compliantly for
75-
full resource replacement, JSON API hasn't needed to define any behavior for
74+
which is what JSON:API uses. And because PATCH can also be used compliantly for
75+
full resource replacement, JSON:API hasn't needed to define any behavior for
7676
PUT so far. However, it may define PUT semantics in the future.
7777

7878
In the past, many APIs used PUT for partial updates because PATCH wasn’t yet
7979
well-supported. However, almost all clients now support PATCH, and those that
8080
don’t can be easily [worked around](/recommendations/#patchless-clients).
8181

82-
## <a href="#is-there-a-json-schema-describing-json-api" id="is-there-a-json-schema-describing-json-api" class="headerlink"></a> Is there a JSON Schema describing JSON API?
82+
## <a href="#is-there-a-json-schema-describing-json-api" id="is-there-a-json-schema-describing-json-api" class="headerlink"></a> Is there a JSON Schema describing JSON:API?
8383

8484
Yes, you can find the JSON Schema definition at
8585
[http://jsonapi.org/schema](http://jsonapi.org/schema). This schema is as
@@ -104,6 +104,6 @@ than type because it's possible that a primary resource may have related
104104
resources of the same type (e.g. the "parents" of a "person"). Nesting related
105105
resources in `included` prevents this possible conflict.
106106

107-
## <a href="#position-uri-structure-custom-endpoints" id="position-uri-structure-custom-endpoints" class="headerlink"></a> Does JSON API take any position on URI structure, on rules for custom endpoints, which do not fit the paradigm of GET/POST/PATCH/DELETE on the resource URI, etc.?
107+
## <a href="#position-uri-structure-custom-endpoints" id="position-uri-structure-custom-endpoints" class="headerlink"></a> Does JSON:API take any position on URI structure, on rules for custom endpoints, which do not fit the paradigm of GET/POST/PATCH/DELETE on the resource URI, etc.?
108108

109-
JSON API has no requirements about URI structure, implementations are free to use whatever form they wish.
109+
JSON:API has no requirements about URI structure, implementations are free to use whatever form they wish.

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