{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/cityparity-com/json-schema/cityparity-com-rank-request-schema.json",
  "title": "RankRequest",
  "x-generated": "2026-11-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/_original/cityparity-com-api-openapi.json#/components/schemas/RankRequest",
  "type": "object",
  "properties": {
    "weights": {
      "$ref": "#/$defs/ScoreWeights"
    },
    "filter": {
      "type": "object",
      "properties": {
        "country": {
          "type": "string"
        },
        "countries": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "region": {
          "type": "string",
          "enum": [
            "europe",
            "asia",
            "north_america",
            "south_america",
            "oceania"
          ]
        },
        "has_universal_healthcare": {
          "type": "boolean"
        },
        "include_cities": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "exclude_cities": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "scenario": {
      "type": "object",
      "properties": {
        "gross_salary_usd": {
          "type": "number",
          "exclusiveMinimum": 0
        },
        "has_partner": {
          "type": "boolean"
        },
        "partner_gross_salary_usd": {
          "type": "number",
          "minimum": 0
        },
        "kids_ages": {
          "type": "array",
          "items": {
            "type": "integer",
            "minimum": 0,
            "maximum": 25
          }
        },
        "bedrooms": {
          "type": "integer",
          "minimum": 0,
          "maximum": 5
        },
        "housing_mode": {
          "type": "string",
          "enum": [
            "rent",
            "own",
            "own_outright"
          ]
        },
        "lifestyle": {
          "type": "string",
          "enum": [
            "frugal",
            "typical",
            "generous"
          ]
        }
      }
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 50,
      "default": 10
    }
  },
  "$defs": {
    "ScoreWeights": {
      "type": "object",
      "description": "Override composite-score weights. Defaults: financial 30, healthcare 20, vacation 15, childcare 15, safety_net 20.",
      "properties": {
        "financial": {
          "type": "number",
          "minimum": 0,
          "maximum": 100
        },
        "healthcare": {
          "type": "number",
          "minimum": 0,
          "maximum": 100
        },
        "vacation": {
          "type": "number",
          "minimum": 0,
          "maximum": 100
        },
        "childcare": {
          "type": "number",
          "minimum": 0,
          "maximum": 100
        },
        "safety_net": {
          "type": "number",
          "minimum": 0,
          "maximum": 100
        }
      }
    }
  }
}