Skip to content

Introduce Profiles to v1.1 #1268

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 30 commits into from
Sep 18, 2018
Merged

Introduce Profiles to v1.1 #1268

Changes from 1 commit
Commits
Show all changes
30 commits
Select commit Hold shift + click to select a range
9c0b91b
Introduce Profiles to v1.1
dgeb Apr 12, 2018
3f4220f
profiles: tweak definitions a bit
ethanresnick Apr 17, 2018
7533232
profiles: add should about extensibility
ethanresnick Apr 17, 2018
8b51551
profiles: add note about how to serialize space-separated media type …
ethanresnick Apr 17, 2018
fe660ec
profiles: make it a MUST to list the applied profiles in Content-Type
ethanresnick Apr 17, 2018
510e783
profiles: clarify role of profile in `Accept` per prior convos
ethanresnick Apr 17, 2018
36f4c0a
profiles: clarify that `Accept` may be totally ignored
ethanresnick Apr 17, 2018
4085f31
profiles: add example of using Accept to request profile
ethanresnick Apr 17, 2018
e08d3ce
profiles: clarify that keywords must be valid member names
ethanresnick Apr 17, 2018
67ff7f1
profiles: clarify evolution requriments
ethanresnick Apr 17, 2018
51d0be6
profiles: add note about 415 handling from 1.0 servers
ethanresnick Apr 17, 2018
1827986
Add top-level links.profile
ethanresnick Apr 30, 2018
eb2e815
Fix typo and trailing whitespace
dgeb Jul 1, 2018
e0397c2
Use the term `profile` in example (instead of `ext`)
dgeb Jul 1, 2018
7221b18
Clarify that links can specify URIs, not just URLs
dgeb Jul 13, 2018
18b590e
Replace all usages of jsonapi/profiles with links/profile
dgeb Jul 13, 2018
661ddbc
Profiles: fix broken links
ethanresnick Jul 22, 2018
e1232a9
profiles: remove overloaded uses of term "alias"
ethanresnick Jul 22, 2018
1e448f8
profiles: editorial/terminology cleanup/tweaks
ethanresnick Jul 27, 2018
9be7013
profiles: define what a profile is
ethanresnick Jul 27, 2018
7757134
profiles: add must-ignore rule to example timestamps profile
ethanresnick Jul 27, 2018
055a41f
profiles: create separate authoring section
ethanresnick Jul 27, 2018
3599821
profiles: add new minimal extra authoring rules
ethanresnick Jul 27, 2018
7f9eb81
profiles: editorial tweaks
ethanresnick Aug 28, 2018
e151c57
profiles: define handling of unrecognized values
ethanresnick Aug 29, 2018
e666c90
proflies: document extensibility concerns/requirements
ethanresnick Aug 29, 2018
db1e970
profile: define implicit profile query param value
ethanresnick Sep 18, 2018
61ccdff
profiles: clarify shallow definition of elements
ethanresnick Sep 18, 2018
ebae1b5
profiles: small cleanup
ethanresnick Sep 18, 2018
f8770df
profiles: fix profile param value inference
ethanresnick Sep 18, 2018
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
profiles: clarify role of profile in Accept per prior convos
  • Loading branch information
@ethanresnick
ethanresnick committed Apr 17, 2018
commit 510e783b54917ed15b13931dd07dff0e1d552f27
19 changes: 12 additions & 7 deletions _format/1.1/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1879,21 +1879,26 @@ that they have applied one or more profiles to a JSON API document.

A client **MAY** use the `profile` media type parameter in conjunction with the
JSON API media type in an `Accept` header to _request_, but not _require_, that
the server apply one or more profiles to the response. When such a request is
received, a server **SHOULD** attempt to apply the requested profiles in
processing a response.
the server apply one or more profiles to the response document. When such a
request is received, a server **SHOULD** attempt to apply the requested profiles
to its response.

### <a href="#profile-query-parameter" id="profile-query-parameter" class="headerlink"></a> `profile` Query Parameter

A client **MAY** use the `profile` query parameter to _require_ the application
of one or more profiles to the JSON API media type in processing a request. The
value of the `profile` query parameter **MUST** equal a URI-encoded
whitespace-separated list of profile URIs.
A client **MAY** use the `profile` query parameter to _require_ the server to
apply one or more profiles when processing the request. The value of the `profile`
query parameter **MUST** equal a URI-encoded whitespace-separated list of profile URIs.

If a server receives a request requiring the application of a profile or
combination of profiles that it can not apply, it **MUST** respond with a `400
Bad Request` status code.

> Note: When a client lists a profile in the `Accept` header, it's asking the server
> to compute its response as normal, but then send the response document with some
> extra information, as described in the requested profile. By contrarst, when a client
> lists a profile in the `profile` *query parameter*, it's asking the server to *process
> the incoming request* according to the rules of the profile.

### <a href="#profile-descriptors" id="profile-descriptors" class="headerlink"></a> Profile Descriptors

As described above, the top-level [`jsonapi`](document-jsonapi-object) object
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