page-shield_result_info

APIs.ioEngineeringPlatform

Properties

Name Type Description
count number Total number of results for the requested service
page number Current page within paginated list of results
per_page number Number of results per page of results
total_count number Total results available without any search parameters
total_pages number Total number of pages
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-page-shield-result-info-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/page-shield_result_info",
  "title": "page-shield_result_info",
  "properties": {
    "count": {
      "description": "Total number of results for the requested service",
      "example": 1,
      "type": "number"
    },
    "page": {
      "description": "Current page within paginated list of results",
      "example": 1,
      "type": "number"
    },
    "per_page": {
      "description": "Number of results per page of results",
      "example": 20,
      "type": "number"
    },
    "total_count": {
      "description": "Total results available without any search parameters",
      "example": 2000,
      "type": "number"
    },
    "total_pages": {
      "description": "Total number of pages",
      "example": 100,
      "type": "number"
    }
  },
  "required": [
    "page",
    "per_page",
    "count",
    "total_count",
    "total_pages"
  ],
  "type": "object"
}