-
Notifications
You must be signed in to change notification settings - Fork 192
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
Add REST endpoint for CifData #1228
Conversation
ltalirz
commented
Mar 7, 2018
- add /cifs/... endpoints
- add test
- replace hardcoded endpoint info by properly formatted dynamically generated list
also get available endpoints dynamically, not as a hardcoded list
still need to add tests
@giovannipizzi |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it is ok to add them, but maybe good to sit down at some point and discuss what the policy should be for new ones, to avoid too many and confusion in the future. Only think, is this documented? It would be good to have an example for it and mention this class in all parts needed, here http://aiida-core.readthedocs.io/en/latest/restapi/index.html#examples
* streamline beginning of restapi doc * add table with links to aiida objects represented by resources (complete list of available resources)
I've now added a table with a complete list of available resources that is linked to the respective aiida classes. I noticed that a lot of the basic AiiDA functionality is not part of the API doc. |
I'm perfectly ok to use sphinx-apidoc, and actually I also agree it's better - I still think that having a general, short page describing what the API tries to achieve in general, and then pointing the the sphinx doc for the various endpoints, is useful. |