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

Commit d23d461

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

File tree

1 file changed

+88
-48
lines changed

1 file changed

+88
-48
lines changed

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

Lines changed: 88 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
@@ -945,6 +962,23 @@ paths:
945962
type: string
946963
description: URL to view PDF
947964
example: 'http://cloud.test.coop/apps/libresign/pdf/46d30465-ae11-484b-aad5-327249a1e8ef'
965+
visibleElements:
966+
type: array
967+
description: Visible elements on document
968+
items:
969+
not:
970+
required:
971+
- coordinates
972+
allOf:
973+
- $ref: '#/components/schemas/pdfVisibleElement'
974+
- type: object
975+
properties:
976+
elementId:
977+
type: integer
978+
minimum: 1
979+
example: 1
980+
required:
981+
- elementId
948982
name:
949983
type: string
950984
example: filename
@@ -1618,23 +1652,25 @@ paths:
16181652
items:
16191653
$ref: '#/components/schemas/pdfPage'
16201654
visibleElements:
1655+
type: array
16211656
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
1657+
items:
1658+
allOf:
1659+
- $ref: '#/components/schemas/signatureElement'
1660+
- $ref: '#/components/schemas/elementCoordinate'
1661+
- type: object
1662+
properties:
1663+
signRequestId:
1664+
type: string
1665+
nullable: true
1666+
description: Representative ID of relation between file and user
1667+
example: johndoe
1668+
elementId:
1669+
type: integer
1670+
minimum: 1
1671+
example: 1
1672+
required:
1673+
- elementId
16381674
signers:
16391675
type: array
16401676
items:
@@ -1819,23 +1855,25 @@ paths:
18191855
items:
18201856
$ref: '#/components/schemas/pdfPage'
18211857
visibleElements:
1858+
type: array
18221859
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
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
18391877
signers:
18401878
type: array
18411879
items:
@@ -2018,23 +2056,25 @@ paths:
20182056
items:
20192057
$ref: '#/components/schemas/pdfPage'
20202058
visibleElements:
2059+
type: array
20212060
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
2061+
items:
2062+
allOf:
2063+
- $ref: '#/components/schemas/signatureElement'
2064+
- $ref: '#/components/schemas/elementCoordinate'
2065+
- type: object
2066+
properties:
2067+
uid:
2068+
type: string
2069+
description: Nextcloud user id to assign this visible element.
2070+
example: johndoe
2071+
nullable: true
2072+
elementId:
2073+
type: integer
2074+
minimum: 1
2075+
example: 1
2076+
required:
2077+
- elementId
20382078
signers:
20392079
type: array
20402080
items:

0 commit comments

Comments
 (0)