Можно ли ссылаться на другой пример элемента в примере в OpenAPI / Swagger? - PullRequest
Новая
       40

Можно ли ссылаться на другой пример элемента в примере в OpenAPI / Swagger?

0 голосов
/ 13 марта 2020

Допустим, у меня есть это: 

paths:
  /auth:
    post:
      ...
      responses:
        '200':
          description: "Success"
          content:
            application/json:
          schema:
            type: object
            properties:
              data:
                $ref: '#/components/schemas/authDataSchema'
            examples:
              exampleOne:
                $ref: '#/components/examples/exampleOne

И это для примера раздела: 

components:
  ...
  examples:
    exampleOne:
      value:
        result:
          code: 200
          status: "success"
        data:
          api:
            token: "token"
          user:
            $ref: '#/components/examples/user1/value'
    user1:
      value:
        id: 42
        username: "Doug"

В принципе, я хотел бы сослаться на пример "user1" в другом Примеры. Тем не менее, Swagger дает мне это как «вычисленный» результат с «$$» в конце: 

{
  "result": {
    "code": 200,
    "status": "success",
  },
  "data": {
    "api": {
      "token": "token",
    },
    "user": {
      "id": 42,
      "username": "Doug",
      "$$ref": "#/components/examples/user1/value"
    }
  }
}

Разрешено ли это, и парсер Сваггера что-то напутал или просто не разрешено в первую очередь?

...