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

Commit 9b47226

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

File tree

1 file changed

+135
-33
lines changed

1 file changed

+135
-33
lines changed

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

Lines changed: 135 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -863,38 +863,140 @@ paths:
863863
content:
864864
application/json:
865865
schema:
866-
allOf:
867-
- $ref: '#/components/schemas/libresignFileStatus'
868-
- type: object
869-
properties:
870-
uuid:
871-
type: string
872-
format: uuid
873-
description: Received from sign request
874-
file:
875-
$ref: '#/components/schemas/fileId'
876-
visibleElements:
877-
type: array
878-
description: Visible elements on document
879-
items:
880-
not:
881-
required:
882-
- coordinates
883-
allOf:
884-
- $ref: '#/components/schemas/pdfVisibleElement'
885-
- type: object
886-
properties:
887-
elementId:
888-
type: integer
889-
minimum: 1
890-
example: 1
891-
required:
892-
- elementId
893-
users:
894-
type: array
895-
description: Collection of users who must sign the document
896-
items:
897-
$ref: '#/components/schemas/signAccount'
866+
type: object
867+
properties:
868+
message:
869+
type: string
870+
description: Success message
871+
example: Success
872+
data:
873+
type: object
874+
properties:
875+
nodeId:
876+
type: integer
877+
description: Node id of a Nextcloud file
878+
example: 2312
879+
fileId:
880+
type: integer
881+
description: Node id of a Nextcloud file
882+
example: 2312
883+
file:
884+
type: string
885+
description: URL to download signed file
886+
example: 'http://cloud.test.coop/apps/libresign/pdf/46d30465-ae11-484b-aad5-327249a1e8ef'
887+
name:
888+
type: string
889+
example: filename
890+
description: The name of file to sign
891+
uuid:
892+
type: string
893+
format: uuid
894+
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.
895+
status:
896+
type: integer
897+
enum:
898+
- 0
899+
- 1
900+
- 2
901+
description: |
902+
Numeric code of status * 0 - no signers * 1 - signed * 2 - pending
903+
example: 1
904+
statusText:
905+
type: string
906+
description: Translated text of status
907+
example: able to sign
908+
request_date:
909+
type: string
910+
format: date-time
911+
pattern: '\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}'
912+
nullable: true
913+
description: Date the file was requested to be signed
914+
example: '2021-12-31 22:45:50'
915+
requested_by:
916+
$ref: '#/components/schemas/basicAccount'
917+
settings:
918+
$ref: '#/components/schemas/signSettings'
919+
signers:
920+
type: array
921+
description: Collection of users who must sign the document
922+
items:
923+
type: object
924+
description: Person who will sign
925+
properties:
926+
email:
927+
type: string
928+
format: email
929+
description: Unique email to identify user
930+
example: user@test.coop
931+
me:
932+
type: boolean
933+
description: It's me?
934+
example: true
935+
sign_uuid:
936+
type: string
937+
format: uuid
938+
description: 'Received from sign request, only returned when me=true'
939+
displayName:
940+
type: string
941+
nullable: true
942+
description: Persons name
943+
example: John Doe
944+
fullName:
945+
type: string
946+
description: The person full name
947+
example: John Doe
948+
nullable: true
949+
signed:
950+
type: string
951+
pattern: '\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}'
952+
description: 'Signing date, when signed'
953+
example: '2021-12-31 22:45:50'
954+
nullable: true
955+
identifyMethods:
956+
type: array
957+
items:
958+
type: object
959+
properties:
960+
method:
961+
type: string
962+
example: account
963+
description: The identify method name
964+
value:
965+
type: string
966+
example: signer1
967+
description: The value that identify the signer in the authentication method
968+
uid:
969+
type: string
970+
nullable: true
971+
description: Nextcloud user id of who requested the file to be signed when the person created account.
972+
example: johndoe
973+
description:
974+
type: string
975+
nullable: true
976+
description: Description that will be displayed to the person
977+
example: 'As the company''s CEO, you must sign this contract'
978+
sign_date:
979+
type: string
980+
format: date-time
981+
pattern: '\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}'
982+
nullable: true
983+
description: Date the file was signed
984+
example: '2021-12-31 22:45:50'
985+
identify:
986+
type: string
987+
nullable: true
988+
default: nextcloud
989+
example: nextcloud
990+
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.'
991+
enum:
992+
- nextcloud
993+
- email-link
994+
- email-token
995+
- sms-token
996+
signRequestId:
997+
type: integer
998+
description: ID of relation between file and user. Each relation between file and user has an ID that is returned on validation endpoints.
999+
example: 1request_sign_date
8981000
required: true
8991001
responses:
9001002
'200':
@@ -1624,7 +1726,7 @@ paths:
16241726
type: string
16251727
description: URL to download signed file
16261728
example: 'http://cloud.test.coop/apps/libresign/pdf/46d30465-ae11-484b-aad5-327249a1e8ef'
1627-
fileId:
1729+
nodeId:
16281730
type: integer
16291731
description: Node id of a Nextcloud file
16301732
example: 2312

0 commit comments

Comments
 (0)