Skip to content

Profile Extensions, Take 3: Extension Rules #1195

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.

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

Closed
wants to merge 12 commits into from
Prev Previous commit
Next Next commit
Update docs of extension system
  • Loading branch information
ethanresnick committed Jul 23, 2017
commit e9e24ca48a9804b36883548abb29a2594315645b
3 changes: 2 additions & 1 deletion _format/1.1/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@ version: 1.1
## <a href="#introduction" id="introduction" class="headerlink"></a> Introduction

JSON API is a specification for how a client should request that resources be
fetched or modified, and how a server should respond to those requests.
fetched or modified, and how a server should respond to those requests. JSON API
can also be easily [extended](#extending).

JSON API is designed to minimize both the number of requests and the amount of
data transmitted between clients and servers. This efficiency is achieved
Expand Down
25 changes: 16 additions & 9 deletions extensions/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,20 +4,27 @@ title: Extensions
show_sidebar: true
---

## <a href="#status" id="status" class="headerlink"></a> Status
Extensions enable an API to provide clients with information or functionality
beyond that described in the base JSON API specification.

Anyone can author an extension, and a single extension can be reused by
multiple APIs. Popular extensions may be implemented by off-the-shelf tools
so that developers can seamlessly take advantage of the features these
extensions provide.

## <a href="#existing-extensions" id="existing-extensions" class="headerlink"></a> Existing Extensions

Patience, my friend. A list of existing extensions is coming very soon.

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

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

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

New APIs should not use the old system or any extensions designed for it. APIs
that already use these old extensions should direct clients to an
New APIs should not use the old system or any extensions designed for it.
APIs that already use these old extensions should direct clients to an
[earlier version of this page](https://github.com/json-api/json-api/blob/9c7a03dbc37f80f6ca81b16d444c960e96dd7a57/extensions/index.md)
as documentation.
8 changes: 5 additions & 3 deletions index.md
Original file line number Diff line number Diff line change
Expand Up @@ -116,10 +116,12 @@ specification](/format).

## <a href="#extensions" id="extensions" class="headerlink"></a> Extensions

JSON API has [experimental support for extensions](/extensions).
The JSON API community has created a collection of extensions that APIs can use
to provide clients&mdash;in a standardized way&mdash;with information or
functionality beyond that described in the base JSON API specification.

Official extensions are being developed for [Bulk](/extensions/bulk/) and
[JSON Patch](/extensions/jsonpatch/) operations.
You can [browse existing extensions](/extensions/#existing-extensions) or
[register a new one](/extensions/#registering-an-extension).

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

Expand Down
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