-
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
Clean up /schemas
on main branch
#4356
Comments
What? Why? |
@notEthan Schemas are officially published in JSON form with correct |
Okay, I was thrown by interpreting/misinterpreting that the schemas in I'm still not sure the motivation for removing the existing published schemas - v2.0 in particular, still significantly in use but I don't see its schema on spec.openapis.org. Does this have a home? (1.x too but I haven't seen any 1.x in a very long time, don't know that it has significant use anymore.) I feel like having published versions on |
@notEthan good catch on 2.0 and 1.2. We don't currently publish those spec versions on spec.openapis.org (perhaps we should). I don't have a strong feeling about leaving those schemas on main, as long as 3.0+ (which are placeholders from an outdated development workflow that was always confusing to both contributors and users) get removed. I slightly prefer moving everything to the spec site, but that's just my personal love of consistency and should be balanced against community needs. I'm also fine with "1.2 and 2.0 aren't broken, so dont fix them" and just leave a README explaining the 3.x situation (by pointing to CONTRIBUTING.md). |
The 2.0 schema's id is
and it can be fetched from http://swagger.io/v2/schema.json#, so apparently the OAI doesn't own this schema. Also the README points to the NPM package If we want to add it despite the ownership problem, we should also show the 2.0 spec: The 1.2 schemas have a surprising structure, so I would leave them out. |
🗣 Discussion
The main branch contains a
/schemas
folder with files we don't want end-users consuming directly. In order to shield users from these files, the same way we do with/src
, they should be present on the dev branch and not on the main branch./schemas
artifacts/schemas
folder?/schemas
folder (or only itsv3.*
subfolders) and schema build script on mainThe text was updated successfully, but these errors were encountered: