Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Issues in open API spec #401

Open
Mapiarz opened this issue Dec 20, 2024 · 3 comments
Open

Issues in open API spec #401

Mapiarz opened this issue Dec 20, 2024 · 3 comments

Comments

@Mapiarz
Copy link

Mapiarz commented Dec 20, 2024

There's more things missing in the open api spec.

First, status field in the create submission response. Second, the get submission query param for combined pdf.

You could consider making the spec a part of this repo. Would've been easier to maintain I suppose?

@@ -1173,6 +1173,9 @@ paths:
                     slug:
                       type: string
                       description: Unique key to be used in the signing form URL.
+                    status:
+                      type: string
+                      description: The status of signing request for the submitter.
                     values:
                       type: array
                       description: An array of pre-filled values for the submission.
@@ -1288,6 +1291,13 @@ paths:
             type: integer
           description: The unique identifier of the submission.
           example: 1001
+        - name: include
+          in: query
+          schema:
+            type: string
+            description: What to include. Only possible value is combined_document_url.
+          required: false
+          description: Whether to include combined pdf url. cf. https://github.com/docusealco/docuseal/discussions/297
       responses:
         '200':
           description: OK
@Mapiarz
Copy link
Author

Mapiarz commented Dec 20, 2024

Also missing property on get template response

@@ -397,6 +397,8 @@ paths:
                           description: >-
                             Unique identifier of the submitter that filled the
                             field.
+                        type:
+                          type: string
                         name:
                           type: string
                           description: Field name.

@Mapiarz
Copy link
Author

Mapiarz commented Dec 20, 2024

And more. The values when talking about submitters can be either string or int, from my testing. Perhaps other types of fields come as different types as well, needs more investigation on your part guys.

@@ -1188,7 +1188,9 @@ paths:
                             type: string
                             description: Document template field name
                           value:
-                            type: string
+                            oneOf:
+                              - type: string
+                              - type: integer
                             description: Pre-filled value of the field.
                     metadata:
                       type: object
@@ -1410,7 +1412,9 @@ paths:
                                 type: string
                                 description: Document template field name
                               value:
-                                type: string
+                                oneOf:
+                                  - type: string
+                                  - type: integer
                                 description: Pre-filled value of the field.
                         documents:
                           type: array
@@ -1689,7 +1693,9 @@ paths:
                             type: string
                             description: Document template field name
                           value:
-                            type: string
+                            oneOf:
+                              - type: string
+                              - type: integer
                             description: Pre-filled value of the field.
                     metadata:
                       type: object
@@ -1933,7 +1939,9 @@ paths:
                           type: string
                           description: Document template field name
                         value:
-                          type: string
+                          oneOf:
+                            - type: string
+                            - type: integer
                           description: Pre-filled value of the field.
                   documents:
                     type: array
@@ -2176,7 +2184,9 @@ paths:
                           type: string
                           description: Document template field name
                         value:
-                          type: string
+                          oneOf:
+                            - type: string
+                            - type: integer
                           description: Pre-filled value of the field.
                   documents:
                     type: array
@@ -2397,7 +2407,9 @@ paths:
                                 type: string
                                 description: Document template field name
                               value:
-                                type: string
+                                oneOf:
+                                  - type: string
+                                  - type: integer
                                 description: Pre-filled value of the field.
                         documents:
                           type: array

@Mapiarz Mapiarz changed the title Things missing in open API spec Issues in open API spec Dec 20, 2024
@AlexBTurchyn
Copy link
Contributor

@Mapiarz Thanks for reporting. I made some necessary changes except 'include' - we are not planning to make this parameter public. Let me know if everything works now as you expected

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants