Fix documentation

Signed-off-by: Vitor Mattos <vitor@php.rio>
LibreSign · Feb 28, 2024 · 6d7ff4c · 6d7ff4c
1 parent 049c61f
commit 6d7ff4c
Showing 1 changed file with 54 additions and 48 deletions.
diff --git a/site/.vuepress/public/specs/api.yaml b/site/.vuepress/public/specs/api.yaml
@@ -1618,23 +1618,25 @@ paths:
                         items:
                           $ref: '#/components/schemas/pdfPage'
                       visibleElements:
+                        type: array
                         description: Visible elements on document
-                        allOf:
-                          - $ref: '#/components/schemas/signatureElement'
-                          - $ref: '#/components/schemas/elementCoordinate'
-                          - type: object
-                            properties:
-                              signRequestId:
-                                type: string
-                                nullable: true
-                                description: Representative ID of relation between file and user
-                                example: johndoe
-                              elementId:
-                                type: integer
-                                minimum: 1
-                                example: 1
-                            required:
-                              - elementId
+                        items:
+                          allOf:
+                            - $ref: '#/components/schemas/signatureElement'
+                            - $ref: '#/components/schemas/elementCoordinate'
+                            - type: object
+                              properties:
+                                signRequestId:
+                                  type: string
+                                  nullable: true
+                                  description: Representative ID of relation between file and user
+                                  example: johndoe
+                                elementId:
+                                  type: integer
+                                  minimum: 1
+                                  example: 1
+                              required:
+                                - elementId
                       signers:
                         type: array
                         items:
@@ -1819,23 +1821,25 @@ paths:
                         items:
                           $ref: '#/components/schemas/pdfPage'
                       visibleElements:
+                        type: array
                         description: Visible elements on document
-                        allOf:
-                          - $ref: '#/components/schemas/signatureElement'
-                          - $ref: '#/components/schemas/elementCoordinate'
-                          - type: object
-                            properties:
-                              signRequestId:
-                                type: string
-                                nullable: true
-                                description: Representative ID of relation between file and user
-                                example: johndoe
-                              elementId:
-                                type: integer
-                                minimum: 1
-                                example: 1
-                            required:
-                              - elementId
+                        items:
+                          allOf:
+                            - $ref: '#/components/schemas/signatureElement'
+                            - $ref: '#/components/schemas/elementCoordinate'
+                            - type: object
+                              properties:
+                                signRequestId:
+                                  type: string
+                                  nullable: true
+                                  description: Representative ID of relation between file and user
+                                  example: johndoe
+                                elementId:
+                                  type: integer
+                                  minimum: 1
+                                  example: 1
+                              required:
+                                - elementId
                       signers:
                         type: array
                         items:
@@ -2018,23 +2022,25 @@ paths:
                         items:
                           $ref: '#/components/schemas/pdfPage'
                       visibleElements:
+                        type: array
                         description: Visible elements on document
-                        allOf:
-                          - $ref: '#/components/schemas/signatureElement'
-                          - $ref: '#/components/schemas/elementCoordinate'
-                          - type: object
-                            properties:
-                              uid:
-                                type: string
-                                description: Nextcloud user id to assign this visible element.
-                                example: johndoe
-                                nullable: true
-                              elementId:
-                                type: integer
-                                minimum: 1
-                                example: 1
-                            required:
-                              - elementId
+                        items:
+                          allOf:
+                            - $ref: '#/components/schemas/signatureElement'
+                            - $ref: '#/components/schemas/elementCoordinate'
+                            - type: object
+                              properties:
+                                uid:
+                                  type: string
+                                  description: Nextcloud user id to assign this visible element.
+                                  example: johndoe
+                                  nullable: true
+                                elementId:
+                                  type: integer
+                                  minimum: 1
+                                  example: 1
+                              required:
+                                - elementId
                       signers:
                         type: array
                         items: