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

Where feasible - make JSON Schema (Draft 4?) part of this documentation #8

Closed
webron opened this issue Mar 15, 2014 · 4 comments
Closed

Comments

@webron
Copy link
Member

webron commented Mar 15, 2014

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.

@webron
Copy link
Member Author

webron commented Mar 15, 2014

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... :(

@webron
Copy link
Member Author

webron commented May 15, 2014

@quasipedia @vlcinsky - have you seen the newly published json schema files?

@vlcinsky
Copy link

@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.

@webron
Copy link
Member Author

webron commented Jul 9, 2014

I'll close it for now. We can always open dedicated issues should they arise.

@webron webron closed this as completed Jul 9, 2014
fehguy added a commit that referenced this issue Sep 8, 2014
renamed `resources`, added second example
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

No branches or pull requests

2 participants