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

Commit 049c61f

Browse files
vitormattosvitormattos
committed
Add pending fields
Signed-off-by: Vitor Mattos <vitor@php.rio>
1 parent 8069976 commit 049c61f

File tree

1 file changed

+82
-18
lines changed

1 file changed

+82
-18
lines changed

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

Lines changed: 82 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -721,6 +721,10 @@ paths:
721721
type: string
722722
description: URL to download signed file
723723
example: 'http://cloud.test.coop/apps/libresign/pdf/46d30465-ae11-484b-aad5-327249a1e8ef'
724+
url:
725+
type: string
726+
description: URL to view PDF
727+
example: 'http://cloud.test.coop/apps/libresign/pdf/46d30465-ae11-484b-aad5-327249a1e8ef'
724728
name:
725729
type: string
726730
example: filename
@@ -800,6 +804,12 @@ paths:
800804
description: 'Signing date, when signed'
801805
example: '2021-12-31 22:45:50'
802806
nullable: true
807+
request_sign_date:
808+
type: string
809+
format: date-time
810+
pattern: '\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}'
811+
description: Date the signature was requested
812+
example: '2021-12-31 22:45:50'
803813
identifyMethods:
804814
type: array
805815
items:
@@ -827,13 +837,6 @@ paths:
827837
nullable: true
828838
description: Description that will be displayed to the person
829839
example: 'As the company''s CEO, you must sign this contract'
830-
sign_date:
831-
type: string
832-
format: date-time
833-
pattern: '\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}'
834-
nullable: true
835-
description: Date the file was signed
836-
example: '2021-12-31 22:45:50'
837840
identify:
838841
type: string
839842
nullable: true
@@ -848,7 +851,7 @@ paths:
848851
signRequestId:
849852
type: integer
850853
description: ID of relation between file and user. Each relation between file and user has an ID that is returned on validation endpoints.
851-
example: 1request_sign_date
854+
example: request_sign_date
852855
'422':
853856
description: Request failed
854857
content:
@@ -938,6 +941,10 @@ paths:
938941
type: string
939942
description: URL to download signed file
940943
example: 'http://cloud.test.coop/apps/libresign/pdf/46d30465-ae11-484b-aad5-327249a1e8ef'
944+
url:
945+
type: string
946+
description: URL to view PDF
947+
example: 'http://cloud.test.coop/apps/libresign/pdf/46d30465-ae11-484b-aad5-327249a1e8ef'
941948
name:
942949
type: string
943950
example: filename
@@ -1017,6 +1024,12 @@ paths:
10171024
description: 'Signing date, when signed'
10181025
example: '2021-12-31 22:45:50'
10191026
nullable: true
1027+
request_sign_date:
1028+
type: string
1029+
format: date-time
1030+
pattern: '\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}'
1031+
description: Date the signature was requested
1032+
example: '2021-12-31 22:45:50'
10201033
identifyMethods:
10211034
type: array
10221035
items:
@@ -1044,13 +1057,6 @@ paths:
10441057
nullable: true
10451058
description: Description that will be displayed to the person
10461059
example: 'As the company''s CEO, you must sign this contract'
1047-
sign_date:
1048-
type: string
1049-
format: date-time
1050-
pattern: '\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}'
1051-
nullable: true
1052-
description: Date the file was signed
1053-
example: '2021-12-31 22:45:50'
10541060
identify:
10551061
type: string
10561062
nullable: true
@@ -1065,7 +1071,7 @@ paths:
10651071
signRequestId:
10661072
type: integer
10671073
description: ID of relation between file and user. Each relation between file and user has an ID that is returned on validation endpoints.
1068-
example: 1request_sign_date
1074+
example: request_sign_date
10691075
'422':
10701076
description: Request failed
10711077
content:
@@ -1640,6 +1646,12 @@ paths:
16401646
description: 'Signing date, when signed'
16411647
example: '2021-12-31 22:45:50'
16421648
nullable: true
1649+
request_sign_date:
1650+
type: string
1651+
format: date-time
1652+
pattern: '\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}'
1653+
description: Date the signature was requested
1654+
example: '2021-12-31 22:45:50'
16431655
displayName:
16441656
type: string
16451657
description: The person display name
@@ -1649,6 +1661,10 @@ paths:
16491661
type: boolean
16501662
description: It's me?
16511663
example: true
1664+
sign_uuid:
1665+
type: string
1666+
format: uuid
1667+
description: 'Received from sign request, only returned when me=true'
16521668
identifyMethods:
16531669
type: array
16541670
items:
@@ -1675,6 +1691,11 @@ paths:
16751691
type: string
16761692
description: Nextcloud user id of who requested the file to be signed.
16771693
example: johndoe
1694+
description:
1695+
type: string
1696+
nullable: true
1697+
description: Description that will be displayed to the person
1698+
example: 'As the company''s CEO, you must sign this contract'
16781699
signRequestId:
16791700
type: integer
16801701
description: Relation between file and user
@@ -1769,6 +1790,10 @@ paths:
17691790
type: string
17701791
description: URL to download signed file
17711792
example: 'http://cloud.test.coop/apps/libresign/pdf/46d30465-ae11-484b-aad5-327249a1e8ef'
1793+
url:
1794+
type: string
1795+
description: URL to view PDF
1796+
example: 'http://cloud.test.coop/apps/libresign/pdf/46d30465-ae11-484b-aad5-327249a1e8ef'
17721797
nodeId:
17731798
type: integer
17741799
description: Node id of a Nextcloud file
@@ -1822,6 +1847,12 @@ paths:
18221847
description: 'Signing date, when signed'
18231848
example: '2021-12-31 22:45:50'
18241849
nullable: true
1850+
request_sign_date:
1851+
type: string
1852+
format: date-time
1853+
pattern: '\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}'
1854+
description: Date the signature was requested
1855+
example: '2021-12-31 22:45:50'
18251856
displayName:
18261857
type: string
18271858
description: The person display name
@@ -1831,6 +1862,10 @@ paths:
18311862
type: boolean
18321863
description: It's me?
18331864
example: true
1865+
sign_uuid:
1866+
type: string
1867+
format: uuid
1868+
description: 'Received from sign request, only returned when me=true'
18341869
identifyMethods:
18351870
type: array
18361871
items:
@@ -1857,6 +1892,11 @@ paths:
18571892
type: string
18581893
description: Nextcloud user id of who requested the file to be signed.
18591894
example: johndoe
1895+
description:
1896+
type: string
1897+
nullable: true
1898+
description: Description that will be displayed to the person
1899+
example: 'As the company''s CEO, you must sign this contract'
18601900
signRequestId:
18611901
type: integer
18621902
description: Relation between file and user
@@ -1951,6 +1991,10 @@ paths:
19511991
type: string
19521992
description: URL to download signed file
19531993
example: 'http://cloud.test.coop/apps/libresign/pdf/46d30465-ae11-484b-aad5-327249a1e8ef'
1994+
url:
1995+
type: string
1996+
description: URL to view PDF
1997+
example: 'http://cloud.test.coop/apps/libresign/pdf/46d30465-ae11-484b-aad5-327249a1e8ef'
19541998
fileId:
19551999
type: integer
19562000
description: Node id of a Nextcloud file
@@ -1960,7 +2004,12 @@ paths:
19602004
format: uuid
19612005
description: Received from sign request
19622006
request_date:
1963-
type: integer
2007+
type: string
2008+
format: date-time
2009+
pattern: '\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}'
2010+
nullable: true
2011+
description: Date the file was requested to be signed
2012+
example: '2021-12-31 22:45:50'
19642013
pages:
19652014
type: array
19662015
description: |-
@@ -1997,6 +2046,12 @@ paths:
19972046
description: 'Signing date, when signed'
19982047
example: '2021-12-31 22:45:50'
19992048
nullable: true
2049+
request_sign_date:
2050+
type: string
2051+
format: date-time
2052+
pattern: '\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}'
2053+
description: Date the signature was requested
2054+
example: '2021-12-31 22:45:50'
20002055
displayName:
20012056
type: string
20022057
description: The person display name
@@ -2006,6 +2061,10 @@ paths:
20062061
type: boolean
20072062
description: It's me?
20082063
example: true
2064+
sign_uuid:
2065+
type: string
2066+
format: uuid
2067+
description: 'Received from sign request, only returned when me=true'
20092068
identifyMethods:
20102069
type: array
20112070
items:
@@ -2032,6 +2091,11 @@ paths:
20322091
type: string
20332092
description: Nextcloud user id of who requested the file to be signed.
20342093
example: johndoe
2094+
description:
2095+
type: string
2096+
nullable: true
2097+
description: Description that will be displayed to the person
2098+
example: 'As the company''s CEO, you must sign this contract'
20352099
signRequestId:
20362100
type: integer
20372101
description: ID of relation between file and user. Each relation between file and user has an ID that is returned on validation endpoints.
@@ -2763,7 +2827,7 @@ components:
27632827
nullable: true
27642828
description: Description that will be displayed to the person
27652829
example: 'As the company''s CEO, you must sign this contract'
2766-
sign_date:
2830+
signed:
27672831
type: string
27682832
format: date-time
27692833
pattern: '\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}'

0 commit comments

Comments
 (0)