Update API documentation for multiple recipients.

strukturag · Nov 17, 2022 · c75dcd0 · c75dcd0
1 parent b09504d
commit c75dcd0
Showing 1 changed file with 14 additions and 2 deletions.
diff --git a/docs/api.md b/docs/api.md
@@ -15,8 +15,7 @@ Nextcloud instance.
     | field               | type    | description                                                      |
     |---------------------|---------|------------------------------------------------------------------|
     | `file_id`           | int     | The id of the file to be signed.                                 |
-    | `recipient`         | string  | User id or email address to share the document with.             |
-    | `recipient_type`    | string  | Type of recipient, can be `user` or `email`.                     |
+    | `recipients`        | array   | List of recipients to share the document with.                   |
     | `metadata`          | array   | JSON metadata to include in the request.                         |
 
 * Response:
@@ -32,6 +31,15 @@ Nextcloud instance.
     | `request_id`        | string  | The id of the signing request.                                   |
 
 
+Each `recipient` entry must contain the following fields:
+
+  | field               | type    | description                                                      |
+  |---------------------|---------|------------------------------------------------------------------|
+  | `type`              | string  | Type of recipient, can be `user` or `email`.                     |
+  | `user_id`           | string  | Userid (for type `user`).                                        |
+  | `email`             | string  | Email address (for type `email`).                                |
+
+
 The following fields are currently defined for the request `metadata` JSON:
 
   | field               | type    | description                                                      |
@@ -43,6 +51,10 @@ Signature fields objects must contain the keys `id` (unique id of the field),
 `page` (1-based page number), `x`, `y`, `width`, `height` with values
 based on the page viewport where the top left of the page is at `0` / `0`.
 
+If signatures are requested from multiple recipients, each signature field must
+contain a `recipient_idx` field with the (0-based) index of the recipient that
+should sign the field.
+
 
 ## Get list of files shared by current user