8000 Finalize v1.1 by dgeb · Pull Request #1669 · json-api/json-api · GitHub
[go: up one dir, main page]
Skip to content

Finalize v1.1 #1669

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Sep 30, 2022
Merged

Finalize v1.1 #1669

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
81c365b
Finalize v1.1
dgeb Sep 29, 2022
81c3dd9
Add v1.2 draft
dgeb Sep 29, 2022
3eccc4f
Add milestones to home page, move full history to /about
dgeb Sep 29, 2022
c0a0d73
Update /extensions to reflect 1.1 final
dgeb Sep 29, 2022
aecfcff
Improve pitch on home page
dgeb Sep 29, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Add milestones to home page, move full history to /about
  • Loading branch information
@dgeb
dgeb committed Sep 29, 2022
commit 3eccc4f12653dea93a357a1d696ba020f428ce27
48 changes: 41 additions & 7 deletions about/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,13 +27,6 @@ The following emeritus editors are no longer active:
- [Steve Klabnik](https://twitter.com/steveklabnik)
- [Ethan Resnick](https://twitter.com/ethanresnick)

## <a href="#roadmap" id="roadmap" class="headerlink"></a> Roadmap

### <a href="#roadmap-1-1" id="roadmap-1-1" class="headerlink"></a> 1.1

* Embedding / creating multiple related resources in a single request
* Extension support

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

JSON:API was originally drafted by [Yehuda Katz](https://twitter.com/wycats)
Expand Down Expand Up @@ -72,3 +65,44 @@ The goals of the media type are to balance:
* Ease of implementation on the client side

This specification reached a stable version 1.0 on May 29, 2015.

### <a href="#update-history" id="update-history" class="headerlink"></a> Update history

- 2022-09-30: 1.1 final released.
- 2022-08-22: 1.1 Release candidate 4 released.
- Formalized the definition of specification and implementation
[semantics](https://jsonapi.org/format/1.1/#semantics).
- Refined the definitions of
[extensions](https://jsonapi.org/format/1.1/#extensions) and
[profiles](https://jsonapi.org/format/1.1/#profiles).
- Clarified details regarding expected and allowed responses, query
parameters, and more.
- 2020-10-01: 1.1 Release candidate 3 released.
- Refined links objects. The link object `params` member was removed to
better align with other JSON link serializations. The `anchor` target
attribute was also removed. It may be restored in a future minor release.
- 2020-08-20: 1.1 Release candidate 2 released.
- [Extensions](https://jsonapi.org/format/1.1/#extensions) were added and the
scope of [profiles](https://jsonapi.org/format/1.1/#profiles) were reduced
since their introduction in RC1.
- [Links](https://github.com/json-api/json-api/pull/1348) can be represented
as [RFC 8288](https://tools.ietf.org/html/rfc8288)-style web links.
- A new [`describedby`](https://github.com/json-api/json-api/pull/1447) [links member](https://jsonapi.org/format/1.1/#document-top-level)
was added so that implementors can incorporate description documents (e.g.
[OpenAPI](https://www.openapis.org/) or [JSON Schema](https://json-schema.org/specification.html))
directly into their APIs.
- [Local IDs](https://jsonapi.org/format/1.1/#document-resource-object-identification)
were [introduced](https://github.com/json-api/json-api/pull/1244) so that a
client can create a relationship to a resource yet-to-be created by the
same request.
- 2018-12-01: 1.1 Release candidate 1 released.
- New features include: [profiles](https://jsonapi.org/format/1.1/#profiles), ["@-Members"](https://jsonapi.org/format/1.1/#document-member-names-at-members), and [error object `type` links](https://jsonapi.org/format/1.1/#error-objects).
- There are editorial clarifications around: [query parameters](https://jsonapi.org/format/1.1/#query-parameters) (their parsing/serialization, and reserved parameter names), the appropriate status code for [specific](https://github.com/json-api/json-api/pull/1036) [responses](https://github.com/json-api/json-api/pull/1029), and the [presence of the `included` key](https://github.com/json-api/json-api/pull/1236) even when its value is an empty array.
- JSON:API switched to [recommending camelCased names](https://jsonapi.org/recommendations/#naming).
- 2015-05-29: 1.0 final released.
- 2015-05-21: 1.0 Release candidate 4 released.
- 2015-03-16: 1.0 Release candidate 3 released.
- 2015-02-18: 1.0 Release candidate 2 released.
- 2014-07-05: 1.0 Release candidate 1 released.
- 2013-07-21: Media type registration completed with the IANA.
- 2013-05-03: Initial release of the draft.
44 changes: 7 additions & 37 deletions index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,45 +123,15 @@ base JSON:API specification. These extensions are called profiles.
You can [browse existing profiles](/extensions/#existing-profiles) or
[create a new one](/extensions/#profile-creation).

## <a href="#update-history" id="update-history" class="headerlink"></a> Update history

- 2022-09-30: Expected final release of 1.1.
- 2022-08-22: 1.1 Release candidate 4 released.
- Formalized the definition of specification and implementation
[semantics](https://jsonapi.org/format/1.1/#semantics).
- Refined the definitions of
[extensions](https://jsonapi.org/format/1.1/#extensions) and
[profiles](https://jsonapi.org/format/1.1/#profiles).
- Clarified details regarding expected and allowed responses, query
parameters, and more.
- 2020-10-01: 1.1 Release candidate 3 released.
- Refined links objects. The link object `params` member was removed to
better align with other JSON link serializations. The `anchor` target
attribute was also removed. It may be restored in a future minor release.
- 2020-08-20: 1.1 Release candidate 2 released.
- [Extensions](https://jsonapi.org/format/1.1/#extensions) were added and the
scope of [profiles](https://jsonapi.org/format/1.1/#profiles) were reduced
since their introduction in RC1.
- [Links](https://github.com/json-api/json-api/pull/1348) can be represented
as [RFC 8288](https://tools.ietf.org/html/rfc8288)-style web links.
- A new [`describedby`](https://github.com/json-api/json-api/pull/1447) [links member](https://jsonapi.org/format/1.1/#document-top-level)
was added so that implementors can incorporate description documents (e.g.
[OpenAPI](https://www.openapis.org/) or [JSON Schema](https://json-schema.org/specification.html))
directly into their APIs.
- [Local IDs](https://jsonapi.org/format/1.1/#document-resource-object-identification)
were [introduced](https://github.com/json-api/json-api/pull/1244) so that a
client can create a relationship to a resource yet-to-be created by the
same request.
- 2018-12-01: 1.1 Release candidate 1 released.
- New features include: [profiles](https://jsonapi.org/format/1.1/#profiles), ["@-Members"](https://jsonapi.org/format/1.1/#document-member-names-at-members), and [error object `type` links](https://jsonapi.org/format/1.1/#error-objects).
- There are editorial clarifications around: [query parameters](https://jsonapi.org/format/1.1/#query-parameters) (their parsing/serialization, and reserved parameter names), the appropriate status code for [specific](https://github.com/json-api/json-api/pull/1036) [responses](https://github.com/json-api/json-api/pull/1029), and the [presence of the `included` key](https://github.com/json-api/json-api/pull/1236) even when its value is an empty array.
- JSON:API switched to [recommending camelCased names](https://jsonapi.org/recommendations/#naming).
## <a href="#milestones" id="milestones" class="headerlink"></a> Milestones

Major milestones for this specification include:

- 2022-09-30: 1.1 final released.
- 2015-05-29: 1.0 final released.
- 2015-05-21: 1.0 Release candidate 4 released.
- 2015-03-16: 1.0 Release candidate 3 released.
- 2015-02-18: 1.0 Release candidate 2 released.
- 2014-07-05: 1.0 Release candidate 1 released.
- 2013-07-21: Media type registration completed with the IANA.
- 2013-05-03: Initial release of the draft.

A more thorough history is available [here](/about/#update-history).

You can subscribe to an RSS feed of individual changes [here](https://github.com/json-api/json-api/commits.atom).
0