Move visible elements to new place

Signed-off-by: Vitor Mattos <vitor@php.rio>
LibreSign · Apr 8, 2024 · 308d775 · 308d775
1 parent ef890fa
commit 308d775
Showing 1 changed file with 100 additions and 94 deletions.
diff --git a/site/.vuepress/public/specs/api.yaml b/site/.vuepress/public/specs/api.yaml
@@ -725,23 +725,6 @@ paths:
                         type: string
                         description: URL to view PDF
                         example: 'http://cloud.test.coop/apps/libresign/pdf/46d30465-ae11-484b-aad5-327249a1e8ef'
-                      visibleElements:
-                        type: array
-                        description: Visible elements on document
-                        items:
-                          not:
-                            required:
-                              - coordinates
-                          allOf:
-                            - $ref: '#/components/schemas/pdfVisibleElement'
-                            - type: object
-                              properties:
-                                elementId:
-                                  type: integer
-                                  minimum: 1
-                                  example: 1
-                              required:
-                                - elementId
                       name:
                         type: string
                         example: filename
@@ -843,6 +826,26 @@ paths:
                                     type: integer
                                     example: 1
                                     description: is this sign method mandatory?
+                            visibleElements:
+                              type: array
+                              description: Visible elements on document
+                              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
                             uid:
                               type: string
                               nullable: true
@@ -961,23 +964,6 @@ paths:
                         type: string
                         description: URL to view PDF
                         example: 'http://cloud.test.coop/apps/libresign/pdf/46d30465-ae11-484b-aad5-327249a1e8ef'
-                      visibleElements:
-                        type: array
-                        description: Visible elements on document
-                        items:
-                          not:
-                            required:
-                              - coordinates
-                          allOf:
-                            - $ref: '#/components/schemas/pdfVisibleElement'
-                            - type: object
-                              properties:
-                                elementId:
-                                  type: integer
-                                  minimum: 1
-                                  example: 1
-                              required:
-                                - elementId
                       name:
                         type: string
                         example: filename
@@ -1079,6 +1065,26 @@ paths:
                                     type: integer
                                     example: 1
                                     description: is this sign method mandatory?
+                            visibleElements:
+                              type: array
+                              description: Visible elements on document
+                              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
                             uid:
                               type: string
                               nullable: true
@@ -1652,26 +1658,6 @@ paths:
                           This property only will be returned when the query param format=image
                         items:
                           $ref: '#/components/schemas/pdfPage'
-                      visibleElements:
-                        type: array
-                        description: Visible elements on document
-                        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:
@@ -1854,26 +1840,6 @@ paths:
                           This property only will be returned when the query param format=image
                         items:
                           $ref: '#/components/schemas/pdfPage'
-                      visibleElements:
-                        type: array
-                        description: Visible elements on document
-                        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:
@@ -1937,6 +1903,26 @@ paths:
                             signRequestId:
                               type: integer
                               description: Relation between file and user
+                            visibleElements:
+                              type: array
+                              description: Visible elements on document
+                              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
                               example: 1
                           required:
                             - signed
@@ -2054,26 +2040,6 @@ paths:
                           This property only will be returned when the query param format=image
                         items:
                           $ref: '#/components/schemas/pdfPage'
-                      visibleElements:
-                        type: array
-                        description: Visible elements on document
-                        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:
@@ -2138,6 +2104,26 @@ paths:
                               type: integer
                               description: ID of relation between file and user. Each relation between file and user has an ID that is returned on validation endpoints.
                               example: 1
+                            visibleElements:
+                              type: array
+                              description: Visible elements on document
+                              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
                           required:
                             - signed
                             - me
@@ -2892,6 +2878,26 @@ components:
                 type: integer
                 description: ID of relation between file and user. Each relation between file and user has an ID that is returned on validation endpoints.
                 example: 1
+              visibleElements:
+                type: array
+                description: Visible elements on document
+                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
             required:
               - email
               - request_sign_date