Skip to content
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

Minimal change from "profile" to "schema" #414

Merged
merged 1 commit into from
Oct 20, 2017

Conversation

handrews
Copy link
Contributor

@handrews handrews commented Sep 19, 2017

This change removes "profile", since as noted in issue #222 the
usage is not correct. It replaces it with "schema", with the
minimal possible change.

We may wish to also remove the "describedby" link relation and
instead mandate using "schema", or a similarly named
extension relation, and allow downloading schemas based on the
parameter. That is outside of the scope of this change.

This also continues to address #351 application/schema-instance+json

This change removes "profile", since as noted in issue json-schema-org#222 the
usage is not correct.  It replaces it with "schema", with the
minimal possible change.

We may wish to also remove the "describedby" link relation and
instead mandate using "schema", or a similarly named
extension relation, and allow downloading schemas based on the
parameter.  That is outside of the scope of this change.
@handrews handrews added this to the draft-07 (wright-*-02) milestone Sep 19, 2017
<cref>
This paragraph assumes that we can register a "schema" link relation.
Should we instead specify something like "tag:json-schema.org,2017:schema"
for now?
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Or a URL like http://json-schema.org/<something here> ? Like JSON-LD does with http://www.w3.org/ns/json-ld#context.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I really like using non-dereferenceable URI schemes like tag: when there is nothing to dereference. While it is certainly valid to use http:// or https:// for such a purpose, it is counter-intuitive and leads to a.) people blindly dumping it in a browser and being annoyed that it doesn't work and b.) awkward paragraphs in specifications about how even though the URI looks dereferenceable, implementations MUST NOT dereference it.

Just make it non-dereferenceable. It solves all the UX problems of apparently-dereferenceable-URIs-that-are-not-actually-dereferenceable.

@handrews
Copy link
Contributor Author

handrews commented Oct 1, 2017

This hits 2 weeks tomorrow, but I will be leaving it open until @awwright has had a chance to spend time on this issue and/or offer an alternate proposal (either is very welcome!).

Comments from others still also welcome!

Copy link
Member

@dlax dlax left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The change from "profile" to "schema" seems fine to me.

@handrews handrews changed the base branch from master to instance October 18, 2017 02:52
@handrews
Copy link
Contributor Author

Final review deadline is Friday, Oct. 20th. Barring actionable objections, this will be merged then to kick off the final review period.

@handrews handrews changed the base branch from instance to master October 20, 2017 16:28
@handrews handrews merged commit cb53907 into json-schema-org:master Oct 20, 2017
@handrews handrews deleted the hyperlink branch October 20, 2017 16:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants