Skip to content

Rewrite/expand HTTP/profile/describedby sections #45

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 1 commit into from
Sep 13, 2016

Conversation

awwright
Copy link
Member

@awwright awwright commented Sep 12, 2016

Addresses #9, #26

Rendered draft available at jsonschema-core.txt

@awwright awwright added this to the draft-5 milestone Sep 12, 2016
@handrews
Copy link
Contributor

Nice! Since you recommend that profile and describedBy have the same URI for simplicity, is it worth calling out any sort of reason why they would not be similar? If so, a one-liner might be something like:

It may be preferable for describedBy link to use a different URI if clients are likely to run on a network that cannot access the identifying profile URI.

I do not feel at all strongly about this- it's fine and possibly less confusing as-is.

@awwright
Copy link
Member Author

Good point. Maybe something like... hmm, lemme think.

Maybe:

Since "profile" is opaque and doesn't necessarily need to point to a network location, a separate link relation is used for linking to a downloadable schema. However, for simplicity, schema authors should make these URIs point to the same resource when possible.

@handrews
Copy link
Contributor

Yes, that works. It doesn't explain why someone might use something other than a network location (or use a non-accessible network location), but that's a potentially large topic and therefore probably outside of the scope of this page.

@awwright awwright merged commit be4695e into json-schema-org:master Sep 13, 2016
@awwright
Copy link
Member Author

I used the following language:

The profile URI is opaque and SHOULD NOT automatically be dereferenced. If the implementation does not understand the semantics of the provided profile, the implementation can instead follow the "describedby" links, if any, which may provide information on how to handle the profile.
Since "profile" doesn't necessarily point to a network location, the "describedby" relation is used for linking to a downloadable schema.
However, for simplicity, schema authors should make these URIs point to the same resource when possible.

@awwright awwright mentioned this pull request Sep 13, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants