Skip to content

Commit cb49b67

Browse files
committed
v1.0
1 parent a41c53a commit cb49b67

File tree

10 files changed

+37
-31
lines changed

10 files changed

+37
-31
lines changed

_includes/status.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
## Status <a href="#status" id="status" class="headerlink"></a>
22

3-
**This document is a work in progress** and is in a final review phase
4-
before the specification reaches 1.0 on May 28, 2015. See the
5-
[Status](/status) page for more information.
3+
**This specification is at version {% include version.md %} and should be
4+
considered stable.** See the [Status](/status) page for more information.

_includes/version.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
1.0

_layouts/page.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,14 +25,14 @@
2525
{% for link in site.navigation %}
2626
<li {% if url == link.url %}class="active"{% endif %}><a href="{{link.url}}" title="{{link.title}}">{{link.title}}</a></li>
2727
{% endfor %}
28+
<li class="version"><div>v{% include version.md %}</div></li>
2829
</ul>
2930
</nav>
3031
{% if page.show_masthead %}
3132
<header>
3233
<div class="content">
3334
<h1>JSON API</h1>
3435
<h2>A specification for building APIs in JSON.</h2>
35-
3636
<div class="quicklinks">
3737
{% for link in site.quicklinks %}
3838
<a href="{{link.url}}" title="{{link.title}}">{{link.title}}</a>

about/index.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -58,8 +58,4 @@ The goals of the media type are to balance:
5858
* Ease of implementation on the server side
5959
* Ease of implementation on the client side
6060

61-
This media type is still a work in progress, and we are extremely open to
62-
feedback and proposals for improvement. That said, implementation work
63-
has already begun, and we value good working systems over perfect
64-
vaporware.
65-
61+
This specification reached a stable version 1.0 on May 29, 2015.

faq/index.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,15 @@ layout: page
33
title: Frequently Asked Questions
44
---
55

6-
## Why is JSON API not versioned? <a href="#why-is-json-api-not-versioned" id="why-is-json-api-not-versioned" class="headerlink"></a>
6+
## What is the meaning of JSON API's version? <a href="#what-is-the-meaning-of-json-apis-version" id="what-is-the-meaning-of-json-apis-version" class="headerlink"></a>
77

8-
Once JSON API is stable, it will always be backwards compatible using a _never
9-
remove, only add_ strategy.
10-
[#46](https://github.com/json-api/json-api/issues/46)
8+
Now that JSON API has reached a stable version 1.0, it will always be
9+
backwards compatible using a _never remove, only add_ strategy.
10+
11+
A version is maintained in order to:
12+
13+
* allow tracking of additive changes to the specification.
14+
* know what features a particular implementation *may potentially* support.
1115

1216
## Why not use the HAL specification? <a href="#why-not-use-the-hal-specification" id="why-not-use-the-hal-specification" class="headerlink"></a>
1317

index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ Official extensions are being developed for [Bulk](/extensions/bulk/) and
115115

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

118-
- _2015-05-28: 1.0 final to be released._
118+
- 2015-05-29: 1.0 final released.
119119
- 2015-05-21: Release candidate 4 released.
120120
- 2015-03-16: Release candidate 3 released.
121121
- 2015-02-18: Release candidate 2 released.

status/index.md

Lines changed: 9 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -3,20 +3,15 @@ layout: page
33
title: "JSON API: Specification Status"
44
---
55

6-
JSON API is at a fourth release candidate state.
6+
**The JSON API specification has reached version 1.0.**
77

8-
This is the final release candidate before the specification will be tagged
9-
1.0 on May 28, 2015.
8+
The [base specification](/format/) should be considered stable. It will
9+
remain backwards compatible using a _never remove, only add_ strategy.
1010

11-
In the final week before 1.0, do not expect any changes to the specified
12-
document structure. This release candidate exists solely to provide time for
13-
the specification to be carefully reviewed for inconsistencies and defects.
11+
Some work related to this specification, such as [extensions](/extensions/),
12+
is still experimental and should be considered a work in progress.
1413

15-
Libraries intended to work with 1.0 should implement this version of the
16-
specification as soon as possible.
17-
18-
Work on this specification is being done at its [GitHub
19-
repository](https://github.com/json-api/json-api). Please feel free to help
20-
flesh it out or, if you try to write an implementation, to tell us where things
21-
were ambiguous. The best way to do so is to [file an
22-
Issue](https://github.com/json-api/json-api/issues).
14+
This entire site, including the specification itself, is managed at JSON
15+
API's [GitHub repository](https://github.com/json-api/json-api). Please feel
16+
free to suggest changes or let us know if you write an implementation by filing
17+
an issue or pull request.

stylesheets/all.css

Lines changed: 5 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

stylesheets/all.css.map

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

stylesheets/all.sass

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,6 @@ $color-main: rgb(90, 90, 90)
1414
$color-masthead: rgb(235, 235, 235)
1515
$border-radius-main: 4px
1616

17-
1817
/** Mixins */
1918

2019
@mixin centerbox()
@@ -117,6 +116,13 @@ p > code, li > code
117116
a
118117
color: darken($color-main, 80%)
119118

119+
.version
120+
div
121+
background-color: lighten($color-main, 10%)
122+
color: rgb(255, 255, 255)
123+
font-weight: bold
124+
padding: 1px 6px
125+
120126

121127
/** Header */
122128

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