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

Drop '/optimade' from paths in openapi.json #197

Closed
merkys opened this issue Mar 1, 2020 · 3 comments · Fixed by #201
Closed

Drop '/optimade' from paths in openapi.json #197

merkys opened this issue Mar 1, 2020 · 3 comments · Fixed by #201
Assignees
Labels
OpenAPI OpenAPI / Swagger related issue

Comments

@merkys
Copy link
Member

merkys commented Mar 1, 2020

Path /optimade is not required in the URLs by the specification, thus I assume it should be dropped from the schema.

@merkys merkys added the OpenAPI OpenAPI / Swagger related issue label Mar 1, 2020
@CasperWA
Copy link
Member

CasperWA commented Mar 1, 2020

Agreed. This has already been discussed in another issue or PR, brought up by @ltalirz - we both agree on it and it's good to have it as a specific issue here.
Edit: It's issue #193.

What we couldn't agree on (or rather, what was more uncertain) was what to do with the versioned URL part, i.e., /v0 or /v1.
Personally, I would like to keep it in, but I also see @ltalirz's point that the version is already stated in the OpenAPI, and so it is essentially redundant - however, since this is a required part of the URL, I think it better to leave it in, explicitly.

@merkys
Copy link
Member Author

merkys commented Mar 1, 2020

I would vote for keeping the version URL part, but either way is fine with me for now.

@ltalirz
Copy link
Member

ltalirz commented Mar 1, 2020

Then let's keep the /v0 in the openapi.json for the moment.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
OpenAPI OpenAPI / Swagger related issue
Projects
None yet
3 participants