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

(Un)versioned URLs #379

Closed
ml-evs opened this issue Jun 30, 2020 · 5 comments · Fixed by #380
Closed

(Un)versioned URLs #379

ml-evs opened this issue Jun 30, 2020 · 5 comments · Fixed by #380
Labels
needs discussion OpenAPI OpenAPI / Swagger related issue priority/high Issue or PR with a consensus of high priority server Issues pertaining to the example server implementation

Comments

@ml-evs
Copy link
Member

ml-evs commented Jun 30, 2020

We should start tracking Materials-Consortia/OPTIMADE#290 and discuss how we want to deal with it in the server code.

The PR will introduce the following:

At the very least, this is going to change how the validator needs to work. If given an unversioned base url, the validator needs to check for a /versions endpoint, so we probably need to add a flag to allow for versioned URLs to be tested without having to provide the /versions endpoint.

@ml-evs
Copy link
Member Author

ml-evs commented Jun 30, 2020

In fact, its just been merged, so we better get a move on!

@ml-evs ml-evs changed the title Versioned URLs (Un)versioned URLs Jun 30, 2020
@ml-evs ml-evs added needs discussion OpenAPI OpenAPI / Swagger related issue priority/high Issue or PR with a consensus of high priority server Issues pertaining to the example server implementation labels Jun 30, 2020
@rartino
Copy link
Contributor

rartino commented Jun 30, 2020

Will you actually handle /versions, given that it does not respond with json?

Edit: Ah, sorry, I was thinking for the schemas. But of course the implementation needs to provide the endpoint!

@ml-evs
Copy link
Member Author

ml-evs commented Jun 30, 2020

Will you actually handle /versions, given that it does not respond with json?

Edit: Ah, sorry, I was thinking for the schemas. But of course the implementation needs to provide the endpoint!

I've implemented it in #380 in such a way that it does not appear in the schema; I think there is some argument to made that the versions endpoint should appear in the schema, but I'm not sure of the appropriate way to represent it...

@CasperWA
Copy link
Member

CasperWA commented Jul 3, 2020

Has this been closed by #380 or are there still things to double check?

@ml-evs
Copy link
Member Author

ml-evs commented Jul 4, 2020

Closed by #380.

@ml-evs ml-evs closed this as completed Jul 4, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needs discussion OpenAPI OpenAPI / Swagger related issue priority/high Issue or PR with a consensus of high priority server Issues pertaining to the example server implementation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants