Skip to content

Explain metadata registry requirement for PATCH paths #312

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
tdonohue merged 1 commit into from
Jun 27, 2025
Merged

Explain metadata registry requirement for PATCH paths #312

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
7 changes: 7 additions & 0 deletions metadata-patch.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,13 @@ The examples in each section below build on each other, assuming an initial meta
}
```

PATCH operations targeting metadata must specify a JSON `path` relative to the DSpace object, valid for the following levels:
- All metadata: `/metadata` → `value` must be an object (if applicable)
- All values of one metadata field: `/metadata/dc.title` → `value` must be an array (if applicable)
- One values of one metadata field: `/metadata/dc.title/0` → `value` must be an object (if applicable)

Any metadata field explicitly included in the `path` must be part the metadata registry. PATCH requests targeting unknown metadata fields will fail with HTTP 422 (unprocessable entity).

Note: The metadata of items _in submission_ is modeled in the same way described here -- as a map
of metadata keys to an ordered array of values. The primary difference is where the metadata
is located within the JSON representation. The documentation and examples below apply to archived
Expand Down