Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 18 additions & 8 deletions geocoder/geocoder-combined.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"openapi": "3.0.0",
"openapi": "3.1.0",
"servers": [
{
"url": "https://geocoder.api.gov.bc.ca/",
Expand All @@ -17,7 +17,7 @@
"info": {
"title": "Geocoder REST API",
"description": "This API represents address cleaning, correction, completion, geocoding, reverse geocoding, and proximity resources for intersection addresses, physical addresses and their occupants in British Columbia. Please read our [data collection notice](https://github.com/bcgov/api-specs/blob/master/COLLECTION_NOTICE.md#collection-notice). \n\nPlease note that you may experience issues when submitting requests to the delivery or test environment if using this [OpenAPI specification](https://github.com/bcgov/api-specs) in other API console viewers. \n\n[API keys](https://api.gov.bc.ca/devportal/api-directory/273) are unique and can be acquired with a GitHub or IDIR account. \n\n **Notification:** If you have applications or web pages that link to the BC Address Geocoder you must use the following URL. \n\n *https://geocoder.api.gov.bc.ca* \n\n Please note that the following URLs were deprecated in September 2018 [More Details](https://www2.gov.bc.ca/gov/content?id=103ADC5A956842828554238DEF28D6E5). \n\n - http://apps.gov.bc.ca/pub/geocoder \n - https://apps.gov.bc.ca/pub/geocoder\n \n \n ",
"version": "2.0.0",
"version": "4.5.2",
"license": {
"name": "Open Government License - British Columbia",
"url": "https://www2.gov.bc.ca/gov/content?id=A519A56BC2BF44E4A008B33FCF527F61"
Expand Down Expand Up @@ -86,9 +86,15 @@
"description": "Civic or intersection address as a single string. See <a href=https://github.com/bcgov/ols-geocoder/blob/gh-pages/glossary.md#addressString target=\"_blank\">addressString</a>",
"required": false,
"schema": {
"type": "string"
},
"example": "525 Superior Street, Victoria, BC"
"type": "string",
"examples": [
"UNIT 401 -- 1010 View St, Victoria, BC",
"456 Gorge Rd E, Victoria, BC",
"Lakeshore Dr E and Veterans Way, Penticton, BC",
"Malibu Terrace, Nanaimo, BC",
"Kamloops, BC"
]
}
},
{
"name": "locationDescriptor",
Expand Down Expand Up @@ -486,9 +492,13 @@
"description": "Occupant name OR Occupant name ** address",
"required": false,
"schema": {
"type": "string"
},
"example": "Sir James Douglas Elementary"
"type": "string",
"examples": [
"Sir James Douglas Elementary",
"Swartz Bay Ferry Terminal",
"Kamloops Airport"
]
}
},
{
"name": "tags",
Expand Down
14 changes: 1 addition & 13 deletions geomark/geomark.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"openapi": "3.0.0",
"openapi": "3.1.0",
"servers": [
{
"url": "https://apps.gov.bc.ca/pub/geomark",
Expand Down Expand Up @@ -124,19 +124,11 @@
"multiple": {
"description": "Boolean flag indicating if multiple geometries are to be used for the geomark (true) or only a single geometry from the first geometry (false).",
"type": "boolean",
"enum": [
false,
true
],
"default": false
},
"allowOverlap": {
"description": "When multiple=true select this option to allow overlapping geometries",
"type": "boolean",
"enum": [
false,
true
],
"default": false
},
"body": {
Expand Down Expand Up @@ -237,10 +229,6 @@
"required": false,
"schema": {
"type": "boolean",
"enum": [
false,
true
],
"default": false
}
},
Expand Down
2 changes: 1 addition & 1 deletion router/router.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"openapi": "3.0.0",
"openapi": "3.1.0",
"servers": [
{
"url": "https://router.api.gov.bc.ca/",
Expand Down