{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/iterant-ai/json-schema/iterant-ai-public-page-opportunity-list-schema.json",
  "title": "PublicPageOpportunityList",
  "description": "The schema for what ``paginated`` builds. Kept beside it deliberately.\n\nA list operation whose ``responses`` named the *item* serializer with\n``many=True`` published a bare array while the runtime returned this object,\nso a generated client broke on its first call. Subclasses add ``items``:\neach operation needs its own named component or the item type is erased.",
  "x-generated": "2026-11-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/iterant-ai-openapi.json#/components/schemas/PublicPageOpportunityList",
  "type": "object",
  "properties": {
    "total": {
      "type": [
        "integer",
        "null"
      ],
      "description": "Rows matching the query, before `limit` and `offset`. Null when a `status` filter outran the scan bound and the true count is not knowable. `note` says so."
    },
    "offset": {
      "type": "integer",
      "description": "Rows skipped. Echoed back so a caller can page without bookkeeping."
    },
    "limit": {
      "type": "integer",
      "description": "Cap actually applied, which may be lower than the one requested."
    },
    "note": {
      "type": "string",
      "description": "How to narrow, when the cap hid rows. Empty when the response is the whole answer."
    },
    "items": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/PublicPageOpportunitySummary"
      }
    }
  },
  "required": [
    "items",
    "limit",
    "note",
    "offset",
    "total"
  ],
  "$defs": {
    "PublicPageOpportunitySummary": {
      "type": "object",
      "properties": {
        "ref": {
          "type": "string",
          "readOnly": true,
          "description": "Stable, human-readable handle. Pass it back to the opportunity detail route."
        },
        "id": {
          "type": "string",
          "format": "uuid"
        },
        "title": {
          "type": "string"
        },
        "status": {
          "type": "string",
          "readOnly": true,
          "description": "Derived display status, folding in the state of any page the opportunity produced."
        },
        "intent": {
          "type": "string"
        },
        "role": {
          "type": "string"
        },
        "surface": {
          "type": "string"
        },
        "archetype": {
          "type": "string",
          "readOnly": true
        },
        "primaryKeyword": {
          "type": "string"
        },
        "priorityScore": {
          "type": "integer"
        },
        "searchVolumeMonthly": {
          "type": [
            "integer",
            "null"
          ]
        },
        "keywordDifficulty": {
          "type": [
            "integer",
            "null"
          ]
        },
        "seoScore": {
          "type": [
            "integer",
            "null"
          ]
        },
        "geoScore": {
          "type": [
            "integer",
            "null"
          ]
        },
        "resultingUrlPath": {
          "type": [
            "string",
            "null"
          ],
          "readOnly": true
        }
      },
      "required": [
        "archetype",
        "geoScore",
        "id",
        "intent",
        "keywordDifficulty",
        "primaryKeyword",
        "priorityScore",
        "ref",
        "resultingUrlPath",
        "role",
        "searchVolumeMonthly",
        "seoScore",
        "status",
        "surface",
        "title"
      ]
    }
  }
}