Updated entity actions in api docs

getodk · Oct 17, 2023 · f7bf685 · f7bf685
1 parent 9f59dea
commit f7bf685
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 3 deletions.
diff --git a/docs/api.yaml b/docs/api.yaml
@@ -814,7 +814,10 @@ tags:
     * `dataset.update` when a Dataset is updated.
     * `dataset.update.publish` when a Dataset is published.
     * `entity.create` when an Entity is created.
-    * `entity.error` when there is an error during entity creation process.
+    * `entity.error` when there is an error processing a Submission to create or update an Entity.
+    * `entity.update.version` when an Entity is updated.
+    * `entity.update.resolve` when an Entity conflict is resolved.
+    * `entity.delete` when an Entity is deleted.
     * `config.set` when a system configuration is set.
     * `analytics` when a Usage Report is attempted.
     * Deprecated: `backup` when a backup operation is attempted for Google Drive backups.

diff --git a/test/integration/worker/entity.js b/test/integration/worker/entity.js
@@ -574,7 +574,7 @@ describe('worker: entity', () => {
         should.exist(subEvent.processed);
         subEvent.failures.should.equal(0);
 
-        // the entity creation error should be logged
+        // the entity processing error should be logged
         const event = await container.Audits.getLatestByAction('entity.error').then((o) => o.get());
         event.actorId.should.equal(5); // Alice
         event.details.submissionId.should.equal(subEvent.details.submissionId);
@@ -614,7 +614,7 @@ describe('worker: entity', () => {
         should.exist(subEvent.processed);
         subEvent.failures.should.equal(0);
 
-        // the entity creation error should be logged
+        // the entity processing error should be logged
         const event = await container.Audits.getLatestByAction('entity.error').then((o) => o.get());
         event.actorId.should.equal(5); // Alice
         event.details.submissionId.should.equal(subEvent.details.submissionId);