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

Incorrect typing on 'values' property of create submission response in openapi.yaml #399

Closed
Mapiarz opened this issue Dec 12, 2024 · 2 comments

Comments

@Mapiarz
Copy link

Mapiarz commented Dec 12, 2024

It's a list of objects, not just a single object. This leads to crashing clients e.g. in python. See fix below.

@@ -1174,10 +1174,17 @@ paths:
                       type: string
                       description: Unique key to be used in the signing form URL.
                     values:
-                      type: object
-                      description: >-
-                        An array of objects with pre-filled values for the
-                        submission. Use field names for keys of the object.
+                      type: array
+                      description: An array of pre-filled values for the submission.
+                      items:
+                        type: object
+                        properties:
+                          field:
+                            type: string
+                            description: Document template field name
+                          value:
+                            type: string
+                            description: Pre-filled value of the field.
                     metadata:
                       type: object
                     ua:
@@ -1661,10 +1668,17 @@ paths:
                       type: string
                       description: Unique key to be used in the signing form URL.
                     values:
-                      type: object
-                      description: >-
-                        An array of objects with pre-filled values for the
-                        submission. Use field names for keys of the object.
+                      type: array
+                      description: An array of pre-filled values for the submission.
+                      items:
+                        type: object
+                        properties:
+                          field:
+                            type: string
+                            description: Document template field name
+                          value:
+                            type: string
+                            description: Pre-filled value of the field.
                     metadata:
                       type: object
                     ua:
@AlexBTurchyn
Copy link
Contributor

@Mapiarz Thanks for reporting the issue. Let me know if everything works fine for you now

@Mapiarz
Copy link
Author

Mapiarz commented Dec 16, 2024

@AlexBTurchyn Yes thanks

@Mapiarz Mapiarz closed this as completed Dec 16, 2024
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