swagger - Swagger 架构属性被忽略 - 为什么？

Question

我正在尝试构建一个简单的 Swagger 模型：

PlayerConfig:
  type: object
  required:
    - kind
    - player_id
  properties:
    kind:
      type: string
      example: PlayerConfig
    player_id:
      type: string
      example: "foo"
      description: "bar"

sports_config:
  oneOf:
    - $ref: '#/components/schemas/PlayerConfig'
  discriminator:
    propertyName: kind

由于某种原因，生成的 HTML 不显示player_id'example字段。这让我觉得我做的不对。s

所以问题是如果使用模型作为类型实际上可以像我试图做的那样完成。example如果字段的父级是parameters:而不是properties:.

更新：我阅读了https://swagger.io/docs/specification/adding-examples/Object and Property Examples上的部分，看来我的代码片段应该有效。

更新#2：我实际上下载redoc-cli了（这是 OpenAPI 的 CLI 工具 -> html 包）并从 Swagger Editor 中获取了一个示例规范，该规范example下的字段properties模仿了我的问题，看起来像是预期的（见我附上的屏幕截图）：

Answer 1

如果字符串值包含空格（或其他一些特殊字符），则应将其括在引号中。所以该行应该是

  example: "LeBron James"