{
  "openapi": "3.1.0",
  "info": {
    "title": "Civic Translator Public API",
    "version": "1.2.0",
    "description": "Public discovery endpoints and authenticated read-only access to Civic Translator public-meeting and packet-summary data. Civic Translator is an independent civic-information publisher. Official government records remain authoritative.",
    "contact": {
      "name": "Civic Translator",
      "url": "https://civic-translator.org/contact"
    },
    "license": {
      "name": "See Civic Translator licensing terms",
      "url": "https://civic-translator.org/licensing"
    }
  },
  "servers": [
    {
      "url": "https://civic-translator.org",
      "description": "Production"
    }
  ],
  "tags": [
    {
      "name": "Discovery",
      "description": "Public endpoints; no API key required."
    },
    {
      "name": "Summaries",
      "description": "Full summary metadata/text; API key required."
    }
  ],
  "components": {
    "securitySchemes": {
      "ApiKeyAuth": {
        "type": "apiKey",
        "in": "header",
        "name": "x-api-key",
        "description": "Required for protected summary endpoints. Contact Civic Translator to request an API key."
      }
    },
    "schemas": {
      "ApiError": {
        "type": "object",
        "properties": {
          "error": {
            "type": "object",
            "properties": {
              "code": {
                "type": "string"
              },
              "message": {
                "type": "string"
              }
            },
            "required": [
              "code",
              "message"
            ],
            "additionalProperties": true
          }
        },
        "required": [
          "error"
        ],
        "additionalProperties": true
      },
      "City": {
        "type": "object",
        "properties": {
          "city": {
            "type": "string"
          },
          "state": {
            "type": "string"
          },
          "latitude": {
            "type": [
              "number",
              "null"
            ]
          },
          "longitude": {
            "type": [
              "number",
              "null"
            ]
          },
          "publicBodyCount": {
            "type": "integer",
            "minimum": 1
          }
        },
        "required": [
          "city",
          "state",
          "latitude",
          "longitude",
          "publicBodyCount"
        ],
        "additionalProperties": false
      },
      "PublicBody": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "displayName": {
            "type": "string"
          },
          "organizationType": {
            "type": [
              "string",
              "null"
            ]
          },
          "state": {
            "type": "string"
          },
          "governmentBody": {
            "type": "string"
          },
          "city": {
            "type": [
              "string",
              "null"
            ]
          },
          "county": {
            "type": [
              "string",
              "null"
            ]
          },
          "servedCities": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "timezone": {
            "type": [
              "string",
              "null"
            ]
          },
          "provider": {
            "type": [
              "string",
              "null"
            ]
          },
          "mascot": {
            "type": [
              "string",
              "null"
            ]
          },
          "meetingSource": {},
          "branding": {},
          "videoProvider": {},
          "url": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "displayName",
          "state",
          "governmentBody",
          "servedCities",
          "url"
        ],
        "additionalProperties": true
      },
      "SummaryType": {
        "type": "string",
        "enum": [
          "packet-summary",
          "meeting-summary"
        ]
      },
      "SummaryPreview": {
        "type": "object",
        "description": "Public preview record. Exact fields may expand over time; full summary text is not included.",
        "properties": {
          "state": {
            "type": "string"
          },
          "governmentBody": {
            "type": "string"
          },
          "publicBody": {
            "type": "string"
          },
          "meetingDate": {
            "type": "string"
          },
          "summaryType": {
            "$ref": "#/components/schemas/SummaryType"
          },
          "title": {
            "type": "string"
          },
          "description": {
            "type": [
              "string",
              "null"
            ]
          },
          "topics": {
            "type": "array",
            "items": {}
          },
          "pageUrl": {
            "type": "string"
          },
          "imageUrl": {
            "type": "string"
          }
        },
        "additionalProperties": true
      },
      "SummaryRecord": {
        "type": "object",
        "description": "Published summary metadata. Additional fields may be present as the API evolves.",
        "properties": {
          "state": {
            "type": "string"
          },
          "governmentBody": {
            "type": "string"
          },
          "publicBody": {
            "type": "string"
          },
          "meetingDate": {
            "type": "string"
          },
          "meetingId": {
            "type": [
              "string",
              "null"
            ]
          },
          "summaryType": {
            "$ref": "#/components/schemas/SummaryType"
          },
          "title": {
            "type": "string"
          },
          "slug": {
            "type": "string"
          }
        },
        "additionalProperties": true
      }
    }
  },
  "paths": {
    "/api/v1": {
      "get": {
        "tags": [
          "Discovery"
        ],
        "summary": "API information",
        "description": "Returns API metadata, documentation links, endpoint URLs, and access requirements.",
        "responses": {
          "200": {
            "description": "API metadata"
          }
        }
      }
    },
    "/api/v1/health": {
      "get": {
        "tags": [
          "Discovery"
        ],
        "summary": "API health check",
        "responses": {
          "200": {
            "description": "Service is available"
          }
        }
      }
    },
    "/api/v1/cities": {
      "get": {
        "tags": [
          "Discovery"
        ],
        "summary": "List cities represented by covered public bodies",
        "description": "Public endpoint. No API key required.",
        "parameters": [
          {
            "name": "state",
            "in": "query",
            "schema": {
              "type": "string"
            },
            "description": "State slug, for example iowa."
          },
          {
            "name": "q",
            "in": "query",
            "schema": {
              "type": "string"
            },
            "description": "Case-insensitive city/state text filter."
          }
        ],
        "responses": {
          "200": {
            "description": "City results"
          }
        }
      }
    },
    "/api/v1/public-bodies": {
      "get": {
        "tags": [
          "Discovery"
        ],
        "summary": "List public bodies",
        "description": "Public endpoint. No API key required.",
        "parameters": [
          {
            "name": "state",
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "governmentBody",
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "city",
            "in": "query",
            "schema": {
              "type": "string"
            },
            "description": "Matches primary or served cities."
          },
          {
            "name": "q",
            "in": "query",
            "schema": {
              "type": "string"
            },
            "description": "Searches IDs, names, city, county, and served cities."
          }
        ],
        "responses": {
          "200": {
            "description": "Public body results"
          }
        }
      }
    },
    "/api/v1/summaries-preview": {
      "get": {
        "tags": [
          "Discovery"
        ],
        "summary": "List public summary previews",
        "description": "Public endpoint returning limited descriptions, topics, page links, and image links. Full text requires an API key.",
        "parameters": [
          {
            "name": "state",
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "governmentBody",
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "publicBody",
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "q",
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "topic",
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "summaryType",
            "in": "query",
            "schema": {
              "$ref": "#/components/schemas/SummaryType"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "schema": {
              "type": "integer",
              "minimum": 1,
              "maximum": 25
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Public summary previews"
          },
          "400": {
            "description": "Invalid summary type"
          }
        }
      }
    },
    "/api/v1/summaries": {
      "get": {
        "tags": [
          "Summaries"
        ],
        "summary": "List published summaries",
        "security": [
          {
            "ApiKeyAuth": []
          }
        ],
        "parameters": [
          {
            "name": "state",
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "governmentBody",
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "publicBody",
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "meetingId",
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "summaryType",
            "in": "query",
            "schema": {
              "$ref": "#/components/schemas/SummaryType"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "schema": {
              "type": "integer",
              "minimum": 1,
              "maximum": 250,
              "default": 50
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "schema": {
              "type": "string"
            },
            "description": "Opaque pagination cursor returned as meta.nextCursor."
          }
        ],
        "responses": {
          "200": {
            "description": "Summary results"
          },
          "400": {
            "description": "Invalid filter"
          },
          "401": {
            "description": "API key required"
          }
        }
      }
    },
    "/api/v1/summaries/search": {
      "get": {
        "tags": [
          "Summaries"
        ],
        "summary": "Search complete published summary text",
        "security": [
          {
            "ApiKeyAuth": []
          }
        ],
        "parameters": [
          {
            "name": "q",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string",
              "minLength": 2
            },
            "description": "PostgreSQL web-style full-text query."
          },
          {
            "name": "state",
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "governmentBody",
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "publicBody",
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "meetingId",
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "summaryType",
            "in": "query",
            "schema": {
              "$ref": "#/components/schemas/SummaryType"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "schema": {
              "type": "integer",
              "minimum": 1,
              "maximum": 100,
              "default": 25
            }
          },
          {
            "name": "offset",
            "in": "query",
            "schema": {
              "type": "integer",
              "minimum": 0,
              "maximum": 10000,
              "default": 0
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Ranked full-text summary search results"
          },
          "400": {
            "description": "Invalid query"
          },
          "401": {
            "description": "Missing or invalid API key"
          }
        }
      }
    },
    "/api/v1/summaries/{state}/{governmentBody}/{publicBody}/{meetingDate}/{summaryType}": {
      "get": {
        "tags": [
          "Summaries"
        ],
        "summary": "Get one detailed summary",
        "security": [
          {
            "ApiKeyAuth": []
          }
        ],
        "parameters": [
          {
            "name": "state",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "governmentBody",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "publicBody",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "meetingDate",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Meeting date path segment, typically YYYY-MM-DD."
          },
          {
            "name": "summaryType",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/SummaryType"
            }
          },
          {
            "name": "meetingId",
            "in": "query",
            "schema": {
              "type": "string"
            },
            "description": "Optional meeting identity for multiple same-day meetings."
          }
        ],
        "responses": {
          "200": {
            "description": "Detailed summary"
          },
          "400": {
            "description": "Invalid summary type"
          },
          "401": {
            "description": "API key required"
          },
          "404": {
            "description": "Summary not found"
          }
        }
      }
    }
  }
}