Pagination Metadata

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/usps/json-schema/usps-pagination-metadata-schema.json",
  "title": "Pagination Metadata",
  "description": "Standard error message response.",
  "x-generated": "2026-11-11",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/usps-locations-openapi.yml#/components/schemas/PaginationMetadata",
  "required": [
    "limit",
    "offset"
  ],
  "type": "object",
  "properties": {
    "totalCount": {
      "type": "integer",
      "description": "Total number of resources return in the API request."
    },
    "page": {
      "type": "integer",
      "description": "The current page number."
    },
    "totalPages": {
      "type": "integer",
      "description": "Total number of pages, based on the user provided limit and [totalCount]"
    },
    "limit": {
      "type": "integer",
      "description": "The number of resources returned per call, based on the user provided limit"
    },
    "offset": {
      "type": "integer",
      "description": "The current offset, based on the user provided offset"
    },
    "links": {
      "$ref": "#/$defs/Links"
    }
  },
  "additionalProperties": false,
  "$defs": {
    "Links": {
      "title": "Hypermedia Links",
      "type": "array",
      "description": "Hypermedia links to related resources.",
      "items": {
        "required": [
          "href",
          "rel"
        ],
        "type": "object",
        "properties": {
          "rel": {
            "type": "array",
            "description": "The short name(s) of the relationship corresponding to the link.",
            "items": {
              "type": "string"
            }
          },
          "title": {
            "type": "string",
            "description": "A human-readable description of the link relationship."
          },
          "href": {
            "type": "string",
            "description": "The URL to a related resource.",
            "format": "uri"
          },
          "method": {
            "type": "string",
            "description": "The HTTP method to use to access this link.",
            "enum": [
              "GET",
              "POST",
              "PUT",
              "DELETE"
            ]
          },
          "submissionMediaType": {
            "type": "string",
            "description": "The media type of the resource request."
          },
          "targetMediaType": {
            "type": "string",
            "description": "The media type of the resource response."
          },
          "description": {
            "type": "string",
            "description": "A human-readable description of the link relationship."
          },
          "publishDate": {
            "type": "string",
            "format": "date-time",
            "description": "The date and time the file was published. The date and time will be returned in UTC (Zulu) format."
          }
        },
        "additionalProperties": false
      }
    }
  }
}