Skip to content

Misc profile fixes #1329

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 1 commit into from
Dec 3, 2018
Merged

Misc profile fixes #1329

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
34 changes: 17 additions & 17 deletions _format/1.1/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1933,8 +1933,8 @@ Accept: application/vnd.api+json;profile="http://example.com/last-modified", app
It is used to support old servers that don't understand the profile parameter.

Servers **MAY** add profiles to a JSON:API document even if the client has not
requested them. The recipient of a document **MUST** ignore any profile extensions
in that document that it does not understand. The only exception to this is profiles
requested them. The recipient of a document **MUST** ignore any profiles in that
document that it does not understand. The only exception to this is profiles
whose support is required using the `profile` query parameter, as described later.

#### <a href="#profiles-sending" id="profiles-sending" class="headerlink"></a> Sending Profiled Documents
Expand Down Expand Up @@ -2002,8 +2002,8 @@ found in the server's internal mapping for the query parameters in use on the
request.

For example, the server might support a profile that defines a meaning for the
values of the `page[cursor]` query param. Then, it could define its internal
param name to profile uri mapping like so:
values of the `page[cursor]` query parameter. Then, it could define its internal
param name to profile URI mapping like so:

```json
{ "page[cursor]": "https://example.com/pagination-profile" }
Expand Down Expand Up @@ -2137,13 +2137,13 @@ element would be a recognized value:

```json
{
"type": "contacts",
"id": "345",
"meta": {
"timestamps": { "created": "2018-08-29T18:38:17.567Z" }
}
//...
"type": "contacts",
"id": "345",
"meta": {
"timestamps": { "created": "2018-08-29T18:38:17.567Z" }
}
//...
}
```

However, in the following case, the value for `timestamps` is *not* a recognized
Expand All @@ -2170,8 +2170,8 @@ element's value would be an unrecognized value.

> Note: unrecognized values are not necessarily invalid or erroneous values.
> For example, the timestamps profile might be revised later to actually define
> a "createdUnixEpoch" key. This key would be unrecognized by all existing
> applications at the time, but not by ones created/deployed later.
> a "createdUnixEpoch" key. This key would be unrecognized by all applications
> that existed at the time it was defined, but not by ones created/deployed later.

Each profile **MAY** define its own rules for how applications should proceed
when encountering unrecognized values.
Expand Down Expand Up @@ -2209,21 +2209,21 @@ profile would need to be ignored:
{
//...
"timestamps": {
"modified": "Wed Aug 29 2018 15:00:05 GMT-0400",
"updated": "Wed Aug 29 2018 15:00:05 GMT-0400",
"created": "2018-08-29T18:38:17.567Z"
}
}
```

Ignoring the profile in this case is required by the second default rule,
because the value for the `modified` key is not recognized under the profile's
requirement that the `modified` key hold a string of the form produced by
because the value for the `updated` key is not recognized under the profile's
requirement that the `updated` key hold a string of the form produced by
`JSON.stringify`.

### <a href="#profiles-authoring" id="profiles-authoring" class="headerlink"></a> Authoring Profiles

A profile **MAY** assign meaning to elements of the document structure whose use
is left up to each implementation, such as resource fields or members of meta
is left up to each implementation, such as resource fields or members of `meta`
objects. A profile **MUST NOT** define/assign a meaning to document members
in areas of the document reserved for future use by the JSON:API specification.

Expand Down Expand Up @@ -2260,7 +2260,7 @@ supported as well.
including to allow a superset of JSON structures.


> If you create your own profile, you are **strongly encouraged to [register](/extensions/#profile-registration)
> If you create your own profile, you are **strongly encouraged to [register](/extensions/#profile-creation)
> it** with the JSON API [profile registry](/extensions/), so that others can
> find and reuse it.

Expand Down
10 changes: 5 additions & 5 deletions extensions/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ By registering your profile:
others use to apply/identify the profile.

3. one of the JSON:API's editors will review your submission to check that it
follows the [profile extension requirements](/format/1.1/#profiles-authoring).
follows the [requirements for profiles](/format/1.1/#profiles-authoring).
These requirements can be a bit tricky, so getting an expert review ensures
that your profile is legal for use with JSON:API.

Expand All @@ -77,7 +77,7 @@ To register your profile:
2. Create a PR to [the json-api repository](https://github.com/json-api/json-api).
In the PR, make a directory at `_profiles/{NAMESPACE}/{PROFILE_NAME}` (where
`PROFILE_NAME` is the name of your profile, dasherized), and put your filled
out template as the `index.md` file in that directory folder. (See [an example](https://github.com/json-api/json-api/tree/1.1/_profiles/ethanresnick/cursor-pagination).)
out template as the `index.md` file in that directory folder. (See [an example](https://github.com/json-api/json-api/tree/gh-pages/_profiles/ethanresnick/cursor-pagination).)

Once submitted, one of JSON:API's editors will review your profile to check that
it: 1) follows the template above; 2) complies with JSON:API's [requirements for profiles](/format/1.1/#profiles-authoring);
Expand All @@ -99,9 +99,9 @@ If you do change your submission after it's been reviewed, it will be re-reviewe
to make sure it still complies with the requirements for approval given above.

JSON:API's editors may occasionally reassign responsibility for a registered
profile. The most common case of this will be to enable changes to be made to
profiles where the author of the registration has died, moved out of contact or
is otherwise unable to make changes that are important to the community.
profile. The most common reason for this will be to enable changes to be made
to profiles where the author of the registration has died, moved out of contact
or is otherwise unable to make changes that are important to the community.

Even though profile registration is strongly encouraged, it is not mandatory.
If you choose not to register your profile, you can create your own URL, on
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