pages_api-response-pagination

APIs.ioEngineeringPlatform

Properties

Name Type Description
result_info object
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-pages-api-response-pagination-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/pages_api-response-pagination",
  "title": "pages_api-response-pagination",
  "properties": {
    "result_info": {
      "properties": {
        "count": {
          "description": "The number of items on the current page.",
          "example": 1,
          "type": "integer"
        },
        "page": {
          "description": "The page currently being requested.",
          "example": 1,
          "type": "integer"
        },
        "per_page": {
          "description": "The number of items per page being returned.",
          "example": 100,
          "type": "integer"
        },
        "total_count": {
          "description": "The total count of items.",
          "example": 1,
          "type": "integer"
        },
        "total_pages": {
          "description": "The total count of pages.",
          "example": 1,
          "type": "integer"
        }
      },
      "required": [
        "page",
        "per_page",
        "count",
        "total_count"
      ],
      "type": "object"
    }
  },
  "type": "object"
}