如何在 OpenAPI 中要求至少两个参数之一？

Question

我正在使用 OpenAPI 3 并且有两个查询参数，其中至少 一个 是必需的，但哪个并不重要。

即，作为 sudocode：

if parameter_1 OR parameter_2:
    do stuff
else:
    error

这在 OpenAPI 3 中可行吗？据我所知，规范中没有提到它，或者 JSON Schema 规范中也没有提到它。

Answer 1

此场景与mutually exclusive parameters 非常相似。基本上，您可以使用对象类型参数，其中parameter_1 和parameter_2 是对象属性；这样的对象将是serialized 和?parameter_1=value1&parameter_2=value2。 “至少一个”约束可以使用minProperties 或anyOf 来表示。

openapi: 3.0.2
...
paths:
  /foo:
    get:
      parameters:
        - in: query
          name: param
          required: true
          schema:
            type: object
            properties:
              parameter_1:
                type: string
              parameter_2:
                type: string
            additionalProperties: false

            # Option 1
            minProperties: 1

            # Option 2
            # anyOf:
            #  - required: [parameter_1]
            #  - required: [parameter_2]

还有一个现有的功能请求来支持parameters 列表中各个参数之间的相互依赖关系：
https://github.com/OAI/OpenAPI-Specification/issues/256