枚举恰好2(略有不同)在OpenAPI 3.1.0对象的数组?

Question

我需要记录一个REST端点，它接受以下请求体:

{
"variables": [
{
"name": "groupGuid",
"value": "...",
"typeConstraint": "string",
},
{
"name": "addMembership",
"value": "...",
"typeConstraint": "boolean",
}
]
}

variables数组必须取2对象:

• 含name、groupGuid、typeConstraint、string，
• 和其他nameaddMembership和typeConstraintboolean。

它们各自的value的类型是由typeConstraint指定的，但value属性的实际值是不受约束的。

目前，我得到了这个，这是非常不明确的(可能是错误的)，并依赖于我手动包含的注释:

'/test':
post:
requestBody:
content:
application/json:
schema:
type: object
properties:
variables:
type: array
uniqueItems: true
description: 'Must contain exactly 2 objects, with the following `name`s: (1) `groupGuid`: GUID of the group, (2) `addMembership`: Whether the task will add (true) or remove (false) members from the group.'
items:
type: object
additionalProperties: false
properties:
name:
enum:
- groupGuid
- addMembership
type: string
value:
type:
- string
- boolean
typeConstraint:
type: string
enum:
- string
- boolean
description: The type of `value`.

是否有可能在YAML/OpenAPI 3.1.0中适当地规范这些要求，如果是，如何?谢谢。

Answer 1

如果您想要在示例体中显示两个对象并接受其中一个或两个对象，也许您可以使用anyOf.

下面的例子

paths:
/test:
post:
tags:
- Test
description: "Must contain exactly 2 objects, with the following `name`s: (1) `groupGuid`: GUID of the group, (2) `addMembership`: Whether the task will add (true) or remove (false) members from the group."
requestBody:
required: true
content:
application/json:
schema:
properties:
variables:                    
type: array
uniqueItems: true
items:
anyOf:
- $ref: '#/components/schemas/Object1'
- $ref: '#/components/schemas/Object2'
responses:
'200':
description: Sucess
components:     
schemas: 
Object1:
type: object
description: "The value here is string"
properties:
name:
type: string
value:
type: string
typeConstraint:
type: string
Object2:
type: object
description: "The value here is boolean"
properties:
name:
type: string          
value:
type: string
typeConstraint:
type: boolean