swagger-api/swagger-ui

Request body descriptions are not shown when the input type is a file upload

Open

#5,637 创建于 2019年9月30日

在 GitHub 查看
 (3 评论) (2 反应) (1 负责人)JavaScript (8,801 fork)batch import
HacktoberfestP3specification: 3.xtype: bug

仓库指标

Star
 (25,447 star)
PR 合并指标
 (平均合并 20小时 34分钟) (30 天内合并 14 个 PR)

描述

Q&A (please complete the following information)

  • Swagger-UI version: 3.23.11
  • Swagger/OpenAPI version: OpenAPI 3.0

Content & configuration

        "requestBody": {
          "description": "A zip file containing files that will be unzipped",
          "content": {
            "application/octet-stream": {
              "schema": {
                "type": "string",
                "format": "binary",
                "nullable": true
              }
            }
          },
          "required": true
        }

Describe the bug you're encountering

When a request body is a type that causes the UI to use an input type=file box, then the description is not shown, and instead a message about examples is shown (even if no examples are specified in the openapi json). The message is:

Example values are not available for application/octet-stream media types.

Changing the type to something like text/plain results in the description being shown.

Expected behavior

The description should be shown above the file input box. The warning about examples shouldn't be shown if none are specified.

Additional context or thoughts

Maybe there should be support for per-content-type descriptions (e.g. via the schema's title attribute) so you can explain the differences between different upload types.

贡献者指南