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

Commit 308d775

Browse files
vitormattosvitormattos
committed
Move visible elements to new place
Signed-off-by: Vitor Mattos <vitor@php.rio>
1 parent ef890fa commit 308d775

File tree

1 file changed

+100
-94
lines changed

1 file changed

+100
-94
lines changed

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

Lines changed: 100 additions & 94 deletions
Original file line numberDiff line numberDiff line change
@@ -725,23 +725,6 @@ paths:
725725
type: string
726726
description: URL to view PDF
727727
example: 'http://cloud.test.coop/apps/libresign/pdf/46d30465-ae11-484b-aad5-327249a1e8ef'
728-
visibleElements:
729-
type: array
730-
description: Visible elements on document
731-
items:
732-
not:
733-
required:
734-
- coordinates
735-
allOf:
736-
- $ref: '#/components/schemas/pdfVisibleElement'
737-
- type: object
738-
properties:
739-
elementId:
740-
type: integer
741-
minimum: 1
742-
example: 1
743-
required:
744-
- elementId
745728
name:
746729
type: string
747730
example: filename
@@ -843,6 +826,26 @@ paths:
843826
type: integer
844827
example: 1
845828
description: is this sign method mandatory?
829+
visibleElements:
830+
type: array
831+
description: Visible elements on document
832+
items:
833+
allOf:
834+
- $ref: '#/components/schemas/signatureElement'
835+
- $ref: '#/components/schemas/elementCoordinate'
836+
- type: object
837+
properties:
838+
signRequestId:
839+
type: string
840+
nullable: true
841+
description: Representative ID of relation between file and user
842+
example: johndoe
843+
elementId:
844+
type: integer
845+
minimum: 1
846+
example: 1
847+
required:
848+
- elementId
846849
uid:
847850
type: string
848851
nullable: true
@@ -961,23 +964,6 @@ paths:
961964
type: string
962965
description: URL to view PDF
963966
example: 'http://cloud.test.coop/apps/libresign/pdf/46d30465-ae11-484b-aad5-327249a1e8ef'
964-
visibleElements:
965-
type: array
966-
description: Visible elements on document
967-
items:
968-
not:
969-
required:
970-
- coordinates
971-
allOf:
972-
- $ref: '#/components/schemas/pdfVisibleElement'
973-
- type: object
974-
properties:
975-
elementId:
976-
type: integer
977-
minimum: 1
978-
example: 1
979-
required:
980-
- elementId
981967
name:
982968
type: string
983969
example: filename
@@ -1079,6 +1065,26 @@ paths:
10791065
type: integer
10801066
example: 1
10811067
description: is this sign method mandatory?
1068+
visibleElements:
1069+
type: array
1070+
description: Visible elements on document
1071+
items:
1072+
allOf:
1073+
- $ref: '#/components/schemas/signatureElement'
1074+
- $ref: '#/components/schemas/elementCoordinate'
1075+
- type: object
1076+
properties:
1077+
signRequestId:
1078+
type: string
1079+
nullable: true
1080+
description: Representative ID of relation between file and user
1081+
example: johndoe
1082+
elementId:
1083+
type: integer
1084+
minimum: 1
1085+
example: 1
1086+
required:
1087+
- elementId
10821088
uid:
10831089
type: string
10841090
nullable: true
@@ -1652,26 +1658,6 @@ paths:
16521658
This property only will be returned when the query param format=image
16531659
items:
16541660
$ref: '#/components/schemas/pdfPage'
1655-
visibleElements:
1656-
type: array
1657-
description: Visible elements on document
1658-
items:
1659-
allOf:
1660-
- $ref: '#/components/schemas/signatureElement'
1661-
- $ref: '#/components/schemas/elementCoordinate'
1662-
- type: object
1663-
properties:
1664-
signRequestId:
1665-
type: string
1666-
nullable: true
1667-
description: Representative ID of relation between file and user
1668-
example: johndoe
1669-
elementId:
1670-
type: integer
1671-
minimum: 1
1672-
example: 1
1673-
required:
1674-
- elementId
16751661
signers:
16761662
type: array
16771663
items:
@@ -1854,26 +1840,6 @@ paths:
18541840
This property only will be returned when the query param format=image
18551841
items:
18561842
$ref: '#/components/schemas/pdfPage'
1857-
visibleElements:
1858-
type: array
1859-
description: Visible elements on document
1860-
items:
1861-
allOf:
1862-
- $ref: '#/components/schemas/signatureElement'
1863-
- $ref: '#/components/schemas/elementCoordinate'
1864-
- type: object
1865-
properties:
1866-
signRequestId:
1867-
type: string
1868-
nullable: true
1869-
description: Representative ID of relation between file and user
1870-
example: johndoe
1871-
elementId:
1872-
type: integer
1873-
minimum: 1
1874-
example: 1
1875-
required:
1876-
- elementId
18771843
signers:
18781844
type: array
18791845
items:
@@ -1937,6 +1903,26 @@ paths:
19371903
signRequestId:
19381904
type: integer
19391905
description: Relation between file and user
1906+
visibleElements:
1907+
type: array
1908+
description: Visible elements on document
1909+
items:
1910+
allOf:
1911+
- $ref: '#/components/schemas/signatureElement'
1912+
- $ref: '#/components/schemas/elementCoordinate'
1913+
- type: object
1914+
properties:
1915+
signRequestId:
1916+
type: string
1917+
nullable: true
1918+
description: Representative ID of relation between file and user
1919+
example: johndoe
1920+
elementId:
1921+
type: integer
1922+
minimum: 1
1923+
example: 1
1924+
required:
1925+
- elementId
19401926
example: 1
19411927
required:
19421928
- signed
@@ -2054,26 +2040,6 @@ paths:
20542040
This property only will be returned when the query param format=image
20552041
items:
20562042
$ref: '#/components/schemas/pdfPage'
2057-
visibleElements:
2058-
type: array
2059-
description: Visible elements on document
2060-
items:
2061-
allOf:
2062-
- $ref: '#/components/schemas/signatureElement'
2063-
- $ref: '#/components/schemas/elementCoordinate'
2064-
- type: object
2065-
properties:
2066-
uid:
2067-
type: string
2068-
description: Nextcloud user id to assign this visible element.
2069-
example: johndoe
2070-
nullable: true
2071-
elementId:
2072-
type: integer
2073-
minimum: 1
2074-
example: 1
2075-
required:
2076-
- elementId
20772043
signers:
20782044
type: array
20792045
items:
@@ -2138,6 +2104,26 @@ paths:
21382104
type: integer
21392105
description: ID of relation between file and user. Each relation between file and user has an ID that is returned on validation endpoints.
21402106
example: 1
2107+
visibleElements:
2108+
type: array
2109+
description: Visible elements on document
2110+
items:
2111+
allOf:
2112+
- $ref: '#/components/schemas/signatureElement'
2113+
- $ref: '#/components/schemas/elementCoordinate'
2114+
- type: object
2115+
properties:
2116+
uid:
2117+
type: string
2118+
description: Nextcloud user id to assign this visible element.
2119+
example: johndoe
2120+
nullable: true
2121+
elementId:
2122+
type: integer
2123+
minimum: 1
2124+
example: 1
2125+
required:
2126+
- elementId
21412127
required:
21422128
- signed
21432129
- me
@@ -2892,6 +2878,26 @@ components:
28922878
type: integer
28932879
description: ID of relation between file and user. Each relation between file and user has an ID that is returned on validation endpoints.
28942880
example: 1
2881+
visibleElements:
2882+
type: array
2883+
description: Visible elements on document
2884+
items:
2885+
allOf:
2886+
- $ref: '#/components/schemas/signatureElement'
2887+
- $ref: '#/components/schemas/elementCoordinate'
2888+
- type: object
2889+
properties:
2890+
signRequestId:
2891+
type: string
2892+
nullable: true
2893+
description: Representative ID of relation between file and user
2894+
example: johndoe
2895+
elementId:
2896+
type: integer
2897+
minimum: 1
2898+
example: 1
2899+
required:
2900+
- elementId
28952901
required:
28962902
- email
28972903
- request_sign_date

0 commit comments

Comments
 (0)