#9650 documenting the API call to list dataverses linked to a dataset #9655
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
pkiraly
added this to Ready for Review ⏩
in IQSS/dataverse (TO BE RETIRED / DELETED in favor of project 34)
5 tasks
pdurbin
reviewed
Jun 20, 2023
pdurbin
approved these changes
Jun 20, 2023
IQSS/dataverse (TO BE RETIRED / DELETED in favor of project 34)
automation
moved this from Ready for Review ⏩
to Ready for QA ⏩
Jun 20, 2023
kcondon
moved this from Ready for QA ⏩
to QA ✅
in IQSS/dataverse (TO BE RETIRED / DELETED in favor of project 34)
|
@pkiraly There is a slight error in the example command -it should be a GET, not a PUT, or just remove -X PUT entirely: curl -H "X-Dataverse-key: $API_TOKEN" http://$SERVER/api/datasets/$linked-dataset-id/links |
…com:pkiraly/dataverse into 9650-2-linked-dataverses-list-documentation
|
@kcondon done |
IQSS/dataverse (TO BE RETIRED / DELETED in favor of project 34)
automation
moved this from QA ✅
to Done 🚀
Jun 20, 2023
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.
What this PR does / why we need it:
It provides a documentation to an API call, which is in the code base, but not documented. The documentation will be available at the admin/dataverses-datasets.html page.
Which issue(s) this PR closes:
It is a step towards closing #9650, but it does not close it completely, it is just a baby step.
Special notes for your reviewer:
Suggestions on how to test this:
Does this PR introduce a user interface change? If mockups are available, please link/include them here:
It modifies the documentation only.
Is there a release notes update needed for this change?:
Additional documentation:
Before:
After:
