Skip to content

Commit cf7c37e

Browse files
committed
openapi place endpoint docs
1 parent 439d637 commit cf7c37e

1 file changed

Lines changed: 29 additions & 1 deletion

File tree

proxy/src/main/resources/openapi.yml

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ servers:
1616
tags:
1717
- name: Autocomplete
1818
- name: Reverse
19+
- name: Place
1920

2021
security:
2122
- {}
@@ -86,6 +87,24 @@ paths:
8687
application/json:
8788
schema:
8889
$ref: '#/components/schemas/Result'
90+
/v1/place:
91+
get:
92+
tags:
93+
- Place
94+
summary: Place lookup
95+
description: Lookup places by ID
96+
operationId: placeV2
97+
parameters:
98+
- $ref: '#/components/parameters/Ids'
99+
- $ref: '#/components/parameters/Lang'
100+
- $ref: '#/components/parameters/ETClientName'
101+
responses:
102+
'200':
103+
description: Matching places
104+
content:
105+
application/json:
106+
schema:
107+
$ref: '#/components/schemas/Result'
89108

90109
components:
91110
parameters:
@@ -97,6 +116,15 @@ components:
97116
type: string
98117
example: "my-example-application"
99118

119+
Ids:
120+
name: ids
121+
in: query
122+
required: true
123+
description: Place IDs (comma-separated)
124+
schema:
125+
type: string
126+
example: "NSR:StopPlace:59872"
127+
100128
Text:
101129
name: text
102130
in: query
@@ -375,7 +403,7 @@ components:
375403
example: "venue"
376404
source:
377405
type: string
378-
enum: [openstreetmap, openaddresses, whosonfirst]
406+
enum: [openstreetmap, openaddresses, whosonfirst, geonames]
379407
example: "openstreetmap"
380408
source_id:
381409
type: string

0 commit comments

Comments
 (0)