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

Fix awkward paragraph in 8.2.4.5 "Loading a Reference Schema" #817

Closed
handrews opened this issue Oct 25, 2019 · 2 comments
Closed

Fix awkward paragraph in 8.2.4.5 "Loading a Reference Schema" #817

handrews opened this issue Oct 25, 2019 · 2 comments
Assignees
Labels
clarification Items that need to be clarified in the specification

Comments

@handrews
Copy link
Contributor

In section 8.2.4.5, the 2nd paragraph reads:

When schemas are downloaded, for example by a generic user-agent that doesn't know until runtime which schemas to download, see Usage for Hypermedia (Section 11).

which I had trouble parsing just now while referring someone to that section. I think what's going on here is that:

  • We want to acknowledge that while implementations are not required to automatically fetch referenced schemas, sometimes that will be a thing that happens.
  • In particular, acknowledging systems where the exact schemas needed are only known at runtime.
  • Section 11 is specifically about ways to fetch schemas that allow meta-data that can work with RFC 8288 links and/or media types and their parameters. This is relevant, but not the only option- loading from files is also common, for example.

We should figure out what we're trying to say here and say it more clearly, without assuming HTTP or similar protocols.

@handrews handrews added this to the draft-08-patch1 milestone Oct 25, 2019
@Relequestual Relequestual self-assigned this Jan 28, 2020
Relequestual added a commit to Relequestual/json-schema-spec that referenced this issue Jan 28, 2020
@Relequestual
Copy link
Member

@handrews Had a go at fixing this.
To be honest, I didn't find it confusing at first read anyway, but hey ho.

@Relequestual
Copy link
Member

Closed in favour of #849

@gregsdennis gregsdennis added clarification Items that need to be clarified in the specification and removed Type: Maintenance labels Jul 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
clarification Items that need to be clarified in the specification
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants