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 allow OpenAPI 3.0 or 3.1 spec version from /api? #214

Closed
philvarner opened this issue Oct 5, 2021 · 4 comments · Fixed by #226
Closed

Should we allow OpenAPI 3.0 or 3.1 spec version from /api? #214

philvarner opened this issue Oct 5, 2021 · 4 comments · Fixed by #226
Assignees
Milestone

Comments

@philvarner
Copy link
Collaborator

philvarner commented Oct 5, 2021

OGC API Part 5 will define using OpenAPI 3.1 spec for the service-desc
opengeospatial/ogcapi-features#404

After discussion at STAC API mtg today, I think we wait on this to see where Part 5 gets to.

@m-mohr
Copy link
Collaborator

m-mohr commented Oct 5, 2021

Maybe not arbitrary, but maybe allow 3.0 and 3.1 (or 3.x) - OAFeat allows 3.0 in the core and is coming up with an extension for 3.1 so that seems to be a good choice, I think.

@philvarner philvarner added this to the 1.0.0-beta.5 milestone Oct 5, 2021
@philvarner philvarner changed the title Should we allow arbitrary OpenAPI spec version from /api? Should we allow OpenAPI 3.0 or 3.1 spec version from /api? Oct 7, 2021
@philvarner philvarner self-assigned this Oct 11, 2021
@philvarner philvarner modified the milestones: 1.0.0-beta.5, 1.0.0-beta.6 Oct 11, 2021
@m-mohr
Copy link
Collaborator

m-mohr commented Oct 13, 2021

To recap the call a bit: OAFeat allows everything basically. Is there a good reason that we diverge from that? being future-proof makes sense (e.g. allow 3.1) so that we don't need to go STAC API 2.0 just because of this change.

Why has this been moved from beta.5 to 6?

@philvarner
Copy link
Collaborator Author

I re-wrote this to specify OpenAPI 3.0 or 3.1. However, I don't think we have a good reason for requiring that only those two can be used, so I'm in favor using the exact same language as OAFeat, and just recommending users use either OpenAPI 3.0 or 3.1

@m-mohr
Copy link
Collaborator

m-mohr commented Nov 1, 2021

I fully agree with you.

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