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

Make resource-fetching methods of clients return DavResource[WithChildren] objects #165

Open
jwodder opened this issue Jul 13, 2024 · 0 comments
Assignees
Labels
code quality Nonfunctional improvements to the codebase high priority Work on these first

Comments

@jwodder
Copy link
Member

jwodder commented Jul 13, 2024

  • The following methods should be modified to return DavResource or DavResourceWithChildren objects, as appropriate:

    • DandiClient::get_all_dandisets()
    • DandisetEndpoint::get()
    • DandisetEndpoint::get_all_versions()
    • VersionEndpoint::get()
    • VersionEndpoint::get_metadata()
    • VersionEndpoint::get_resource()
    • VersionEndpoint::get_resource_with_children()
    • VersionEndpoint::get_root_children()
    • ZarrManClient::get_top_level_dirs()
    • ZarrManClient::get_resources()
    • ZarrManClient::get_resources_with_children()
  • The types that the above methods currently return should all have their visibilities restricted to crate::dandi or crate::zarrman, as appropriate

  • Various types in src/zarrman/resources.rs should then be renamed for greater accuracy (made easier by the fact that these types no longer have to coexist alongside crate::dandi types):

    • ManifestZarr
    • ManifestFolderZarrFolder
    • ManifestEntryZarrEntry

    and likewise for enum variants

@jwodder jwodder added the code quality Nonfunctional improvements to the codebase label Jul 13, 2024
@jwodder jwodder added this to the Current priorities milestone Jul 13, 2024
@jwodder jwodder self-assigned this Jul 13, 2024
@jwodder jwodder added the high priority Work on these first label Jul 22, 2024
@jwodder jwodder removed this from the Current priorities milestone Jul 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
code quality Nonfunctional improvements to the codebase high priority Work on these first
Projects
None yet
Development

No branches or pull requests

1 participant