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.

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
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 shallow definition of elements
  • Loading branch information
ethanresnick committed Sep 18, 2018
commit 61ccdff2ec1e01bbca7d61f962d35a9ab173ec57
30 changes: 18 additions & 12 deletions _format/1.1/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -1985,9 +1985,15 @@ https://example.com/?filter=xyz&profile=https://example.com/my-filter-profile

A profile **SHOULD** explicitly declare "keywords" for any elements that it
introduces to the document structure. If a profile does not explicitly declare a
keyword for an element, then the name of the element itself is considered to be
its keyword. All profile keywords **MUST** meet this specification's
requirements for [member names].
keyword for an element, then the name of the element itself (i.e., its key in
the document) is considered to be its keyword. All profile keywords **MUST**
meet this specification's requirements for [member names].

For the purposes of aliasing, a profiles elements are defined shallowly.
In other words, if a profile introduces an object-valued document member, that
member is an element (and so subject to aliasing), but any keys in it are not
themselves elements. Likewise, if the profile defines an array-valued element,
the keys in nested objects within that array are not elements.

The following example profile defines a single keyword, `version`:

Expand Down Expand Up @@ -2075,10 +2081,10 @@ key `version` described in the profile:
### <a href="#profiles-processing" id="profiles-processing" class="headerlink"></a> Processing Profiled Documents/Requests

When a profile is applied to a request and/or document, the value used for each
of the profile's elements (document members or query parameters) is said to be
"a recognized value" if that value, including all parts of it, has a legal,
defined meaning *according to the latest revision of the profile that the
application is aware of*.
of the profile's document members or query parameters is said to be "a
recognized value" if that value, including all parts of it, has a legal, defined
meaning *according to the latest revision of the profile that the application is
aware of*.

> Note: The set of recognized values is also/more technically known as the
> [defined text set](http://www.w3.org/2001/tag/doc/versioning-compatibility-strategies#terminology).
Expand Down Expand Up @@ -2184,11 +2190,11 @@ values whose details are left up to each implementation, such as `filter` and
all those that parameters that contain a non a-z character. However, profiles
**MUST NOT** assign a meaning to query parameters that [are reserved](#query-parameters).

The meaning of an element defined by a profile **MUST NOT** vary based on the
presence or absence of other profiles.
The meaning of an element or query parameter defined by a profile **MUST NOT**
vary based on the presence or absence of other profiles.

The scope of a profile **MUST** be clearly delineated. The elements reserved by
a profile, and the meaning assigned to those elements, **MUST NOT** change over
The scope of a profile **MUST** be clearly delineated. The elements and query
parameters specified by a profile, and their meanings, **MUST NOT** change over
time or else the profile **MUST** be considered a new profile with a new URI.

> Note: When a profile changes its URI, a huge amount of interoperability is lost.
Expand Down Expand Up @@ -2220,7 +2226,7 @@ this new member.

The timestamps profile also *could not* evolve to define a new element as a
sibling of the `timestamps` key, as that would be incompatible with the rule
that "The elements reserved by profile... **MUST NOT** change over time."
that "The elements... specified by a profile... **MUST NOT** change over time."

> The practical issue with adding a sibling element is that another profile
> in use on the document might already define a sibling element of the same
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