Skip to content
A specification for building JSON APIs
CSS JavaScript HTML Python Makefile Groovy Other
Branch: gh-pages
Clone or download

Latest commit

dgeb Introduce Local IDs, or lids, to v1.1 (#1244)
A client may include a "local ID" as a `lid` member in a resource object to
uniquely identify the resource within the request document. Every representation
of that resource, whether as a resource object or resource identifier object,
must then include the matching `lid` member and value.

This addition paves the way for requests of all kinds that may need to establish
linkage between resources that have not yet been assigned a server-generated ID.
Latest commit 937a304 Apr 23, 2020

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
_errors feat(format): better define unsupported client-required profile error Dec 3, 2018
_format Introduce Local IDs, or lids, to v1.1 (#1244) Apr 23, 2020
_includes
_layouts Merge branch 'gh-pages' into profile-changelog Jan 2, 2019
_profiles/ethanresnick/cursor-pagination Add missing comma Sep 13, 2019
about Update active / emeritus editors Aug 12, 2019
alt-favicons Add a favicon Dec 21, 2015
design Add a favicon Dec 21, 2015
examples Fix typo Sep 24, 2019
extensions Merge pull request #1414 from json-api/1.1-status Aug 12, 2019
faq Minor grammatical change to FAQ (#1455) Jan 24, 2020
fonts Replace Google+ (icon) with link to new Discourse forum Nov 10, 2015
images Rework masthead and logo. May 19, 2015
implementations Add pydantic-jsonapi to python implementations (#1434) Apr 21, 2020
javascripts docs: add profile registration template, site pages, example profile Nov 14, 2018
recommendations Simplify profiles for v1.1 (#1456) Feb 12, 2020
stylesheets Add an editor(s) section to the profile template Dec 18, 2018
.gitignore Include all css as well as scss to keep Jekyll happy May 1, 2014
CNAME Set CNAME to main domain. May 10, 2013
CONTRIBUTING.md Use JSON:API instead of JSON API in the read me and contributing files Oct 31, 2018
Gemfile Deprecate existing extensions (#1026) Apr 13, 2016
LICENSE
README.md Use JSON:API instead of JSON API in the read me and contributing files Oct 31, 2018
Rakefile Redirect from old status page Nov 10, 2015
_config.yml Merge pull request #1414 from json-api/1.1-status Aug 12, 2019
favicon.ico
index.md docs: add changelog entry for 1.1 changes Dec 2, 2018
profile_template Add an editor(s) section to the profile template Dec 18, 2018
schema Merge branch 'gh-pages' into fix-schema-draft Dec 25, 2018

README.md

JSON:API

Documentation for the application/vnd.api+json media type, a specification for APIs that use JSON. This repository is the source code for http://jsonapi.org.

Resources

Status

This standard is currently under development. To assist:

  1. Get the dependencies:

    $ bundle

  2. Host the site locally while editing:

    $ bundle exec rake preview:browser

  3. Edit the Markdown files.

  4. Commit your changes.

  5. Send a Pull Request when finished.

The website is automatically built by GitHub Pages when changes are pushed to the gh-pages branch.

Archive

older versions of the JSON:API documentations

You can’t perform that action at this time.