Skip to content

Legacy 1.2 and 2.0 JSON schema definitions #4370

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

Closed
duncanbeevers opened this issue Feb 18, 2025 · 3 comments · Fixed by #4435
Closed

Legacy 1.2 and 2.0 JSON schema definitions #4370

duncanbeevers opened this issue Feb 18, 2025 · 3 comments · Fixed by #4435
Labels

Comments

@duncanbeevers
Copy link
Contributor

duncanbeevers commented Feb 18, 2025

🗣 Discussion

As we're cleaning-up /schemas on main, this discussion pointed out that the 1.2 and 2.0 validation schemas are treated differently from those in the 3.x famlily.

  • Current JSON Schema variants and iterations are published at https://spec.openapis.org/#openapi-specification-schemas.
  • Historical JSON Schema variants and iterations for 3.0 are published
  • Historical JSON Schema variants and iterations for 1.2 and 2.0 are available, but are unpublished, an un-linked.

💧 Decisions to be made

  • Should legacy versions be deployed to spec.openapi.org? gh-pages: show OAS 2.0 schema #4366
  • Should externally-hosted sources for legacy versions be linked-to from spec.openapi.org?
  • Should legacy versions be marked with any special deprecation / JSON schema version caveats?
  • Should legacy versions be removed from main?

🌳 Resources

The validation schemas in question:

@handrews
Copy link
Member

PR #4366 adds 2.0, and I think we can safely ignore 1.2. Anyone who needs those schemas either found them or worked around it long ago. And 1.2, unlike 2.0, was never officially an "OpenAPI" release. The structure of 1.2 is very different from how the laster versions work (there were two different types of documents). I think including 1.2 would be more confusing than useful.

@handrews
Copy link
Member

Although we should keep the 1.2 schemas somewhere. I'm just not sure they need to be published on the spec site (same with the 1.2 spec).

@ralfhandl
Copy link
Contributor

How about moving the 1.2 schemas to an archive or _archive_ folder on main?

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

Successfully merging a pull request may close this issue.

4 participants