Skip to content

Add common paginator parameters to components->parameters #162

@cnizzardini

Description

@cnizzardini

Create reusable Paginator OpenAPI component to reduce YAML/JSON payload and clutter.

Components->Parameters Schema:

x-swagger-bake:
  components:
    parameters:
      paginatorPage:
        name: page
        in: query
        required: false
        schema:
          description: ''
          type: integer
      paginatorLimit:
        name: limit
        in: query
        required: false
        schema:
          description: ''
          type: integer
      paginatorDirection:
        name: direction
        in: query
        required: false
        schema:
          description: ''
          type: string
          enum:
            - asc
            - desc

Referenced via:

    get:
      parameters:
        - $ref: '#/components/parameters/paginatorPage'
        - $ref: '#/components/parameters/paginatorLimit'
        - name: sort
          in: query
          required: false
          schema:
            description: ''
            type: string
            enum:
              - id
              - first_name
              - last_name
              - modified
        - $ref: '#/components/parameters/paginatorDirection'

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions