Ошибка документации Swagger `Should be object` - PullRequest
1 голос
/ 05 мая 2020

Я вручную пишу чванство документацию. Но я получаю ошибку Should be object

Я не знаю, почему я получаю ошибку в приведенном ниже коде.

events:
        $ref: "#/def/Events"

Events:
    type: "object"
    properties:
      oneOf:
        - $ref: '#/def/ClassRef'
        - $ref: '#/def/TypeRef'
        - $ref: '#/def/EventRef'
        - $ref: '#/def/MarketRef'
        - $ref: '#/def/OutcomeRef'

  ClassRef:
    type: "object"
    properties:
      classRef:
        type: "string"

  TypeRef:
    type: "object"
    properties:
      typeRef:
        type: "string"

  EventRef:
    type: "object"
    properties:
      eventRef:
        type: "string"

  MarketRef:
    type: "object"
    properties:
      marketRef:
        type: "string"

  OutcomeRef:
    type: "object"
    properties:
      outcomeRef:
        type: "string"

Я получаю эту ошибку в строке ClassRef. Кто-нибудь может мне помочь, пожалуйста

1 Ответ

0 голосов
/ 05 мая 2020

OpenAPI 2.0 (swagger: '2.0') не поддерживает oneOf, вам понадобится OpenAPI 3.0 (openapi: 3.0.0) для использования oneOf.

Предполагая, что вы используете OpenAPI 3.0, и все схемы находятся в В разделе components/schemas измените схему Events следующим образом:

Events:
  oneOf:
    - $ref: '#/components/schemas/ClassRef'
    - $ref: '#/components/schemas/TypeRef'
    - $ref: '#/components/schemas/EventRef'
    - $ref: '#/components/schemas/MarketRef'
    - $ref: '#/components/schemas/OutcomeRef'
...