Используйте параметр запроса типа объекта в документации Swagger

У меня есть маршрут GET, где я хотел бы закодировать параметр объекта в URL-адресе в виде строки запроса.

При написании документации о чванстве я в основном получаю ошибки, которые не позволяют мне использоватьschema/object вводит вquery параметр типа:

paths:
  /mypath/:
    get:
      parameters
        - in: path
          name: someParam
          description: some param that works
          required: true
          type: string
          format: timeuuid #good param, works well
        - $ref: "#/parameters/mySortingParam" #this yields an error

parameters:
  mySortingParam
    name: paging
    in: query
    description: Holds various paging attributes
    required: false
    schema:
      type: object
      properties:
        pageSize:
          type: number
        cursor:
          type: object
          properties:
            after:
              type: string
              format: string

Параметр запроса запроса, имеющий значение объекта, будет закодирован в фактическом запросе.

Несмотря на то, что swagger показывает ошибку в верхней части экрана, объект отображается правильно в редакторе интерфейса пользователя swagger, однако эта ошибка всплывает в верхней части документации.

Ответы на вопрос(1)

Ваш ответ на вопрос