Update documentation for version v3 of REST API #3106
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Isn't this supposed to rather fix issue #2964 ? Issues #3048 (and the duplicate it seems #2384 ) are the generic ones to make sure the REST API documentation is fully up to date. Is that the case with this PR? I remember @waychal saying that the only two end-points remaining would be |
elsapassaro
force-pushed
the
fix_3048_restapi_docs
branch
from
707617a
to
e5d6c35
Compare
waychal
previously approved these changes
Jul 3, 2019
Changed v2 to v3 in the base url, and updated documentation and examples to reflect the changes in the ORM. Added full base url (including /api/v* suffix) to the message printed by ``verdi restapi`` command, so the user can click on the link and directly access the API. Fixed help text in rest api schema for groups.
elsapassaro
force-pushed
the
fix_3048_restapi_docs
branch
from
525588a
to
8356b42
Compare
waychal
approved these changes
Jul 4, 2019
d-tomerini
pushed a commit
to d-tomerini/aiida_core
that referenced
this pull request
Jul 24, 2019
…ger; typos in AUTHORS Minor correction to make sure the documentation regarding REST API and result manager are up to date with the latest version of AiiDA 1.0. Dealing with issues aiidateam#3048 and aiidateam#3027 Checked that the files are where the user is told they are, and commands work (python 3 corrections too). Mainly corrected typos, unified and broken links. I checked that the examples in the REST API section work, but I did not try to set ap an APACHE server -- I assume that has been tested by someone else elesewhere (aiidateam#3106 ? ) Corrected a couple imprecision in the AUTHOR list file (double entry and an incorrect name)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fix
#3048#2964.Changed v2 to v3 in the base url, and updated documentation and examples to reflect the changes in the ORM.
Added full base url (including /api/v* suffix) to the message printed by
verdi restapicommand, so the user can click on the link and directly access the API.As soon as the functionality of passing the REST endpoint as a variable in the URL of Materials Cloud Explore is implemented in production, this should print also the proper link to https://www.materialscloud.org/explore/connect, so it can directly connect to the explore interface of a database.
Fixed help text in rest api schema for Groups.