在OpenAPI YAML中指定动态键

Question

我想创建一个这样的响应结构，其中fieldProfile（配置文件类型）或摘要框架是可选的。 IE外键是动态和可选的

{
    "fieldProfile": [
        "metric1",
        "metric2",
        "metric3"
    ],
    "summaryProfile": [
        "metric1",
        "metric2",
        "metric3"
    ]
}

，或者

{
    "fieldProfile": [
        "metric1",
        "metric2",
        "metric3"
    ]
} // Here Summary Profile is removed, similarly we can have a response of summaryProfile or have both in response

我正在创建这样的响应模式，但是在这里，我希望Metrictype（FieldProfile/SummaryProfile）成为指标的关键（METRIC列表）。

ProfileMetrics:
  description: List of metrics available in Field Profile
  type: object
  required:
    - metricType
    - metrics
  properties:
    metrics:
      type: array
      items:
        type: object
        required:
          - metricName
        properties:
          metricName:
            type: string

任何帮助都将受到赞赏

Answer 1

您的架构可以定义如下：

MySchema:
  type: object
  properties:
    fieldProfile:
      type: array
      items:
        type: string
    summaryProfile:
      type: array
      items:
        type: string

  # At least fieldProfile or summaryProfile (or both) must be present
  minProperties: 1

而不是minproperties：1，您可以使用此anyof + 必需构造，它将达到相同的效果在此示例中：

  anyOf:
    - required: [fieldProfile]
    - required: [summaryProfile]