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

info endpoint duplicated? #120

Closed
ltalirz opened this issue Jan 8, 2020 · 1 comment · Fixed by #121
Closed

info endpoint duplicated? #120

ltalirz opened this issue Jan 8, 2020 · 1 comment · Fixed by #121

Comments

@ltalirz
Copy link
Member

ltalirz commented Jan 8, 2020

Looking at the autodoc generated by swagger, it somehow seems like the info endpoint is duplicated

https://petstore.swagger.io/?url=https://raw.githubusercontent.com/Materials-Consortia/optimade-python-tools/master/openapi/openapi.json#/

Screenshot 2020-01-08 at 09 24 22

Screenshot 2020-01-08 at 09 24 34

  1. there should be no info/{entry} correct?
  2. under the "Info" header, optimade/v0.10.0/info and optimade/v0.10.0/info/{entry} appears twice
  3. optimade/info also appears under "Structure", reference, etc.
@CasperWA
Copy link
Member

CasperWA commented Jan 8, 2020

1. there should be no `info/{entry}` correct?

There should.
The specification is now such that we have all entry-specific info endpoints under /info/<entry-endpoint>, e.g., /info/structures.

2. under the "Info" header, `optimade/v0.10.0/info` and `optimade/v0.10.0/info/{entry}` appears twice

No, one is for v0.10, the other is for v0.10.0.

3. `optimade/info` also appears under "Structure", reference,  etc.

Technically not true, but optimade/info/structures (in the form of info/{entry}) appears, which is essentially fine, but might be confusing. This can be changed easily, removing the entry endpoint tags for the /info endpoints.

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

Successfully merging a pull request may close this issue.

2 participants