Skip to content
This repository was archived by the owner on Jun 4, 2025. It is now read-only.

Commit af1cb42

Browse files
vitormattosvitormattos
committed
Update documentation
Signed-off-by: Vitor Mattos <vitor@php.rio>
1 parent 35f22f4 commit af1cb42

File tree

3 files changed

+19
-19
lines changed

3 files changed

+19
-19
lines changed

‎site/.vuepress/public/Insomnia_2021-11-24.json‎

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

‎site/.vuepress/public/specs/api.yaml‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1048,7 +1048,7 @@ paths:
10481048
type: integer
10491049
description: Numeric code representing what action should be taken with the response.
10501050
example: 200
1051-
'/sign/file_id/{fileId}/{fileUserId}':
1051+
'/sign/file_id/{fileId}/{signRequestId}':
10521052
delete:
10531053
tags:
10541054
- sign
@@ -1059,7 +1059,7 @@ paths:
10591059
- basicAuth: []
10601060
parameters:
10611061
- $ref: '#/components/parameters/fileIdParam'
1062-
- name: fileUserId
1062+
- name: signRequestId
10631063
in: path
10641064
description: ID of relation between file and user.
10651065
required: true
@@ -1314,7 +1314,7 @@ paths:
13141314
- $ref: '#/components/schemas/elementCoordinate'
13151315
- type: object
13161316
properties:
1317-
fileUserId:
1317+
signRequestId:
13181318
type: string
13191319
nullable: true
13201320
description: Representative ID of relation between file and user
@@ -1372,15 +1372,15 @@ paths:
13721372
type: string
13731373
description: Nextcloud user id of who requested the file to be signed.
13741374
example: johndoe
1375-
fileUserId:
1375+
signRequestId:
13761376
type: integer
13771377
description: Relation between file and user
13781378
example: 1
13791379
required:
13801380
- signed
13811381
- fullName
13821382
- me
1383-
- fileUserId
1383+
- signRequestId
13841384
settings:
13851385
$ref: '#/components/schemas/signSettings'
13861386
messages:
@@ -1549,15 +1549,15 @@ paths:
15491549
type: string
15501550
description: Nextcloud user id of who requested the file to be signed.
15511551
example: johndoe
1552-
fileUserId:
1552+
signRequestId:
15531553
type: integer
15541554
description: ID of relation between file and user. Each relation between file and user has an ID that is returned on validation endpoints.
15551555
example: 1
15561556
required:
15571557
- signed
15581558
- fullName
15591559
- me
1560-
- fileUserId
1560+
- signRequestId
15611561
settings:
15621562
$ref: '#/components/schemas/signSettings'
15631563
messages:
@@ -1672,7 +1672,7 @@ paths:
16721672
properties:
16731673
fileElementId:
16741674
type: integer
1675-
description: 'Representative ID of relation between file, fileUser and the visible element on pdf'
1675+
description: 'Representative ID of relation between file, signRequest and the visible element on pdf'
16761676
required:
16771677
- fileElementId
16781678
'401':
@@ -1719,7 +1719,7 @@ paths:
17191719
properties:
17201720
fileElementId:
17211721
type: integer
1722-
description: 'Representative ID of relation between file, fileUser and the visible element on pdf'
1722+
description: 'Representative ID of relation between file, signRequest and the visible element on pdf'
17231723
required:
17241724
- fileElementId
17251725
'401':
@@ -2308,7 +2308,7 @@ components:
23082308
- email-link
23092309
- email-token
23102310
- sms-token
2311-
fileUserId:
2311+
signRequestId:
23122312
type: integer
23132313
description: ID of relation between file and user. Each relation between file and user has an ID that is returned on validation endpoints.
23142314
example: 1
@@ -2532,7 +2532,7 @@ components:
25322532
ury: 0
25332533
llx: 0
25342534
lly: 0
2535-
fileUserId: 123
2535+
signRequestId: 123
25362536
not:
25372537
required:
25382538
- coordinates
@@ -2551,12 +2551,12 @@ components:
25512551
- datetime
25522552
- text
25532553
example: signature
2554-
fileUserId:
2554+
signRequestId:
25552555
type: integer
2556-
description: 'Representative ID of relation between file, fileUser and the visible element on pdf'
2556+
description: 'Representative ID of relation between file, signRequest and the visible element on pdf'
25572557
example: 123
25582558
required:
2559-
- fileUserId
2559+
- signRequestId
25602560
pdfPage:
25612561
type: object
25622562
description: Metadata of PDF page on image format

‎site/Getting-started.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ You will receive the fileId or UUID, store this data to create visible elements.
7676

7777
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`
7878

79-
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.
79+
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.
8080

8181
```bash
8282
curl --request GET \
@@ -113,14 +113,14 @@ curl --request POST \
113113
"page": 1
114114
},
115115
"type": "signature",
116-
"fileUserId": 51
116+
"signRequestId": 51
117117
}'
118118
```
119119

120120
#### Update
121121
PATCH /file/{uuid}/elements/{elementId}
122122

123-
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
123+
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
124124

125125
```bash
126126
curl --request PATCH \
@@ -136,7 +136,7 @@ curl --request PATCH \
136136
"page": 1
137137
},
138138
"type": "signature",
139-
"fileUserId": 1
139+
"signRequestId": 1
140140
}'
141141
```
142142

0 commit comments

Comments
 (0)