Skip to content

docs: refer to aind-data-migration-scripts for updating docdb #207

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.

Sign up for GitHub

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

Merged
helen-m-lin merged 1 commit into from
Mar 3, 2026
Merged

docs: refer to aind-data-migration-scripts for updating docdb #207

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion docs/source/ExamplesDocDBRestApi.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://github.com/AllenNeuralDynamics/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.

Expand Down