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

Extra structure endpoints in the api specification @ odbx #259

Closed
fekad opened this issue May 4, 2020 · 4 comments
Closed

Extra structure endpoints in the api specification @ odbx #259

fekad opened this issue May 4, 2020 · 4 comments
Assignees

Comments

@fekad
Copy link
Contributor

fekad commented May 4, 2020

https://odbx.science/optimade/v0/extensions/docs#/Structure

The section structure is not related to optimade. As far as I see it two API has been merged into one. Of course, it is reasonable but if the client code wants to use the openapi.json file it might hit some endpoints without knowing how to handle them.
For example, in the case of '/structures' endpoint, the response is an HTML page, not even a valid JSON data.

As a workaround, it is possible to ignore all the extra/unknown endpoints in the code of the client.

If you think it is not an issue or it has been discussed before please feel free to close it anytime.

@fekad
Copy link
Contributor Author

fekad commented May 4, 2020

The API implementation MAY provide other entry types than the ones standardized in this specification, but such entry types MUST be prefixed by a database-provider-specific prefix.

https://github.com/Materials-Consortia/OPTIMADE/blob/develop/optimade.rst#51entry-listing-endpoints

To be honest I think this is too restricted...

@ml-evs
Copy link
Member

ml-evs commented May 4, 2020

Hey @fekad, thanks for checking this out. I'm in the process of separating my JSON REST and HTML API so I can be more free with the HTML. Does your complaint also apply to https://optimade.odbx.science/v0/extensions/docs#/Structure? I think I have sorted out SSL etc. on this new subdomain so just need to update the link in the providers repo.

@ml-evs
Copy link
Member

ml-evs commented May 4, 2020

I'm going to close this here and make the PR to providers so that the link can be updated. If you find any issues with http://optimade.odbx.science please do report them @fekad! Thanks again.

@ml-evs
Copy link
Member

ml-evs commented May 4, 2020

Feel free to review Materials-Consortia/providers#22 ;)

@ml-evs ml-evs closed this as completed May 4, 2020
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

No branches or pull requests

2 participants