emphasize differences with SWORD auth (vs. native) #7441 #7484
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
pdurbin
added this to Review 🦁
in IQSS/dataverse (TO BE RETIRED / DELETED in favor of project 34)
via automation
sekmiller
approved these changes
Jan 5, 2021
IQSS/dataverse (TO BE RETIRED / DELETED in favor of project 34)
automation
moved this from Review 🦁
to QA 🔎✅
Jan 5, 2021
IQSS/dataverse (TO BE RETIRED / DELETED in favor of project 34)
automation
moved this from QA 🔎✅
to Done 🚀
Jan 5, 2021
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:
There has been confusion over how SWORD auth works, especially if you're used to the native API.
Which issue(s) this PR closes:
Closes #7441
Special notes for your reviewer:
In the Google thread @joenio said, "I think would be nice to update the Dataverse API doc with some examples of using SWORD API by code (can be examples in javascript as I sent in last message or python, or other language). Specially to be clear about the authentication differences between native api and sword api." But then later in the issue he didn't ask for code examples. It's easier and more language neutral to just document APIs with curl so that's what I'm sticking with. Plus, this was estimated as a small.
Suggestions on how to test this:
Nothing to test unless you want to try a curl example on that page. SWORD is exercised regularly from the API test suite and this is just a doc change.
Does this PR introduce a user interface change? If mockups are available, please link/include them here:
No.
Is there a release notes update needed for this change?:
No.
Additional documentation:
None.