Update documentation

Signed-off-by: Vitor Mattos <[email protected]>
LibreSign · Nov 3, 2023 · af1cb42 · af1cb42
1 parent 35f22f4
commit af1cb42
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 19 deletions.
diff --git a/site/.vuepress/public/Insomnia_2021-11-24.json b/site/.vuepress/public/Insomnia_2021-11-24.json
diff --git a/site/.vuepress/public/specs/api.yaml b/site/.vuepress/public/specs/api.yaml
@@ -1048,7 +1048,7 @@ paths:
                     type: integer
                     description: Numeric code representing what action should be taken with the response.
                     example: 200
-  '/sign/file_id/{fileId}/{fileUserId}':
+  '/sign/file_id/{fileId}/{signRequestId}':
     delete:
       tags:
         - sign
@@ -1059,7 +1059,7 @@ paths:
         - basicAuth: []
       parameters:
         - $ref: '#/components/parameters/fileIdParam'
-        - name: fileUserId
+        - name: signRequestId
           in: path
           description: ID of relation between file and user.
           required: true
@@ -1314,7 +1314,7 @@ paths:
                           - $ref: '#/components/schemas/elementCoordinate'
                           - type: object
                             properties:
-                              fileUserId:
+                              signRequestId:
                                 type: string
                                 nullable: true
                                 description: Representative ID of relation between file and user
@@ -1372,15 +1372,15 @@ paths:
                               type: string
                               description: Nextcloud user id of who requested the file to be signed.
                               example: johndoe
-                            fileUserId:
+                            signRequestId:
                               type: integer
                               description: Relation between file and user
                               example: 1
                           required:
                             - signed
                             - fullName
                             - me
-                            - fileUserId
+                            - signRequestId
                       settings:
                         $ref: '#/components/schemas/signSettings'
                       messages:
@@ -1549,15 +1549,15 @@ paths:
                               type: string
                               description: Nextcloud user id of who requested the file to be signed.
                               example: johndoe
-                            fileUserId:
+                            signRequestId:
                               type: integer
                               description: ID of relation between file and user. Each relation between file and user has an ID that is returned on validation endpoints.
                               example: 1
                           required:
                             - signed
                             - fullName
                             - me
-                            - fileUserId
+                            - signRequestId
                       settings:
                         $ref: '#/components/schemas/signSettings'
                       messages:
@@ -1672,7 +1672,7 @@ paths:
                 properties:
                   fileElementId:
                     type: integer
-                    description: 'Representative ID of relation between file, fileUser and the visible element on pdf'
+                    description: 'Representative ID of relation between file, signRequest and the visible element on pdf'
                 required:
                   - fileElementId
         '401':
@@ -1719,7 +1719,7 @@ paths:
                 properties:
                   fileElementId:
                     type: integer
-                    description: 'Representative ID of relation between file, fileUser and the visible element on pdf'
+                    description: 'Representative ID of relation between file, signRequest and the visible element on pdf'
                 required:
                   - fileElementId
         '401':
@@ -2308,7 +2308,7 @@ components:
                   - email-link
                   - email-token
                   - sms-token
-              fileUserId:
+              signRequestId:
                 type: integer
                 description: ID of relation between file and user. Each relation between file and user has an ID that is returned on validation endpoints.
                 example: 1
@@ -2532,7 +2532,7 @@ components:
             ury: 0
             llx: 0
             lly: 0
-          fileUserId: 123
+          signRequestId: 123
       not:
         required:
           - coordinates
@@ -2551,12 +2551,12 @@ components:
                 - datetime
                 - text
               example: signature
-            fileUserId:
+            signRequestId:
               type: integer
-              description: 'Representative ID of relation between file, fileUser and the visible element on pdf'
+              description: 'Representative ID of relation between file, signRequest and the visible element on pdf'
               example: 123
           required:
-            - fileUserId
+            - signRequestId
     pdfPage:
       type: object
       description: Metadata of PDF page on image format

diff --git a/site/Getting-started.md b/site/Getting-started.md
@@ -76,7 +76,7 @@ You will receive the fileId or UUID, store this data to create visible elements.
 
 Get data of a specific file, you can use `file_id` or `uuid` on path, both data you will receive after request to `POST /request-signature`
 
-The association between user and file will result on a `fileUserId`. You will need this to sign the document or define the page and coordinates of place that the signature of the user will be filled.
+The association between user and file will result on a `signRequestId`. You will need this to sign the document or define the page and coordinates of place that the signature of the user will be filled.
 
 ```bash
 curl --request GET \
@@ -113,14 +113,14 @@ curl --request POST \
         "page": 1
     },
     "type": "signature",
-    "fileUserId": 51
+    "signRequestId": 51
 }'
 ```
 
 #### Update
 PATCH /file/{uuid}/elements/{elementId}
 
-The UUID you will receive when you will do a request to `POST /request-signature` and the `fileUserId` is the relation between an user and the file to sign. You can check the `fileUserId` doing a request to /validate
+The UUID you will receive when you will do a request to `POST /request-signature` and the `signRequestId` is the relation between an user and the file to sign. You can check the `signRequestId` doing a request to /validate
 
 ```bash
 curl --request PATCH \
@@ -136,7 +136,7 @@ curl --request PATCH \
         "page": 1
     },
     "type": "signature",
-    "fileUserId": 1
+    "signRequestId": 1
 }'
 ```