Skip to content
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

update docs for changesheet validator to include remove action #499

Merged
merged 3 commits into from
Mar 20, 2024
Merged

update docs for changesheet validator to include remove action #499

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8685f81
update changesheet docs to include `remove` action
Mar 20, 2024
6076b57
Update author-changesheets.md
dwinston Mar 20, 2024
4411aff
Update author-changesheets.md
dwinston Mar 20, 2024
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
3 changes: 2 additions & 1 deletion docs/howto-guides/author-changesheets.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,8 @@ flowchart LR;
* `id`: The *id* value corresponding to the *id* of the JSON document in the database. Specifying this will tell the changesheet what record in the database needs to be modified. There are no restrictions on the ids that can be modified. For example, it can be a Biosample *id* (with typecode *bsm*), or a Study *id* (with typecode *sty*), or another class of *id*.
* `action`: The action to be performed on the database. It may be one of the following:
* `insert` / `insert item` / `insert items`: Add new values to a multivalued field, i.e., a field/key on a document which captures a list of values instead of single values.
* `remove item` / `remove items`: Remove attributes/keys on a document.
* `remove`: Drop a key/value pair for a single-value slot. Leave `value` field empty on changesheet.
* `remove item` / `remove items`: Remove item(s) from a list/set of values for a multivalued slot.
* `update` / `set` / `replace` / `replace items`: Update the value of a particular field/key on a document and replace it with a new value.
* `attribute`: the name of the field/key in the NMDC JSON document that is to be modified.
* `value`: New value, which may be added (if it wasn't present already) to a multi-valued field for an `insert` action. For an `update` action, it will overwrite any current value.
Expand Down