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

REST API: list endpoints at base URL #4412

Merged
merged 4 commits into from
Oct 20, 2020

Conversation

ltalirz
Copy link
Member

@ltalirz ltalirz commented Sep 28, 2020

fixes #3916

The base URL of the REST API was returning a 404 invalid URL response
without providing any guidance to new users as to how to use the API.
We change this to return the list of endpoints formerly available only
under /server/endpoints.

Documentation of where to find the list of endpoints -- which seems
to have been entirely deleted -- is reintroduced.

The base URL of the REST API was returning a 404 invalid URL response
without providing any guidance to new users as to how to use the API.
We change this to return the list of endpoints formerly available only
under /server/endpoints.

Documentation of where to find the list of endpoints -- which seems
to have been entirely deleted -- is added.
@codecov
Copy link

codecov bot commented Sep 28, 2020

Codecov Report

Merging #4412 into develop will increase coverage by 0.03%.
The diff coverage is 100.00%.

Impacted file tree graph

@@             Coverage Diff             @@
##           develop    #4412      +/-   ##
===========================================
+ Coverage    79.29%   79.32%   +0.03%     
===========================================
  Files          475      475              
  Lines        34837    34838       +1     
===========================================
+ Hits         27622    27632      +10     
+ Misses        7215     7206       -9     
Flag Coverage Δ
#django 73.17% <100.00%> (+0.05%) ⬆️
#sqlalchemy 72.40% <100.00%> (+0.04%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
aiida/restapi/api.py 76.09% <ø> (ø)
aiida/restapi/resources.py 96.59% <100.00%> (+2.04%) ⬆️
aiida/orm/utils/log.py 76.67% <0.00%> (-16.66%) ⬇️
aiida/engine/daemon/runner.py 79.32% <0.00%> (-3.44%) ⬇️
aiida/engine/daemon/client.py 72.42% <0.00%> (-1.14%) ⬇️
aiida/sphinxext/process.py 95.81% <0.00%> (+0.67%) ⬆️
aiida/orm/nodes/data/list.py 80.25% <0.00%> (+0.98%) ⬆️
aiida/restapi/common/utils.py 74.08% <0.00%> (+2.39%) ⬆️
aiida/sphinxext/calcjob.py 100.00% <0.00%> (+6.67%) ⬆️
... and 1 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update eed1917...f47e298. Read the comment docs.

@ltalirz
Copy link
Member Author

ltalirz commented Oct 1, 2020

@giovannipizzi @asle85 Does this look good to you?

@elsapassaro
Copy link
Contributor

Thanks @ltalirz ! It looks good to me

@ltalirz ltalirz added the pr/ready-for-review PR is ready to be reviewed label Oct 5, 2020
@ltalirz
Copy link
Member Author

ltalirz commented Oct 19, 2020

@giovannipizzi Could you look into reviewing & merging this?

@giovannipizzi
Copy link
Member

Thanks a lot @ltalirz !
However as codecov points out, the new code path (line 44) is not tested - could you add a test for the / path? (Probably it could be a copy-paste from one of the existing tests?)

@ltalirz
Copy link
Member Author

ltalirz commented Oct 19, 2020

Makes sense - added!

@ltalirz ltalirz merged commit db659dd into aiidateam:develop Oct 20, 2020
@ltalirz ltalirz deleted the issue_3916_rest_api_base_url branch December 14, 2020 12:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pr/ready-for-review PR is ready to be reviewed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

REST API: base URL returns 404, not clear how to find the endpoints
3 participants