From c87cc8c8c8804bb11bea954f0dff7eba30af9985 Mon Sep 17 00:00:00 2001 From: Yaroslav Halchenko Date: Thu, 1 Feb 2024 14:30:48 -0500 Subject: [PATCH 1/4] Just a discussion pasted from #1837 --- doc/design/paths-endpoint-webdav.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 doc/design/paths-endpoint-webdav.md diff --git a/doc/design/paths-endpoint-webdav.md b/doc/design/paths-endpoint-webdav.md new file mode 100644 index 000000000..780544987 --- /dev/null +++ b/doc/design/paths-endpoint-webdav.md @@ -0,0 +1,21 @@ +# Discussion on metadata needed for dandidav + +Submitted as a PR to avoid spagetti thread discussion on https://github.com/dandi/dandi-archive/issues/1837#issuecomment-1921864949 + + +@jwodder listed needed properties and metadata fields: + +* Asset properties used by dandidav: + * `asset_id` + * `blob_id` + * `zarr_id` + * `path` + * `size` + * `created` + * `modified` + * Note: It might be more accurate to use the `blobDateModified` metadata field for this instead; cf. dandi/dandidav#17 + +* Asset metadata used by dandidav: + * `encodingFormat` (blobs only) + * `contentUrl` (API download URL for blobs, S3 URL for Zarrs) + * `digest["dandi:dandi-etag"]` (blobs only) From 24e1188c531afa7d53c09a4b0a04cf7053738850 Mon Sep 17 00:00:00 2001 From: Yaroslav Halchenko Date: Thu, 1 Feb 2024 16:01:58 -0500 Subject: [PATCH 2/4] First batch of annotations on what we have already or desire --- doc/design/paths-endpoint-webdav.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/doc/design/paths-endpoint-webdav.md b/doc/design/paths-endpoint-webdav.md index 780544987..5e9211ea9 100644 --- a/doc/design/paths-endpoint-webdav.md +++ b/doc/design/paths-endpoint-webdav.md @@ -6,16 +6,16 @@ Submitted as a PR to avoid spagetti thread discussion on https://github.com/dand @jwodder listed needed properties and metadata fields: * Asset properties used by dandidav: - * `asset_id` + * `asset_id` (PRESENT) * `blob_id` * `zarr_id` * `path` - * `size` - * `created` - * `modified` + * `size` (PRESENT) + * `created` (GOOD TO HAVE) + * `modified` (SUGGESTED to be included) * Note: It might be more accurate to use the `blobDateModified` metadata field for this instead; cf. dandi/dandidav#17 * Asset metadata used by dandidav: - * `encodingFormat` (blobs only) - * `contentUrl` (API download URL for blobs, S3 URL for Zarrs) + * `encodingFormat` (blobs only) (STRONGLY DESIRED but not REQUIRED) + * `contentUrl` (API download URL for blobs, S3 URL for Zarrs) (INCLUDED) * `digest["dandi:dandi-etag"]` (blobs only) From e3c4500e1ba6c69a03426c0abd15e7bf4fb81fa2 Mon Sep 17 00:00:00 2001 From: Yaroslav Halchenko Date: Thu, 1 Feb 2024 16:02:14 -0500 Subject: [PATCH 3/4] Forgotten path --- doc/design/paths-endpoint-webdav.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/design/paths-endpoint-webdav.md b/doc/design/paths-endpoint-webdav.md index 5e9211ea9..4d1eeb1cb 100644 --- a/doc/design/paths-endpoint-webdav.md +++ b/doc/design/paths-endpoint-webdav.md @@ -9,7 +9,7 @@ Submitted as a PR to avoid spagetti thread discussion on https://github.com/dand * `asset_id` (PRESENT) * `blob_id` * `zarr_id` - * `path` + * `path` (PRESENT) * `size` (PRESENT) * `created` (GOOD TO HAVE) * `modified` (SUGGESTED to be included) From 9994f2c24990b13e17a0b6356ebf2bbfa546f915 Mon Sep 17 00:00:00 2001 From: Yaroslav Halchenko Date: Fri, 2 Feb 2024 15:20:18 -0500 Subject: [PATCH 4/4] codespell ;) Co-authored-by: John T. Wodder II --- doc/design/paths-endpoint-webdav.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/design/paths-endpoint-webdav.md b/doc/design/paths-endpoint-webdav.md index 4d1eeb1cb..83d236d60 100644 --- a/doc/design/paths-endpoint-webdav.md +++ b/doc/design/paths-endpoint-webdav.md @@ -1,6 +1,6 @@ # Discussion on metadata needed for dandidav -Submitted as a PR to avoid spagetti thread discussion on https://github.com/dandi/dandi-archive/issues/1837#issuecomment-1921864949 +Submitted as a PR to avoid spaghetti thread discussion on https://github.com/dandi/dandi-archive/issues/1837#issuecomment-1921864949 @jwodder listed needed properties and metadata fields: