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

Should we have more schema examples? #81

Open
ePaul opened this issue Mar 24, 2017 · 9 comments
Open

Should we have more schema examples? #81

ePaul opened this issue Mar 24, 2017 · 9 comments
Labels
documentation Improvements or additions to documentation

Comments

@ePaul
Copy link

ePaul commented Mar 24, 2017

I just noted that the 3.0-RC0 specification contains no examples where oneOf or anyOf is used (maybe also not, that is difficult to search).

Should we have some of them, as this is an new important feature?

@webron
Copy link
Member

webron commented Mar 24, 2017

Not sure it would make sense. It would bloat the spec and it's not our job to teach people how to use JSON Schema. Maybe it makes more sense to add those in supporting documents.

@DavidBiesack
Copy link

I agree we don't want to turn the spec into a JSON Schema tutorial. the wiki would be a good place for such example.

@ePaul
Copy link
Author

ePaul commented Mar 27, 2017

Okay. How can I contribute to the Wiki? I don't see any edit link (just a "clone locally" one).

@DavidBiesack
Copy link

@ePaul - perhaps this project is configured to not allow direct edits by rather requires pull requests on the wiki repo.

I suggest creating a JSON Schema examples for OpenAPI 3.0 page or similarly named page.

@ePaul
Copy link
Author

ePaul commented Mar 27, 2017

@webron
Copy link
Member

webron commented Mar 27, 2017

As this is a documentation repo, I'd suggest staying away from the wiki and just work with md files in directories. It's a lot easier to manage and less error prone. The way the wiki works in github can be very destructive, and a maintenance hell.

@ePaul
Copy link
Author

ePaul commented Mar 27, 2017

@webron should we incorporate the existing wiki pages there?

@darrelmiller darrelmiller added the documentation Improvements or additions to documentation label Apr 26, 2017
@wenjdu
Copy link

wenjdu commented Aug 15, 2017

Giving you my 2 cents.
Having more examples would be really good !
I am really struggling trying to use oneOf, since the swagger-editor is showing errors.

@handrews handrews transferred this issue from OAI/OpenAPI-Specification Feb 10, 2024
@karenetheridge
Copy link
Member

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

6 participants