update docs for changesheet validator to include remove action (#499)

* update changesheet docs to include `remove` action * Update author-changesheets.md * Update author-changesheets.md --------- Co-authored-by: Jing <[email protected]> Co-authored-by: Donny Winston <[email protected]>
microbiomedata · Apr 19, 2024 · 2d42ddc · 2d42ddc
1 parent 3fbac74
commit 2d42ddc
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/docs/howto-guides/author-changesheets.md b/docs/howto-guides/author-changesheets.md
@@ -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.