openapi - 是否可以覆盖 OpenAPI 3 中引用参数的 "required"属性？

Question

我正在构建一个简单的 OpenAPI 3 YAML 规范，如下所示:

paths:
  /query:
    get:
      parameters:
        - $ref: '#/components/parameters/bookid'

components:
  parameters:
    bookid:
      in: query
      name: bookid
      required: false
      schema:
        format: integer
        type: number    

现在，我想使用常见的 bookid 参数 但覆盖 required值来自 false至 true .例如(这不起作用!!!):

paths:
  ...

  /query2:
    get:
      parameters:
        - $ref: '#/components/parameters/bookid'
          required: true  # <--- ???

有没有办法做到这一点？

Answer 1

这不受支持。您需要为必需参数和可选参数分别定义参数。
从 OpenAPI 3.1 开始，您只能覆盖 description引用的参数，但不是其他属性( required ， name 和其他)。

# openapi: 3.1.0

parameters:
  # This works
  - $ref: '#/components/parameters/bookid'
    description: Custom description

  # This won't work - cannot override attributes other than "description"
  - $ref: '#/components/parameters/bookid'
    required: true

以下是现有的功能请求:

Extend/override properties of a parameter

Allow required as sibling of $ref (like summary/description)