{
  "openapi": "3.1.0",
  "info": {
    "title": "FuneralFinder open funeral data API",
    "version": "1.0.0",
    "description": "Read-only static JSON about UK funeral directors, crematoria, cemeteries, natural burial grounds, death registration rules and faith funeral customs. Data © OpenStreetMap contributors (ODbL).",
    "license": {
      "name": "ODbL-1.0",
      "url": "https://opendatacommons.org/licenses/odbl/1-0/"
    }
  },
  "servers": [
    {
      "url": "https://funeralfinder.org/api/v1"
    }
  ],
  "paths": {
    "/index.json": {
      "get": {
        "operationId": "getIndex",
        "summary": "List endpoints and dataset counts",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/towns.json": {
      "get": {
        "operationId": "listTowns",
        "summary": "All UK towns and cities with ids, coordinates and counts",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/towns/{townId}.json": {
      "get": {
        "operationId": "getTown",
        "summary": "Nearest funeral directors, crematoria, natural burial grounds and cemeteries for a town, plus death registration rules",
        "parameters": [
          {
            "name": "townId",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            },
            "example": "leeds"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          },
          "404": {
            "description": "Unknown town id"
          }
        }
      }
    },
    "/funeral-directors.json": {
      "get": {
        "operationId": "listFuneralDirectors",
        "summary": "All UK funeral directors with address, phone, website, coordinates, group and faith specialisms",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/crematoria.json": {
      "get": {
        "operationId": "listCrematoria",
        "summary": "All UK crematoria and natural burial grounds",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/faiths.json": {
      "get": {
        "operationId": "listFaithCustoms",
        "summary": "Funeral customs for 21 faiths and beliefs: burial vs cremation, timing, rites, mourning, etiquette",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }
  }
}