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

Commit 98db843

Browse files
committed
Fix documentation
Signed-off-by: Vitor Mattos <vitor@php.rio>
1 parent 049c61f commit 98db843

File tree

1 file changed

+71
-48
lines changed

1 file changed

+71
-48
lines changed

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

Lines changed: 71 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -725,6 +725,23 @@ 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
728745
name:
729746
type: string
730747
example: filename
@@ -1618,23 +1635,25 @@ paths:
16181635
items:
16191636
$ref: '#/components/schemas/pdfPage'
16201637
visibleElements:
1638+
type: array
16211639
description: Visible elements on document
1622-
allOf:
1623-
- $ref: '#/components/schemas/signatureElement'
1624-
- $ref: '#/components/schemas/elementCoordinate'
1625-
- type: object
1626-
properties:
1627-
signRequestId:
1628-
type: string
1629-
nullable: true
1630-
description: Representative ID of relation between file and user
1631-
example: johndoe
1632-
elementId:
1633-
type: integer
1634-
minimum: 1
1635-
example: 1
1636-
required:
1637-
- elementId
1640+
items:
1641+
allOf:
1642+
- $ref: '#/components/schemas/signatureElement'
1643+
- $ref: '#/components/schemas/elementCoordinate'
1644+
- type: object
1645+
properties:
1646+
signRequestId:
1647+
type: string
1648+
nullable: true
1649+
description: Representative ID of relation between file and user
1650+
example: johndoe
1651+
elementId:
1652+
type: integer
1653+
minimum: 1
1654+
example: 1
1655+
required:
1656+
- elementId
16381657
signers:
16391658
type: array
16401659
items:
@@ -1819,23 +1838,25 @@ paths:
18191838
items:
18201839
$ref: '#/components/schemas/pdfPage'
18211840
visibleElements:
1841+
type: array
18221842
description: Visible elements on document
1823-
allOf:
1824-
- $ref: '#/components/schemas/signatureElement'
1825-
- $ref: '#/components/schemas/elementCoordinate'
1826-
- type: object
1827-
properties:
1828-
signRequestId:
1829-
type: string
1830-
nullable: true
1831-
description: Representative ID of relation between file and user
1832-
example: johndoe
1833-
elementId:
1834-
type: integer
1835-
minimum: 1
1836-
example: 1
1837-
required:
1838-
- elementId
1843+
items:
1844+
allOf:
1845+
- $ref: '#/components/schemas/signatureElement'
1846+
- $ref: '#/components/schemas/elementCoordinate'
1847+
- type: object
1848+
properties:
1849+
signRequestId:
1850+
type: string
1851+
nullable: true
1852+
description: Representative ID of relation between file and user
1853+
example: johndoe
1854+
elementId:
1855+
type: integer
1856+
minimum: 1
1857+
example: 1
1858+
required:
1859+
- elementId
18391860
signers:
18401861
type: array
18411862
items:
@@ -2018,23 +2039,25 @@ paths:
20182039
items:
20192040
$ref: '#/components/schemas/pdfPage'
20202041
visibleElements:
2042+
type: array
20212043
description: Visible elements on document
2022-
allOf:
2023-
- $ref: '#/components/schemas/signatureElement'
2024-
- $ref: '#/components/schemas/elementCoordinate'
2025-
- type: object
2026-
properties:
2027-
uid:
2028-
type: string
2029-
description: Nextcloud user id to assign this visible element.
2030-
example: johndoe
2031-
nullable: true
2032-
elementId:
2033-
type: integer
2034-
minimum: 1
2035-
example: 1
2036-
required:
2037-
- elementId
2044+
items:
2045+
allOf:
2046+
- $ref: '#/components/schemas/signatureElement'
2047+
- $ref: '#/components/schemas/elementCoordinate'
2048+
- type: object
2049+
properties:
2050+
uid:
2051+
type: string
2052+
description: Nextcloud user id to assign this visible element.
2053+
example: johndoe
2054+
nullable: true
2055+
elementId:
2056+
type: integer
2057+
minimum: 1
2058+
example: 1
2059+
required:
2060+
- elementId
20382061
signers:
20392062
type: array
20402063
items:

0 commit comments

Comments
 (0)