{"openapi":"3.1.0","info":{"title":"ODA Geoportal","version":"0.15.0"},"paths":{"/healthz":{"get":{"summary":"Liveness","operationId":"liveness_healthz_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":{"type":"string"},"type":"object","title":"Response Liveness Healthz Get"}}}}}}},"/readyz":{"get":{"summary":"Readiness","operationId":"readiness_readyz_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/api/v1/resolve":{"post":{"summary":"Resolve","operationId":"resolve_api_v1_resolve_post","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResolveRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResolveResult"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/discover":{"post":{"summary":"Discover","operationId":"discover_api_v1_discover_post","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoverRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoverResult"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/query":{"post":{"summary":"Query","operationId":"query_api_v1_query_post","parameters":[{"name":"if-none-match","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"If-None-Match"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EvidenceResult"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/retrieve":{"post":{"summary":"Retrieve","operationId":"retrieve_api_v1_retrieve_post","parameters":[{"name":"if-none-match","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"If-None-Match"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EvidenceResult"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/nearby":{"post":{"summary":"Nearby","operationId":"nearby_api_v1_nearby_post","parameters":[{"name":"if-none-match","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"If-None-Match"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NearbyRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NearbyResult"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/ask":{"post":{"summary":"Ask","operationId":"ask_api_v1_ask_post","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AskRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AskResult"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/.well-known/oauth-protected-resource":{"get":{"summary":"Oauth Metadata","operationId":"oauth_metadata__well_known_oauth_protected_resource_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Oauth Metadata  Well Known Oauth Protected Resource Get"}}}}}}},"/impressum":{"get":{"summary":"Page","operationId":"page_impressum_get","responses":{"200":{"description":"Successful Response","content":{"text/html":{"schema":{"type":"string"}}}}}}},"/privacy":{"get":{"summary":"Page","operationId":"page_privacy_get","responses":{"200":{"description":"Successful Response","content":{"text/html":{"schema":{"type":"string"}}}}}}},"/terms":{"get":{"summary":"Page","operationId":"page_terms_get","responses":{"200":{"description":"Successful Response","content":{"text/html":{"schema":{"type":"string"}}}}}}},"/security":{"get":{"summary":"Page","operationId":"page_security_get","responses":{"200":{"description":"Successful Response","content":{"text/html":{"schema":{"type":"string"}}}}}}}},"components":{"schemas":{"AskRequest":{"properties":{"lon":{"anyOf":[{"type":"number","maximum":180.0,"minimum":-180.0},{"type":"null"}],"title":"Lon"},"lat":{"anyOf":[{"type":"number","maximum":90.0,"minimum":-90.0},{"type":"null"}],"title":"Lat"},"as_of":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"As Of"},"time_range":{"anyOf":[{"$ref":"#/components/schemas/TimeRange"},{"type":"null"}]},"source_ids":{"anyOf":[{"items":{"type":"string"},"type":"array","minItems":1},{"type":"null"}],"title":"Source Ids"},"inspire_themes":{"anyOf":[{"items":{"$ref":"#/components/schemas/InspireTheme"},"type":"array","minItems":1},{"type":"null"}],"title":"Inspire Themes"},"question":{"type":"string","maxLength":1000,"minLength":1,"title":"Question"},"address":{"anyOf":[{"type":"string","maxLength":300,"minLength":1},{"type":"null"}],"title":"Address"},"language":{"anyOf":[{"type":"string","enum":["de","en"]},{"type":"null"}],"title":"Language"}},"additionalProperties":false,"type":"object","required":["question"],"title":"AskRequest"},"AskResult":{"properties":{"status":{"type":"string","enum":["needs_clarification","evidence_only","generated_answer"],"title":"Status"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"},"clarification":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Clarification"},"candidates":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Candidates"},"location":{"anyOf":[{"$ref":"#/components/schemas/ResolvedLocation"},{"type":"null"}]},"evidence":{"anyOf":[{"$ref":"#/components/schemas/EvidenceResult"},{"type":"null"}]},"answer":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Answer"},"metadata":{"additionalProperties":true,"type":"object","title":"Metadata"}},"additionalProperties":false,"type":"object","required":["status"],"title":"AskResult"},"DiscoverRequest":{"properties":{"lon":{"anyOf":[{"type":"number","maximum":180.0,"minimum":-180.0},{"type":"null"}],"title":"Lon"},"lat":{"anyOf":[{"type":"number","maximum":90.0,"minimum":-90.0},{"type":"null"}],"title":"Lat"},"source_ids":{"anyOf":[{"items":{"type":"string"},"type":"array","minItems":1},{"type":"null"}],"title":"Source Ids"},"inspire_themes":{"anyOf":[{"items":{"$ref":"#/components/schemas/InspireTheme"},"type":"array","minItems":1},{"type":"null"}],"title":"Inspire Themes"},"query":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}],"title":"Query"},"status":{"anyOf":[{"type":"string","enum":["active","demoted","retired","unverified","killed"]},{"type":"null"}],"title":"Status"},"limit":{"anyOf":[{"type":"integer","minimum":1.0},{"type":"null"}],"title":"Limit"},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"}},"additionalProperties":false,"type":"object","title":"DiscoverRequest"},"DiscoverResult":{"properties":{"sources":{"items":{"$ref":"#/components/schemas/PublicSource"},"type":"array","title":"Sources"},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Cursor"},"catalog_version":{"type":"string","title":"Catalog Version"},"answerability":{"type":"string","const":"not_assessed","title":"Answerability","default":"not_assessed"}},"additionalProperties":false,"type":"object","required":["sources","catalog_version"],"title":"DiscoverResult"},"EvidenceMetadata":{"properties":{"response_mode":{"type":"string","enum":["plan","evidence_bundle"],"title":"Response Mode"},"answerability":{"type":"string","const":"not_assessed","title":"Answerability"},"request":{"anyOf":[{"$ref":"#/components/schemas/QueryRequest"},{"$ref":"#/components/schemas/RetrieveRequest"},{"$ref":"#/components/schemas/AskRequest"},{"$ref":"#/components/schemas/NearbyRequest"}],"title":"Request"},"versions":{"$ref":"#/components/schemas/EvidenceVersions"},"generated_at":{"type":"string","title":"Generated At"},"upstream_requests_by_host":{"additionalProperties":{"type":"integer","minimum":0.0},"type":"object","title":"Upstream Requests By Host"},"estimated_upstream_requests_by_host":{"additionalProperties":{"type":"integer","minimum":0.0},"type":"object","title":"Estimated Upstream Requests By Host"},"runnable_sources":{"items":{"type":"string"},"type":"array","title":"Runnable Sources"},"temporal_semantics":{"type":"string","const":"as_of selects declared edition; latest uses request time","title":"Temporal Semantics"}},"additionalProperties":false,"type":"object","required":["response_mode","answerability","request","versions","generated_at","upstream_requests_by_host","estimated_upstream_requests_by_host","runnable_sources","temporal_semantics"],"title":"EvidenceMetadata"},"EvidenceResult":{"properties":{"evidence_id":{"type":"string","title":"Evidence Id"},"sources":{"additionalProperties":{"$ref":"#/components/schemas/PublicSource"},"type":"object","title":"Sources"},"observations":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Observations"},"selected_sources":{"items":{"type":"string"},"type":"array","title":"Selected Sources"},"unavailable_sources":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Unavailable Sources"},"dropped_sources":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Dropped Sources"},"metadata":{"$ref":"#/components/schemas/EvidenceMetadata"}},"additionalProperties":false,"type":"object","required":["evidence_id","sources","observations","selected_sources","unavailable_sources","dropped_sources","metadata"],"title":"EvidenceResult"},"EvidenceVersions":{"properties":{"engine":{"type":"string","title":"Engine"},"catalog":{"type":"string","title":"Catalog"},"protocol":{"type":"string","title":"Protocol"}},"additionalProperties":false,"type":"object","required":["engine","catalog","protocol"],"title":"EvidenceVersions"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"InspireTheme":{"type":"string","enum":["addresses","administrative_units","cadastral_parcels","coordinate_reference_systems","geographical_grid_systems","geographical_names","hydrography","protected_sites","transport_networks","elevation","geology","land_cover","orthoimagery","agricultural_and_aquaculture_facilities","area_management_restriction_regulation_zones_and_reporting_units","atmospheric_conditions","bio_geographical_regions","buildings","energy_resources","environmental_monitoring_facilities","habitats_and_biotopes","human_health_and_safety","land_use","meteorological_geographical_features","mineral_resources","natural_risk_zones","oceanographic_geographical_features","population_distribution_and_demography","production_and_industrial_facilities","sea_regions","soil","species_distribution","statistical_units","utility_and_governmental_services"],"title":"InspireTheme","description":"Stable compact identifiers for the 34 official INSPIRE themes."},"NearbyRequest":{"properties":{"as_of":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"As Of"},"time_range":{"anyOf":[{"$ref":"#/components/schemas/TimeRange"},{"type":"null"}]},"source_ids":{"anyOf":[{"items":{"type":"string"},"type":"array","minItems":1},{"type":"null"}],"title":"Source Ids"},"inspire_themes":{"anyOf":[{"items":{"$ref":"#/components/schemas/InspireTheme"},"type":"array","minItems":1},{"type":"null"}],"title":"Inspire Themes"},"lon":{"type":"number","maximum":180.0,"minimum":-180.0,"title":"Lon"},"lat":{"type":"number","maximum":90.0,"minimum":-90.0,"title":"Lat"},"limit":{"anyOf":[{"type":"integer","minimum":1.0},{"type":"null"}],"title":"Limit"},"cursor":{"anyOf":[{"type":"string","maxLength":4096},{"type":"null"}],"title":"Cursor"}},"additionalProperties":false,"type":"object","required":["lon","lat"],"title":"NearbyRequest"},"NearbyResult":{"properties":{"evidence_id":{"type":"string","title":"Evidence Id"},"sources":{"additionalProperties":{"$ref":"#/components/schemas/PublicSource"},"type":"object","title":"Sources"},"observations":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Observations"},"selected_sources":{"items":{"type":"string"},"type":"array","title":"Selected Sources"},"unavailable_sources":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Unavailable Sources"},"dropped_sources":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Dropped Sources"},"metadata":{"$ref":"#/components/schemas/EvidenceMetadata"},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Cursor"}},"additionalProperties":false,"type":"object","required":["evidence_id","sources","observations","selected_sources","unavailable_sources","dropped_sources","metadata"],"title":"NearbyResult"},"PublicSource":{"properties":{"source_id":{"type":"string","title":"Source Id"},"title":{"type":"string","title":"Title"},"description":{"items":{"type":"string"},"type":"array","title":"Description"},"publisher":{"type":"string","title":"Publisher"},"source_level":{"type":"string","title":"Source Level"},"themes":{"items":{"type":"string"},"type":"array","title":"Themes"},"coverage":{"additionalProperties":true,"type":"object","title":"Coverage"},"coverage_relation":{"type":"string","enum":["inside","outside","unknown","not_requested"],"title":"Coverage Relation"},"temporal":{"additionalProperties":true,"type":"object","title":"Temporal"},"license":{"additionalProperties":true,"type":"object","title":"License"},"caveats":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Caveats"},"verification":{"additionalProperties":true,"type":"object","title":"Verification"},"status":{"type":"string","title":"Status"},"availability":{"additionalProperties":true,"type":"object","title":"Availability"},"query_capabilities":{"additionalProperties":true,"type":"object","title":"Query Capabilities"},"match_reasons":{"items":{"type":"string"},"type":"array","title":"Match Reasons"}},"additionalProperties":false,"type":"object","required":["source_id","title","description","publisher","source_level","themes","coverage","coverage_relation","temporal","license","caveats","verification","status","availability","query_capabilities","match_reasons"],"title":"PublicSource"},"QueryRequest":{"properties":{"as_of":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"As Of"},"time_range":{"anyOf":[{"$ref":"#/components/schemas/TimeRange"},{"type":"null"}]},"source_id":{"type":"string","minLength":1,"title":"Source Id"},"lon":{"type":"number","maximum":180.0,"minimum":-180.0,"title":"Lon"},"lat":{"type":"number","maximum":90.0,"minimum":-90.0,"title":"Lat"}},"additionalProperties":false,"type":"object","required":["source_id","lon","lat"],"title":"QueryRequest"},"ResolveRequest":{"properties":{"address":{"type":"string","maxLength":300,"minLength":1,"title":"Address"},"postal_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Postal Code"},"locality":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Locality"},"region":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Region"},"country":{"type":"string","title":"Country","default":"DE"}},"additionalProperties":false,"type":"object","required":["address"],"title":"ResolveRequest"},"ResolveResult":{"properties":{"region":{"type":"string","title":"Region"},"candidates":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Candidates"},"selection_required":{"type":"boolean","title":"Selection Required"},"truncated":{"type":"boolean","title":"Truncated"},"license":{"type":"string","title":"License"},"attribution":{"type":"string","title":"Attribution"},"source_url":{"type":"string","title":"Source Url"},"retrieved_at":{"type":"string","title":"Retrieved At"},"upstream_requests_by_host":{"additionalProperties":{"type":"integer"},"type":"object","title":"Upstream Requests By Host"}},"additionalProperties":false,"type":"object","required":["region","candidates","selection_required","truncated","license","attribution","source_url","retrieved_at"],"title":"ResolveResult"},"ResolvedLocation":{"properties":{"lon":{"type":"number","maximum":180.0,"minimum":-180.0,"title":"Lon"},"lat":{"type":"number","maximum":90.0,"minimum":-90.0,"title":"Lat"},"origin":{"type":"string","enum":["explicit_coordinates","explicit_address","question"],"title":"Origin"},"address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address"}},"additionalProperties":false,"type":"object","required":["lon","lat","origin","address"],"title":"ResolvedLocation"},"RetrieveRequest":{"properties":{"as_of":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"As Of"},"time_range":{"anyOf":[{"$ref":"#/components/schemas/TimeRange"},{"type":"null"}]},"source_ids":{"anyOf":[{"items":{"type":"string"},"type":"array","minItems":1},{"type":"null"}],"title":"Source Ids"},"inspire_themes":{"anyOf":[{"items":{"$ref":"#/components/schemas/InspireTheme"},"type":"array","minItems":1},{"type":"null"}],"title":"Inspire Themes"},"lon":{"type":"number","maximum":180.0,"minimum":-180.0,"title":"Lon"},"lat":{"type":"number","maximum":90.0,"minimum":-90.0,"title":"Lat"},"mode":{"type":"string","enum":["plan","execute"],"title":"Mode","default":"execute"}},"additionalProperties":false,"type":"object","required":["lon","lat"],"title":"RetrieveRequest"},"TimeRange":{"properties":{"start":{"type":"string","format":"date-time","title":"Start"},"end":{"type":"string","format":"date-time","title":"End"}},"additionalProperties":false,"type":"object","required":["start","end"],"title":"TimeRange"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}