{
  "openapi": "3.1.0",
  "info": {
    "title": "HotelIndex Israel API",
    "version": "1.4.0",
    "description": "Public read-only API for hotels, cities, regions, major chains, destination recommendations, trip-type collections and source-aware guest-policy facts in Israel."
  },
  "servers": [
    {
      "url": "https://hotelindex.co.il"
    }
  ],
  "paths": {
    "/api/v1/hotels": {
      "get": {
        "summary": "List and filter all hotels",
        "parameters": [
          {
            "name": "city",
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "region",
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "chain",
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "best_for",
            "in": "query",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Hotel records with absolute URLs, relationships and guestFacts"
          }
        }
      }
    },
    "/api/v1/hotels/{slug}": {
      "get": {
        "summary": "Get one complete hotel record",
        "parameters": [
          {
            "name": "slug",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful read-only response"
          },
          "404": {
            "description": "Not found"
          }
        }
      }
    },
    "/api/v1/cities": {
      "get": {
        "summary": "Read cities resources",
        "responses": {
          "200": {
            "description": "Successful read-only response"
          }
        }
      }
    },
    "/api/v1/regions": {
      "get": {
        "summary": "Read regions resources",
        "responses": {
          "200": {
            "description": "Successful read-only response"
          }
        }
      }
    },
    "/api/v1/chains": {
      "get": {
        "summary": "Read chains resources",
        "responses": {
          "200": {
            "description": "Successful read-only response"
          }
        }
      }
    },
    "/api/v1/recommendations": {
      "get": {
        "summary": "Read recommendations resources",
        "responses": {
          "200": {
            "description": "Successful read-only response"
          }
        }
      }
    },
    "/api/v1/hotel-types": {
      "get": {
        "summary": "Read hotel-types resources",
        "responses": {
          "200": {
            "description": "Successful read-only response"
          }
        }
      }
    },
    "/api/v1/guest-questions": {
      "get": {
        "summary": "Read guest-questions resources",
        "responses": {
          "200": {
            "description": "Successful read-only response"
          }
        }
      }
    },
    "/api/v1/cities/{slug}": {
      "get": {
        "summary": "Get a city with parent region and hotels",
        "parameters": [
          {
            "name": "slug",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful read-only response"
          },
          "404": {
            "description": "Not found"
          }
        }
      }
    },
    "/api/v1/regions/{slug}": {
      "get": {
        "summary": "Get a region with cities and hotels",
        "parameters": [
          {
            "name": "slug",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful read-only response"
          },
          "404": {
            "description": "Not found"
          }
        }
      }
    },
    "/api/v1/recommendations/{slug}": {
      "get": {
        "summary": "Get an ordered destination shortlist",
        "parameters": [
          {
            "name": "slug",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful read-only response"
          },
          "404": {
            "description": "Not found"
          }
        }
      }
    },
    "/api/v1/search": {
      "get": {
        "summary": "Search hotels, cities, regions and chains",
        "parameters": [
          {
            "name": "q",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Grouped search results"
          }
        }
      }
    },
    "/api/ask": {
      "get": {
        "summary": "Return deterministic hotel matches",
        "parameters": [
          {
            "name": "q",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Structured answer"
          }
        }
      }
    },
    "/api/v1/hotel-types/{slug}": {
      "get": {
        "summary": "Get hotels matching one trip type",
        "parameters": [
          {
            "name": "slug",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful read-only response"
          },
          "404": {
            "description": "Not found"
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "GuestFact": {
        "type": "object",
        "required": [
          "status",
          "answer",
          "source",
          "verified"
        ],
        "properties": {
          "status": {
            "type": "string",
            "enum": [
              "listed",
              "unknown",
              "contact-hotel"
            ]
          },
          "answer": {
            "type": "string"
          },
          "source": {
            "type": "string",
            "format": "uri"
          },
          "verified": {
            "type": "string",
            "format": "date"
          }
        }
      },
      "Relationship": {
        "type": "object",
        "required": [
          "slug",
          "name",
          "url"
        ],
        "properties": {
          "slug": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "url": {
            "type": "string",
            "format": "uri"
          }
        }
      }
    }
  }
}