{"openapi":"3.1.0","info":{"title":"Open Country AU","version":"0.1.0","description":"Suggestion API for Aboriginal place names and acknowledgements of Country. Not Traditional Owner identification, and not for native title or legal use. Do not use suggested names as postal localities.","license":{"name":"Proprietary"}},"servers":[{"url":"https://opencountryau.com"}],"paths":{"/health":{"get":{"summary":"Health","responses":{"200":{"description":"Service is up"}}}},"/v1/localities":{"get":{"summary":"Typeahead over the curated table","parameters":[{"name":"q","in":"query","schema":{"type":"string"},"description":"Suburb, alias, or Aboriginal place name"},{"name":"state","in":"query","schema":{"type":"string"},"description":"State or territory (VIC, NSW, …)"}],"responses":{"200":{"description":"Matching localities"}}}},"/v1/coverage":{"get":{"summary":"ABS LGA checklist, have vs need","parameters":[{"name":"q","in":"query","schema":{"type":"string"},"description":"Council name or LGA code"},{"name":"state","in":"query","schema":{"type":"string"}},{"name":"status","in":"query","schema":{"type":"string","enum":["have","need","na"]}}],"responses":{"200":{"description":"Coverage list"}}}},"/v1/suggest":{"post":{"summary":"Queue a place-name suggestion for review","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["suburb","state"],"properties":{"suburb":{"type":"string"},"state":{"type":"string"},"postcode":{"type":"string"},"lgaCode":{"type":"string"},"placeName":{"type":"string"},"peoples":{"type":"string"},"acknowledgement":{"type":"string"},"sourceUrl":{"type":"string"},"notes":{"type":"string"},"turnstileToken":{"type":"string"}}}}}},"responses":{"201":{"description":"Queued"},"400":{"description":"Invalid suggestion"},"403":{"description":"Turnstile check failed"},"429":{"description":"Rate limited"}}}},"/v1/resolve":{"post":{"summary":"Resolve an Australian address to a suggestion","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["suburb","state"],"properties":{"country":{"type":"string","example":"AU"},"suburb":{"type":"string","example":"Melbourne"},"state":{"type":"string","example":"VIC"},"postcode":{"type":"string","example":"3000"},"lat":{"type":"number","example":-37.247,"description":"Optional. With lng, checked against Victorian RAP appointed boundaries to break a published geographic split."},"lng":{"type":"number","example":144.457}}}}}},"responses":{"200":{"description":"Suggestion, including overlap or conflict"},"400":{"description":"Missing suburb or state"},"429":{"description":"Rate limited"}}}}}}