Project

General

Profile

Actions

Feature #21978

closed

Clarify replace_files API docs

Added by Tom Clegg about 2 months ago. Updated about 1 month ago.

Status:
Resolved
Priority:
Normal
Assigned To:
Category:
Documentation
Story points:
-
Release:
Release relationship:
Auto

Description

From #21701#note-17:

The documentation says a valid source is:

<PDH>/<path> where <PDH> is the portable data hash of a collection on the cluster

I assume "on the cluster" means I can't refer to collections on other clusters in a federation. But I think you have to be pretty deep in Arvados, and read very carefully, to recognize that. If I followed right, should we specifically call this out under the "Usage restrictions" section?

Does this limitation also apply to PDHs in the manifest_text? If so, that seems worth calling out too.

Under the update method header, the description for replace_files reads:

Delete and replace files and directories using content from other collections

With these changes this seems to narrow. The argument can do more than "delete and replace files and directories," and those operations can work on multiple data sources, not just "other collections." It would be nice to broaden this. I also recognize that it's a challenge to do this without making it almost uselessly generic. "Update this collection's contents by referencing collection manifests" maybe?


Subtasks 1 (0 open1 closed)

Task #21979: Review 21978-replace-files-docsResolvedTom Clegg07/22/2024Actions

Related issues

Related to Arvados - Feature #21701: replace_files requests can refer to "current version" and "provided manifest_text" as sourcesResolvedTom CleggActions
Actions #1

Updated by Tom Clegg about 2 months ago

  • Related to Feature #21701: replace_files requests can refer to "current version" and "provided manifest_text" as sources added
Actions #2

Updated by Tom Clegg about 1 month ago

21978-replace-files-docs @ 73e240feee5900d40e1e6132ffce568a166da6d8

as described:
  • add "usage restrictions" notes
  • update replace_files argument summary in create/update methods
Actions #3

Updated by Brett Smith about 1 month ago

Tom Clegg wrote in #note-2:

21978-replace-files-docs @ 73e240feee5900d40e1e6132ffce568a166da6d8

This looks good to me, thanks. I have pushed f45f3dea096eca5b2867f37c6060d1bf7626baf1 to the branch with a suggestion to streamline some markup, because doing that was easier than writing out my idea. Please take a look, and feel free to merge either with or without that commit.

Actions #4

Updated by Tom Clegg about 1 month ago

  • Status changed from In Progress to Resolved
Actions

Also available in: Atom PDF