Skip to content

"Response That Returns a File" example for base64 uses format: byte #351

Open
@Akhlys

Description

@Akhlys

On the Describing Responses page, section "Response That Returns a File", the text mentions "OpenAPI 3.0 defines file input/output content as type: string with format: binary or format: base64". In the code example for the base64 variant meanwhile is this:

   paths:
      /users/me:
        get:
          summary: Returns user information
          responses:
            '200':
              description: A JSON object containing user name and avatar
              content:
                application/json:
                  schema:
                    type: object
                    properties:
                      username:
                        type: string
                      avatar:          # <-- image embedded into JSON
                        type: string
                        format: byte ### ISSUE ###
                        description: Base64-encoded contents of the avatar image

Maybe I'm mistaken, but pretty sure that should be "format: base64" there.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions