Get Total Pages Specification

dictionary-spec.yaml

  /v1/dictionary/pages:
    get:
      tags:
        - 'Query Dictionary'
      responses:
        '200':
          description: 'Success'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Page'
              example:
                start: 1
                end: 3
                recordsPerPage: 10
        '500':
          description: 'Internal server error'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
              example:
                message: 'An error has occurred'
                path: '/v1/dictionary/pages'

components:
  schemas:
    Page:
      type: 'object'
      properties:
        start:
          type: 'integer'
          description: 'Start page number'
        end:
          type: 'integer'
          description: 'End page number'
        recordsPerPage:
          type: 'integer'
          description: 'Records per page'

    ErrorMessage:
      type: 'object'
      properties:
        message:
          type: 'string'
          description: 'Description of the error'
        path:
          type: 'string'
          description: 'Identity of the resource'