7823 dirindex web browsing and docs #7894
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
Previously, .index.html files were being downloaded as attachments.
scolapasta
approved these changes
May 27, 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:
This pull request lets people use their web browsers on the "dirindex" API feature. That is, you can navigate to a URL like http://localhost:8080/api/datasets/67/dirindex in your browser and see files (and sometimes folders).
Given a dataset like this with files in folders...
... here's how "dirindex" looks...
... and if you drill down into a directory, it looks like this:
This pull request also corrects the documentation for this feature, adding images that were in the source but not rendered on the page. Compare below (with images) to https://guides.dataverse.org/en/5.5/api/native-api.html#view-dataset-files-and-folders-as-a-directory-index
Which issue(s) this PR closes:
Closes #7823
Special notes for your reviewer:
We do want images in the docs, right? I assume that was the intention. I made the images live in 86b70b7.
Suggestions on how to test this:
Make sure you can use a web browser on dirindex as described above and in the docs.
Does this PR introduce a user interface change? If mockups are available, please link/include them here:
No but I think we should someday consider linking to this view from the UI since it can be used in a web browser. It would make the feature more discoverable than it is now, somewhat buried in the API Guide.
Is there a release notes update needed for this change?:
I don't think so. It's just a bug fix. My reading of the docs is that this is how it was intended to work all along, given the screenshots already in the docs.
Additional documentation:
None but (again) I did fix the images.