Skip to content

Multipart form body is not rendered properly  #82

@mykola-mokhnach

Description

@mykola-mokhnach

Hello,

I am trying to describe the parameters for an API endpoint, which is supposed to serve file uploads. My docstring looks like

    async def handle_upload(self, request: web.Request) -> web.Response:
        """
        ---
        description: This end-point allows to upload files to the storage service.
        tags:
        - Upload
        produces:
        - application/json
        parameters: []
        requestBody:
          required: true
          content:
            multipart/form-data:
              schema:
                type: object
                required:
                  - payload
                properties:
                  payload:
                    type: string
                    format: binary
                    description: the content of the file to be uploaded
                  name:
                    type: string
                    description: the file name (if unset then will be retrieved from `content-disposition` header)
        responses:
          "201":
            description: successful operation

...

Although the generated Swagger document looks like

upload

and does not contain any controls, which would allow file upload.

My question is whether such format supported by the library? Should I, probably, use another approach to describe multipart/form-data content?

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions