Skip to content

Commit 4ca869c

Browse files
ethanresnickethanresnick
committed
Merge remote-tracking branch 'origin' into profile-extensions
2 parents 624b138 + 71723cf commit 4ca869c

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

42 files changed

+303
-473
lines changed

‎Gemfile

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,20 @@
1-
# If you have OpenSSL installed, we recommend updating
2-
# the following line to use "https"
3-
source 'http://rubygems.org'
1+
source "https://rubygems.org"
2+
3+
# http://jekyllrb.com/docs/github-pages/
4+
require 'json'
5+
require 'open-uri'
6+
versions =
7+
begin
8+
JSON.parse(open('https://pages.github.com/versions.json').read)
9+
rescue SocketError
10+
{ 'github-pages' => 67 }
11+
end
12+
13+
gem 'github-pages', versions['github-pages']
414

515
gem "rake", "~> 10.0"
6-
gem "jekyll", "~> 2.4.0"
7-
gem "redcarpet", "~> 3.3"
816
gem "rb-fsevent", "~> 0.9"
917
gem "compass", "~> 1.0"
1018
gem "sass", "~> 3.4"
1119
gem "launchy", "~> 2.3"
1220
gem "redcard", "~> 1.0"
13-
gem "jekyll-redirect-from", "~> 0.8.0"
14-
gem "pygments.rb", "~> 0.6.3"

‎README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,3 +34,10 @@ This standard is currently under development. To assist:
3434

3535
The website is automatically built by [GitHub Pages](http://pages.github.com)
3636
when changes are pushed to the `gh-pages` branch.
37+
38+
Archive
39+
-------
40+
41+
older versions of the JSON-API documentations
42+
43+
* RC3 - http://jsonapi-rc3.herokuapp.com/

‎_config.yml

Lines changed: 34 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,39 @@
11
url: http://jsonapi.org
2-
3-
lsi: false
42
source: .
53
destination: ./public
4+
5+
# github pages we cannot customize
6+
lsi: false
7+
whitelist:
8+
- jekyll-coffeescript
9+
- jekyll-gist
10+
- jekyll-paginate
11+
- jekyll-redirect-from
12+
- jekyll-mentions
13+
- jekyll-sitemap
14+
- jekyll-feed
15+
- jekyll-seo-tag
16+
- jekyll-gist
17+
- jemoji
18+
incremental: false
19+
highlighter: rouge
20+
gist:
21+
noscript: false
22+
# customize github pages
23+
quiet: false
24+
kramdown:
25+
input: GFM
26+
hard_wrap: false
27+
template: '' # cannot customize
28+
math_engine: mathjax # cannot customize
29+
syntax_highligher: rouge # cannot customize
30+
jailed: false
31+
gems:
32+
- jekyll-redirect-from
33+
markdown: redcarpet
34+
redcarpet:
35+
extensions: ["tables"]
36+
637
exclude:
738
- Rakefile
839
- README.md
@@ -12,10 +43,6 @@ exclude:
1243
- .gitignore
1344
- ./public
1445
- ./stylesheets/*.scss
15-
markdown: redcarpet
16-
redcarpet:
17-
extensions: ["tables"]
18-
highlighter: pygments
1946
port: 9876
2047

2148
collections:
@@ -32,15 +59,7 @@ defaults:
3259
is_spec_page: true
3360

3461
latest_version: 1.0
35-
36-
37-
# `safe `must be set false for jekyll-redirect-from
38-
# to run in development. (Github Pages will override
39-
# `safe` to be true on deploy, but it makes an
40-
# exception for jekyll-redirect from.)
41-
safe: false
42-
gems:
43-
- jekyll-redirect-from
62+
excerpt_separator: ""
4463

4564
navigation:
4665
- title: JSON API

‎_format/1.0/index.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ This section describes the structure of a JSON API document, which is identified
5858
by the media type [`application/vnd.api+json`]
5959
(http://www.iana.org/assignments/media-types/application/vnd.api+json).
6060
JSON API documents are defined in JavaScript Object Notation (JSON)
61-
[[RFC4627](http://tools.ietf.org/html/rfc4627)].
61+
[[RFC7159](http://tools.ietf.org/html/rfc7159)].
6262

6363
Although the same media type is used for both request and response documents,
6464
certain aspects are only applicable to one or the other. These differences are
@@ -586,7 +586,7 @@ The following "globally allowed characters" **MAY** be used anywhere in a member
586586
- U+0061 to U+007A, "a-z"
587587
- U+0041 to U+005A, "A-Z"
588588
- U+0030 to U+0039, "0-9"
589-
- any UNICODE character except U+0000 to U+007F _(not recommended, not URL safe)_
589+
- U+0080 and above (non-ASCII Unicode characters; _not recommended, not URL safe_)
590590

591591
Additionally, the following characters are allowed in member names, except as the
592592
first or last character:
@@ -629,6 +629,8 @@ The following characters **MUST NOT** be used in member names:
629629
- U+007C VERTICAL LINE, "|"
630630
- U+007D RIGHT CURLY BRACKET, "}"
631631
- U+007E TILDE, "~"
632+
- U+007F DELETE
633+
- U+0000 to U+001F (C0 Controls)
632634

633635
## <a href="#fetching" id="fetching" class="headerlink"></a> Fetching Data
634636

@@ -1737,7 +1739,7 @@ U+002D HYPHEN-MINUS, "-", U+005F LOW LINE, "_", or capital letter is used
17371739
(e.g. camelCasing).
17381740

17391741
If a server encounters a query parameter that does not follow the naming
1740-
conventions above, and the server does not know how to proccess it as a query
1742+
conventions above, and the server does not know how to process it as a query
17411743
parameter from this specification, it **MUST** return `400 Bad Request`.
17421744

17431745
> Note: This is to preserve the ability of JSON API to make additive additions
@@ -1776,7 +1778,7 @@ An error object **MAY** have the following members:
17761778
change from occurrence to occurrence of the problem, except for purposes of
17771779
localization.
17781780
* `detail`: a human-readable explanation specific to this occurrence of the
1779-
problem.
1781+
problem. Like `title`, this field's value can be localized.
17801782
* `source`: an object containing references to the source of the error,
17811783
optionally including any of the following members:
17821784
* `pointer`: a JSON Pointer [[RFC6901](https://tools.ietf.org/html/rfc6901)]

‎_format/1.1/index.md

Lines changed: 28 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -532,7 +532,7 @@ For example, the following `self` link is simply a URL:
532532

533533
```json
534534
"links": {
535-
"self": "http://example.com/posts",
535+
"self": "http://example.com/posts"
536536
}
537537
```
538538

@@ -641,7 +641,7 @@ The following "globally allowed characters" **MAY** be used anywhere in a member
641641
- U+0061 to U+007A, "a-z"
642642
- U+0041 to U+005A, "A-Z"
643643
- U+0030 to U+0039, "0-9"
644-
- any UNICODE character except U+0000 to U+007F _(not recommended, not URL safe)_
644+
- U+0080 and above (non-ASCII Unicode characters; _not recommended, not URL safe_)
645645

646646
Additionally, the following characters are allowed in member names, except as the
647647
first or last character:
@@ -684,6 +684,28 @@ The following characters **MUST NOT** be used in member names:
684684
- U+007C VERTICAL LINE, "|"
685685
- U+007D RIGHT CURLY BRACKET, "}"
686686
- U+007E TILDE, "~"
687+
- U+007F DELETE
688+
- U+0000 to U+001F (C0 Controls)
689+
690+
#### <a href="#document-member-names-at-members" id="document-member-names-at-members" class="headerlink"></a> @-Members
691+
692+
Member names **MAY** also begin with an at sign (U+0040 COMMERCIAL AT, "@").
693+
Members named this way are called "@-Members". @-Members **MAY** appear
694+
anywhere in a JSON API document.
695+
696+
However, JSON API processors **MUST** completely ignore @-Members (i.e. not
697+
treat them as JSON API data).
698+
699+
Moreover, the existence of @-Members **MUST** be ignored when interpreting all
700+
JSON API definitions and processing instructions given outside of this
701+
subsection. For example, an [attribute][attributes] is defined above as any
702+
member of the attributes object. However, because @-Members must be ignored
703+
when interpreting that definition, an @-Member that occurs in an attributes
704+
object is not an attribute.
705+
706+
> Note: Among other things, "@" members can be used to add JSON-LD data to a
707+
JSON API document. Such documents should be served with [an extra header](http://www.w3.org/TR/json-ld/#interpreting-json-as-json-ld)
708+
to convey to JSON-LD clients that they contain JSON-LD data.
687709

688710
## <a href="#fetching" id="fetching" class="headerlink"></a> Fetching Data
689711

@@ -1274,7 +1296,8 @@ ID](#crud-creating-client-ids) and the requested resource has been created
12741296
successfully, the server **MUST** return a `201 Created` status code.
12751297

12761298
The response **SHOULD** include a `Location` header identifying the location
1277-
of the newly created resource.
1299+
of the newly created resource, in order to comply with [RFC
1300+
7231](http://tools.ietf.org/html/rfc7231#section-6.3.2).
12781301

12791302
The response **MUST** also include a document that contains the primary
12801303
resource created.
@@ -1793,7 +1816,7 @@ It is **RECOMMENDED** that a U+002D HYPHEN-MINUS ("-"), U+005F LOW LINE ("_"),
17931816
or capital letter (e.g. camelCasing) be used to satisfy the above requirement.
17941817

17951818
If a server encounters a query parameter that does not follow the naming
1796-
conventions above, and the server does not know how to proccess it as a query
1819+
conventions above, and the server does not know how to process it as a query
17971820
parameter from this specification, it **MUST** return `400 Bad Request`.
17981821

17991822
> Note: This is to preserve the ability of JSON API to make additive additions
@@ -2054,7 +2077,7 @@ An error object **MAY** have the following members:
20542077
change from occurrence to occurrence of the problem, except for purposes of
20552078
localization.
20562079
* `detail`: a human-readable explanation specific to this occurrence of the
2057-
problem.
2080+
problem. Like `title`, this field's value can be localized.
20582081
* `source`: an object containing references to the source of the error,
20592082
optionally including any of the following members:
20602083
* `pointer`: a JSON Pointer [[RFC6901](https://tools.ietf.org/html/rfc6901)]

‎_format/1.1/normative-statements.json

Lines changed: 57 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,11 @@ layout: null
8989
{ "id": "member-name-globally-allowed", "type": "normative-statements" },
9090
{ "id": "member-name-url-safe", "type": "normative-statements" },
9191
{ "id": "member-name-allowed-characters", "type": "normative-statements" },
92-
{ "id": "member-name-reserved-characters", "type": "normative-statements" }
92+
{ "id": "member-name-reserved-characters", "type": "normative-statements" },
93+
{ "id": "member-name-at-members-definition", "type": "normative-statements" },
94+
{ "id": "member-name-at-members-where", "type": "normative-statements" },
95+
{ "id": "member-name-at-members-no-process", "type": "normative-statements" },
96+
{ "id": "member-name-at-members-ignore-for-definitions", "type": "normative-statements" }
9397
]
9498
}
9599
}
@@ -1002,6 +1006,58 @@ layout: null
10021006
}
10031007
}
10041008
},
1009+
{
1010+
"id": "member-name-at-members-definition",
1011+
"type": "normative-statements",
1012+
"attributes": {
1013+
"level": "MAY",
1014+
"description": "Member names **MAY** also begin with an at sign (U+0040 COMMERCIAL AT, \"@\"). Members named this way are called \"@-Members\"."
1015+
},
1016+
"relationships": {
1017+
"section": {
1018+
"data": { "id": "document-structure", "type": "sections" }
1019+
}
1020+
}
1021+
},
1022+
{
1023+
"id": "member-name-at-members-where",
1024+
"type": "normative-statements",
1025+
"attributes": {
1026+
"level": "MAY",
1027+
"description": "@-Members **MAY** appear anywhere in a JSON API document."
1028+
},
1029+
"relationships": {
1030+
"section": {
1031+
"data": { "id": "document-structure", "type": "sections" }
1032+
}
1033+
}
1034+
},
1035+
{
1036+
"id": "member-name-at-members-no-process",
1037+
"type": "normative-statements",
1038+
"attributes": {
1039+
"level": "MUST",
1040+
"description": "JSON API processors **MUST** completely ignore @-Members (i.e. not treat them as JSON API data)."
1041+
},
1042+
"relationships": {
1043+
"section": {
1044+
"data": { "id": "document-structure", "type": "sections" }
1045+
}
1046+
}
1047+
},
1048+
{
1049+
"id": "member-name-at-members-ignore-for-definitions",
1050+
"type": "normative-statements",
1051+
"attributes": {
1052+
"level": "MUST",
1053+
"description": "Moreover, the existence of @-Members **MUST** be ignored when interpreting all JSON API definitions and processing instructions given outside of the @-Members subsection."
1054+
},
1055+
"relationships": {
1056+
"section": {
1057+
"data": { "id": "document-structure", "type": "sections" }
1058+
}
1059+
}
1060+
},
10051061
{
10061062
"id": "fetch-url-support",
10071063
"type": "normative-statements",

‎_layouts/page.html

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,28 @@
3030
<script src="/javascripts/all.js" type="text/javascript"></script>
3131
<script src="/javascripts/highlight.pack.js"></script>
3232
<script>hljs.configure({classPrefix: ''}); hljs.initHighlightingOnLoad();</script>
33+
34+
<link rel="apple-touch-icon" sizes="57x57" href="/alt-favicons/apple-touch-icon-57x57.png">
35+
<link rel="apple-touch-icon" sizes="60x60" href="/alt-favicons/apple-touch-icon-60x60.png">
36+
<link rel="apple-touch-icon" sizes="72x72" href="/alt-favicons/apple-touch-icon-72x72.png">
37+
<link rel="apple-touch-icon" sizes="76x76" href="/alt-favicons/apple-touch-icon-76x76.png">
38+
<link rel="apple-touch-icon" sizes="114x114" href="/alt-favicons/apple-touch-icon-114x114.png">
39+
<link rel="apple-touch-icon" sizes="120x120" href="/alt-favicons/apple-touch-icon-120x120.png">
40+
<link rel="apple-touch-icon" sizes="144x144" href="/alt-favicons/apple-touch-icon-144x144.png">
41+
<link rel="apple-touch-icon" sizes="152x152" href="/alt-favicons/apple-touch-icon-152x152.png">
42+
<link rel="apple-touch-icon" sizes="180x180" href="/alt-favicons/apple-touch-icon-180x180.png">
43+
<link rel="icon" type="image/png" href="/alt-favicons/favicon-32x32.png" sizes="32x32">
44+
<link rel="icon" type="image/png" href="/alt-favicons/favicon-194x194.png" sizes="194x194">
45+
<link rel="icon" type="image/png" href="/alt-favicons/favicon-96x96.png" sizes="96x96">
46+
<link rel="icon" type="image/png" href="/alt-favicons/android-chrome-192x192.png" sizes="192x192">
47+
<link rel="icon" type="image/png" href="/alt-favicons/favicon-16x16.png" sizes="16x16">
48+
<link rel="manifest" href="/alt-favicons/manifest.json">
49+
<link rel="mask-icon" href="/alt-favicons/safari-pinned-tab.svg" color="#0b4e22">
50+
<link rel="shortcut icon" href="/favicon.ico">
51+
<meta name="msapplication-TileColor" content="#da532c">
52+
<meta name="msapplication-TileImage" content="/alt-favicons/mstile-144x144.png">
53+
<meta name="msapplication-config" content="/alt-favicons/browserconfig.xml">
54+
<meta name="theme-color" content="#0b4e22">
3355
</head>
3456

3557
<body>

‎alt-favicons/android-chrome-144x144.png

1.92 KB
Loading

‎alt-favicons/android-chrome-192x192.png

2.55 KB
Loading

‎alt-favicons/android-chrome-36x36.png

513 Bytes
Loading

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