Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add document on how the Archive API is used #224

Merged
merged 10 commits into from
Feb 10, 2025
Merged

Add document on how the Archive API is used #224

merged 10 commits into from
Feb 10, 2025

Conversation

jwodder
Copy link
Member

@jwodder jwodder commented Jan 16, 2025

No description provided.

@jwodder jwodder added the documentation Improvements or additions to documentation label Jan 16, 2025
@jwodder jwodder requested a review from yarikoptic January 16, 2025 22:05
@jwodder jwodder added the skip deployment Do not deploy this PR upon merge label Jan 16, 2025
Copy link

codecov bot commented Jan 22, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 79.51%. Comparing base (7f7def5) to head (0c79cbe).
Report is 55 commits behind head on main.

Additional details and impacted files
@@             Coverage Diff             @@
##             main     #224       +/-   ##
===========================================
+ Coverage   52.12%   79.51%   +27.39%     
===========================================
  Files          29       34        +5     
  Lines        4033     6574     +2541     
===========================================
+ Hits         2102     5227     +3125     
+ Misses       1931     1347      -584     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@jwodder
Copy link
Member Author

jwodder commented Jan 23, 2025

@yarikoptic Is there anything in this document that you think could be improved?

Copy link
Member

@yarikoptic yarikoptic left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

asked for some clarifications and references

@@ -0,0 +1,156 @@
How `dandidav` Uses the DANDI Archive API
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there "caching" of requests somehow based e.g. on modified timestamp per dandiset or anything related? that would then be useful to mention since would relate to "How".

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No. The only caching is for Zarr manifests.


- When responding to a `PROPFIND` request with a `Depth` header of `0`
(hereafter referred to as a "shallow request"), `dandidav` requests only the
resource identified by the request path, not any of its children.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what happens for Depth request with infinity?

Copy link
Member Author

@jwodder jwodder Jan 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We reject those immediately.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sounds like worth documenting here?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done in 0ec52e5.

@jwodder
Copy link
Member Author

jwodder commented Feb 3, 2025

@yarikoptic Please re-review.

@jwodder
Copy link
Member Author

jwodder commented Feb 10, 2025

@yarikoptic Ping.

@jwodder jwodder merged commit 1ad4814 into main Feb 10, 2025
@jwodder jwodder deleted the api-requests branch February 10, 2025 16:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation skip deployment Do not deploy this PR upon merge
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants