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

Commit 226fe6c

Browse files
committed
Change field name at documentation after changes at code
Signed-off-by: Vitor Mattos <vitor@php.rio>
1 parent ce27c46 commit 226fe6c

File tree

1 file changed

+118
-1
lines changed

1 file changed

+118
-1
lines changed

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

Lines changed: 118 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -915,10 +915,127 @@ paths:
915915
type: integer
916916
description: Node id of a Nextcloud file
917917
example: 2312
918+
fileId:
919+
type: integer
920+
description: Node id of a Nextcloud file
921+
example: 2312
922+
file:
923+
type: string
924+
description: URL to download signed file
925+
example: 'http://cloud.test.coop/apps/libresign/pdf/46d30465-ae11-484b-aad5-327249a1e8ef'
926+
name:
927+
type: string
928+
example: filename
929+
description: The name of file to sign
918930
uuid:
919931
type: string
920932
format: uuid
921933
description: File identifier. It is necessary to keep it because it must be used to update or delete a signature request and will also be used in the callback request.
934+
status:
935+
type: integer
936+
enum:
937+
- 0
938+
- 1
939+
- 2
940+
description: |
941+
Numeric code of status * 0 - no signers * 1 - signed * 2 - pending
942+
example: 1
943+
statusText:
944+
type: string
945+
description: Translated text of status
946+
example: able to sign
947+
request_date:
948+
type: string
949+
format: date-time
950+
pattern: '\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}'
951+
nullable: true
952+
description: Date the file was requested to be signed
953+
example: '2021-12-31 22:45:50'
954+
requested_by:
955+
$ref: '#/components/schemas/basicAccount'
956+
settings:
957+
$ref: '#/components/schemas/signSettings'
958+
signers:
959+
type: array
960+
description: Collection of users who must sign the document
961+
items:
962+
type: object
963+
description: Person who will sign
964+
properties:
965+
email:
966+
type: string
967+
format: email
968+
description: Unique email to identify user
969+
example: user@test.coop
970+
me:
971+
type: boolean
972+
description: It's me?
973+
example: true
974+
sign_uuid:
975+
type: string
976+
format: uuid
977+
description: 'Received from sign request, only returned when me=true'
978+
displayName:
979+
type: string
980+
nullable: true
981+
description: Persons name
982+
example: John Doe
983+
fullName:
984+
type: string
985+
description: The person full name
986+
example: John Doe
987+
nullable: true
988+
signed:
989+
type: string
990+
pattern: '\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}'
991+
description: 'Signing date, when signed'
992+
example: '2021-12-31 22:45:50'
993+
nullable: true
994+
identifyMethods:
995+
type: array
996+
items:
997+
type: object
998+
properties:
999+
method:
1000+
type: string
1001+
example: account
1002+
description: The identify method name
1003+
value:
1004+
type: string
1005+
example: signer1
1006+
description: The value that identify the signer in the authentication method
1007+
uid:
1008+
type: string
1009+
nullable: true
1010+
description: Nextcloud user id of who requested the file to be signed when the person created account.
1011+
example: johndoe
1012+
description:
1013+
type: string
1014+
nullable: true
1015+
description: Description that will be displayed to the person
1016+
example: 'As the company''s CEO, you must sign this contract'
1017+
sign_date:
1018+
type: string
1019+
format: date-time
1020+
pattern: '\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}'
1021+
nullable: true
1022+
description: Date the file was signed
1023+
example: '2021-12-31 22:45:50'
1024+
identify:
1025+
type: string
1026+
nullable: true
1027+
default: nextcloud
1028+
example: nextcloud
1029+
description: 'When is requested to a person to sign a file, is necessary identify what is the identification method. The identification method is used to define how will be the sign flow.'
1030+
enum:
1031+
- nextcloud
1032+
- email-link
1033+
- email-token
1034+
- sms-token
1035+
signRequestId:
1036+
type: integer
1037+
description: ID of relation between file and user. Each relation between file and user has an ID that is returned on validation endpoints.
1038+
example: 1request_sign_date
9221039
'422':
9231040
description: Request failed
9241041
content:
@@ -1624,7 +1741,7 @@ paths:
16241741
type: string
16251742
description: URL to download signed file
16261743
example: 'http://cloud.test.coop/apps/libresign/pdf/46d30465-ae11-484b-aad5-327249a1e8ef'
1627-
fileId:
1744+
nodeId:
16281745
type: integer
16291746
description: Node id of a Nextcloud file
16301747
example: 2312

0 commit comments

Comments
 (0)