From 6e1e4f268c32857fbe12e52f537e2f2b467f919a Mon Sep 17 00:00:00 2001 From: helen-m-lin <46795546+helen-m-lin@users.noreply.github.com> Date: Tue, 3 Mar 2026 10:09:37 -0800 Subject: [PATCH] docs: refer to aind-data-migration-scripts for updating docdb --- docs/source/ExamplesDocDBRestApi.rst | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/docs/source/ExamplesDocDBRestApi.rst b/docs/source/ExamplesDocDBRestApi.rst index 0fcdab6..3a6a142 100644 --- a/docs/source/ExamplesDocDBRestApi.rst +++ b/docs/source/ExamplesDocDBRestApi.rst @@ -192,9 +192,16 @@ It's possible to attach a custom Session to retry certain requests errors: Updating Metadata ~~~~~~~~~~~~~~~~~~~~~~ +.. note:: + + Manual updates to metadata in DocDB should be made through the + `aind-data-migration-scripts `_ + repository to track changes. Please see the README in that repository for instructions. + + For special use cases, a minimal example of updating metadata directly using the API is provided below. 1. **Permissions**: Request permissions for AWS Credentials to write to DocDB through the API Gateway. -Note that the asset de/registration endpoints are intended for administrative use and require elevated AWS credentials/permissions. + Note that the asset de/registration endpoints are intended for administrative use and require elevated AWS credentials/permissions. 2. **Query DocDB**: Filter for the records you want to update. 3. **Update DocDB**: Use ``upsert_one_docdb_record`` or ``upsert_list_of_docdb_records`` to update the records.