SuccessEnvelope

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/5dollarfootballapi/main/json-schema/5dollarfootballapi-success-envelope-schema.json",
  "title": "SuccessEnvelope",
  "description": "Every successful response. `data` is the endpoint payload — see the example on each operation. List endpoints add `pagination`.",
  "x-generated": "2026-10-11",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/5dollarfootballapi-countries-api-openapi.yml#/components/schemas/SuccessEnvelope",
  "type": "object",
  "required": [
    "success",
    "data"
  ],
  "properties": {
    "success": {
      "type": "integer",
      "const": 1
    },
    "data": {
      "description": "Endpoint payload: an object, or an array of objects on list endpoints.",
      "oneOf": [
        {
          "type": "object"
        },
        {
          "type": "array",
          "items": {
            "type": "object"
          }
        }
      ]
    },
    "pagination": {
      "$ref": "#/$defs/Pagination"
    }
  },
  "$defs": {
    "Pagination": {
      "type": "object",
      "description": "Returned by list endpoints. Keep requesting pages while `has_more` is true.",
      "properties": {
        "page": {
          "type": "integer"
        },
        "per_page": {
          "type": "integer"
        },
        "count": {
          "type": "integer",
          "description": "Rows on this page."
        },
        "has_more": {
          "type": "boolean"
        }
      }
    }
  }
}