Skip to content

[swagger] List all buckets offset parameter #17082

Open
@gshif

Description

@gshif

We should either remove the offset parameter from the swagger doc for GET /buckets endpoint or put a description for how this parameter is supposed to be used.

 /buckets:
    get:
      operationId: GetBuckets
      tags:
        - Buckets
      summary: List all buckets
      parameters:
          - $ref: '#/components/parameters/TraceSpan'
          - $ref: "#/components/parameters/Offset"
          - $ref: "#/components/parameters/Limit"
          - in: query
            name: org
            description: The organization name.
            schema:
              type: string
          - in: query
            name: orgID
            description: The organization ID.
            schema:
              type: string
          - in: query
            name: name
            description: Only returns buckets with a specific name.
            schema:
              type: string
 parameters:
    Offset:
      in: query
      name: offset
      required: false
      schema:
        type: integer
        minimum: 0

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions