Clarify note about Basic File Access in API Guide #9690
Conversation
General description of the basic file access: FilePIDsEnabled
put further link about FilePIDsEnabled
There was a problem hiding this comment.
Looks good. Here's a preview from https://dataverse-guide--9690.org.readthedocs.build/en/9690/api/dataaccess.html#basic-file-access
|
Is this true for an installation that has files with PIDs but its :FilePIDsEnabled setting is disabled? This is the case for at least Harvard Dataverse, and maybe other installations where some files have PIDs and some don't, and I'm able to use the file access endpoint with the persistentId parameter to get the files using their PIDs. |
pdurbin
changed the title
|
Well, if a file has a PID, it can be used. The spirit of the doc improvement it to raise consciousness that files may or may not have a PID. Overall, I think it helps. |
|
Cool okay. Thanks. I don't think that's what's being said if it's taken literally. But I agree it's an improvement 👍 |
What this PR does / why we need it:
https://guides.dataverse.org/en/latest/api/dataaccess.html
https://guides.dataverse.org/en/latest/installation/config.html?highlight=pidsenabled
Note at Basic File Access should clarify that FilePIDsEnabled should be turned on to access file by PIDs.
Otherwise, file access by PID would not work.
Which issue(s) this PR closes:
Special notes for your reviewer:
None.
Suggestions on how to test this:
None.
Does this PR introduce a user interface change? If mockups are available, please link/include them here:
None.
Is there a release notes update needed for this change?:
None.
Additional documentation:
None.