-
Notifications
You must be signed in to change notification settings - Fork 9.1k
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
Where feasible - make JSON Schema (Draft 4?) part of this documentation #8
Comments
Comment by quasipedia from Sunday Mar 02, 2014 at 23:56 GMT 👍 When developing my software, I had to pull the schema from the code of some other software on a repo here on GitHub... then I realised the schema was also partially wrong... :( |
@quasipedia @vlcinsky - have you seen the newly published json schema files? |
@webron I had very busy few weeks and noticed this update. Nice. Meantime, I even managed to use them and it helped me. There was one challenge - it refers to schemas on url which is not served, so I had to create my own local file system system catalogue solution (for Python jsonschema package) - but now it works. Thanks for the schemas - it helped me to detect couple of broken structures in the API Declarations I am testing. Question: Do you think, we shall close this issue? I would be fine with closing it, but you might be aware of remaining issues in schemas, if any. |
I'll close it for now. We can always open dedicated issues should they arise. |
renamed `resources`, added second example
Issue by vlcinsky from Sunday Mar 02, 2014 at 23:40 GMT
Originally opened as https://github.com/wordnik/swagger-docs/issues/9
Having any sort of schema makes answering a question "is my document following these standards?" much simpler.
While accepting, all sorts of schemas have some limitations, it often allows at least quick detection of clear errors.
I would expect one schema for resource listing and another for resource definition.
The text was updated successfully, but these errors were encountered: