Having a nested object structure in formData and get the same reflected on swagger-ui

[cskru]

Currently, swagger accepts properties in formData directly. What I intend to do is, formData should be able to accept a nested object and the file will be present somewhere inside. (See example below).
I am not sure if this is a bug or a whole new feature to be added.

Q	A
Which Swagger/OpenAPI version?	2.0
Which browser & version?	Chrome latest
Which operating system?	Windows

formData: 
   { file: 
      { opt: 
         { filename: 'abc.json',
           contentType: 'application/octet-stream' 
          },
        value: <The file contents are to be placed here (octet-stream)> 
       } 
   }

Current Behavior

I tried to do the same like:

            - name: file
              in: formData
              type: object
              properties:
               file:
                   type: object
                   properties:
                       opt:
                          type: object
                          properties:
                              filename:
                                  type: string
                                  example: "abc.json"
                                  required: true
                              contentType:
                                   type: string
                                   example: 'application/octet-stream' 
                       value:
                            type: file

But this doesn't work.
The output is like this:

I want to represent formData as a nested object itself and represent it in swagger appropriately.
Is there a way to do so?

Thanks in advance!

[hkosova]

Is the request body supposed to be sent as application/json, application/x-www-form-urlencoded (form data) or as a multipart request?

[dalbrx-forcam]

I have a similar problem:

The swagger config Version 2.0:

The swagger UI:

As you can see the ncElement is rendered as type formData which is a string instead type "createNCElementProperties"

In addition the request part for the ncElement doesn't have a Content-Type. The correct Content-Type would be application/json

[hkosova]

@dalbrx-forcam In OpenAPI/Swagger 2.0, formData parameters cannot be objects. In other words, you can POST either JSON (consume application/json) or a file (consume multipart/form-data), but not both in the same request.

Multipart requests with JSON+file are supported in OpenAPI 3.0:

openapi: 3.0.0
...
paths:
  /something:
    post:
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                ncElement:
                  $ref: '#/components/schemas/createNcElementProperties'
                file:
                  type: string
                  format: binary
              required:
                - ncElement
                - file
      responses:
        ...

More examples of OpenAPI 3.0 multipart request definitions:
https://swagger.io/docs/specification/describing-request-body/multipart-requests/
https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#special-considerations-for-multipart-content

---

However, "try it out" support for multipart requests and file upload for OpenAPI 3.0 definitions is not yet available in Swagger UI. I believe this is being tracked in the OAS 3.0 Support Backlog.

[webron]

As @hkosova mentioned, Swagger 2.0 does not support it, but OAS3 does. We recently added support for it in swagger-ui, so I'm going to go ahead and close the ticket.

[Cloudmersive]

Why is this issue closed? This issue is still not fixed. This is actually a very serious issue - it means that you cannot upload both an object and a file.

[Cloudmersive]

And Swagger UI definitely still doesn't support this.

[hkosova]

@Cloudmersive Uploading objects + files is supported in OpenAPI 3.0 and should work in latest Swagger UI. Check out the examples in my comment above.

If something does not work for you, open a new issue and provide the steps to reproduce and other details.