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
HAPI responses should include the JSON schema reference #134
Comments
How to reference the schema is not too hard: probably add a link to it in the status block, for example. Question: is there a standard way for JSON to advertise the presence of a schema? Question: are there multiple JSON schema syntax options? Ans: they seem to have converged and we use: json-schema.org This will take some research and time. Need to then add schema refs to all the examples. Should 3.2 require a schema to be present? Maybe wait for 4.0 to require it? |
There is no standard way for JSON to announce that it is following a schema. json-schema-org/json-schema-spec#828 So how we manage this is probably up to us. From
Probably one line is enough. Maybe consider putting the web link in the schema key:
|
Conclusion:
Wait on item 2. till version 4.0. Do item 1. asap. |
Item 1. is tracked in #188 |
And the schemas should be put online with DOIs.
The text was updated successfully, but these errors were encountered: