Objekttyp-Abfrageparameter in der Swagger-Dokumentation verwenden

Ich habe eine GET-Route, auf der ich einen Objektparameter in der URL als Abfragezeichenfolge codieren möchte.

Wenn ich die Swagger-Dokumentation schreibe, erhalte ich im Grunde genommen Fehler, die mir die Verwendung von @ verweigerschema/object gibt ein @ equery type parameter:

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

Der Anforderungsabfrageparameter mit einem Objektwert würde in einer tatsächlichen Anforderung codiert.

Auch wenn swagger oben auf dem Bildschirm einen Fehler anzeigt, wird das Objekt im Benutzeroberflächen-Editor von swagger korrekt gerendert, wobei dieser Fehler jedoch oben auf der Dokumentation angezeigt wird.

Antworten auf die Frage(6)

Ihre Antwort auf die Frage