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

Tutorial content ideas for helping users migrate to OAS 3.1 #34

Open
darrelmiller opened this issue Jan 9, 2020 · 2 comments
Open

Tutorial content ideas for helping users migrate to OAS 3.1 #34

darrelmiller opened this issue Jan 9, 2020 · 2 comments

Comments

@darrelmiller
Copy link
Member

  • Clarify which JSON Schema properties most normal people care about vs ones for metaschema writers.
  • Describe what new capabilities JSON Schema 2019-09 brings to OAS users.
@handrews
Copy link
Member

Primarily for meta-schema writers:

  • $vocabulary
  • $recursiveAnchor
  • $recursiveRef

Note that the $recursive* keywords could have other uses, but in practice the need for them seems to be rare outside of meta-schemas.


Primarily for people packaging multiple schema resources in a single schema document:

  • $id in subschemas

Primarily for people creating a library of schemas in one schema resource, where users of those schemas should not need to know the internal structure of the resource.

  • $anchor

Note that these descriptions rely on the distinction between a schema resource and a schema document, which is new in draft 2019-09.

@handrews
Copy link
Member

@darrelmiller should we transfer this to the learn.openapis.org repo?

@webron webron transferred this issue from OAI/OpenAPI-Specification Feb 8, 2024
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