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

Add REST endpoint for CifData #1228

Merged
merged 9 commits into from
Mar 7, 2018

Conversation

ltalirz
Copy link
Member

@ltalirz ltalirz commented Mar 7, 2018

  • add /cifs/... endpoints
  • add test
  • replace hardcoded endpoint info by properly formatted dynamically generated list

ltalirz added 3 commits March 5, 2018 14:44
also get available endpoints dynamically, not as a hardcoded list
still need to add tests
@ltalirz ltalirz requested a review from waychal March 7, 2018 08:38
@ltalirz
Copy link
Member Author

ltalirz commented Mar 7, 2018

@giovannipizzi
Is there some policy on adding REST endpoints?
I.e. do we simply add what we need as we go along or do you want to limit the number of available end points?

Copy link
Member

@giovannipizzi giovannipizzi left a 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)
@ltalirz
Copy link
Member Author

ltalirz commented Mar 7, 2018

@giovannipizzi

It would be good to have an example for it and mention this class in all parts needed

I've now added a table with a complete list of available resources that is linked to the respective aiida classes.
For the moment I haven't added an example as there are currently no examples for the derived Data types (at some point this page would explode...).

I noticed that a lot of the basic AiiDA functionality is not part of the API doc.
I always wondered why you are trying to add things to the API-doc manually instead of relying on sphinx-apidoc. Is there a particular reason?
This would also force developers to write (& correct) documentation as they go.

@giovannipizzi
Copy link
Member

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.
Feel free to convert the current doc to apidoc, or to have an issue on what is missing in the docs.

@ltalirz ltalirz merged commit 22ca65e into aiidateam:release_v0.11.1 Mar 7, 2018
@ltalirz ltalirz deleted the add_cifdata_rest branch April 12, 2018 14:16
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 this pull request may close these issues.

2 participants