Browse Source

Oh hey it compiles now. Has all endpoints & params. Needs grouping

pull/2/head
David Riordan 9 years ago
parent
commit
81d74ae24f
  1. 62
      swagger-docs/pelias-v1-api-swagger.yml

62
swagger-docs/pelias-v1-api-swagger.yml

@ -123,7 +123,7 @@ paths:
type: string
format: string
description: |
For more than one layer, accepts a comma separated list of valid layers. If any of those layers is invalid, the request will still be honored, but a warning will be thrown in the `geocoding` block of the response.
For more than one layer, accepts a comma separated list of valid layers. If any of those layers is invalid, the request will still be honored, but a warning will be noted in the `geocoding` block of the response.
required: false
collectionFormat: csv
@ -163,18 +163,22 @@ paths:
in: query
type: number
format: float
required: false
- name: boundary.rect.min_lat
in: query
type: number
format: float
required: false
- name: boundary.rect.max_lon
in: query
type: number
format: float
required: false
- name: boundary.rect.max_lat
in: query
type: number
format: float
required: false
- name: boundary.country
@ -266,39 +270,44 @@ paths:
/reverse:
get:
summary: Takes the coordinates of a location and searches for the name or address of the place it's from.
summary: Searches for the name of a place based on a lon/lat location. Used for address reverse geocoding, point of interest (POI) reverse geocoding, and reverse coarse geocoding.
parameters:
- name: point.lon
in: query
format: float
description: tk
required: true
min: -180
max: 180
type: number
format: float
minimum: -180
maximum: 180
- name: point.lat
in: query
format: float
description: tk
required: true
min: -90
max: 90
type: number
format: float
minimum: -90
maximum: 90
- name: boundary.circle.lon
in: query
description: tk
type: number
format: float
required: false
min: -180
max: 180
required: true
minimum: -180
maximum: 180
- name: boundary.circle.lat
in: query
type: number
format: float
required: false
min: -90
max: 180
minimum: -90
maximum: 180
- name: boundary.circle.radius
in: query
@ -306,6 +315,7 @@ paths:
format: float
required: false
description: bounding circle radius (in KM).
minimum: 0.001
- name: boundary.country
in: query
@ -314,20 +324,38 @@ paths:
required: false
description: Limits search to only return matches within a specific country. Accepts 2 or 3 letter country codes based on ISO [Alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Current_codes) or [Alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Current_codes) abbreviations.
- name: layer
- name: layers
in: query
type: string
required: false
description: tk
collectionFormat: csv
- name: sources
in: query
type: string
required: false
description: tk
collectionFormat: csv
- name: size
in: query
type: integer
format: int32
required: false
default: 10
responses:
200:
description: All Good.
description: GeoJSON FeatureCollection
security:
- api_key: []
/place:
get:
summary: Retrieves the full GeoJSON record for a given place. ID determined from the results of a `/search`, `/autocomplete`, or `/reverse` response.

Loading…
Cancel
Save