-
Notifications
You must be signed in to change notification settings - Fork 0
/
pygeoapi-openapi.yml
621 lines (620 loc) · 22.6 KB
/
pygeoapi-openapi.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
components:
parameters:
bbox:
description: Only features that have a geometry that intersects the bounding
box are selected.The bounding box is provided as four or six numbers, depending
on whether the coordinate reference system includes a vertical axis (height
or depth).
explode: false
in: query
name: bbox
required: false
schema:
items:
type: number
maxItems: 6
minItems: 4
type: array
style: form
bbox-crs:
description: Indicates the coordinate reference system for the given bbox coordinates.
explode: false
in: query
name: bbox-crs
required: false
schema:
format: uri
type: string
style: form
bbox-crs-epsg:
description: Indicates the EPSG for the given bbox coordinates.
explode: false
in: query
name: bbox-crs
required: false
schema:
default: 4326
type: integer
style: form
crs:
description: Indicates the coordinate reference system for the results.
explode: false
in: query
name: crs
required: false
schema:
format: uri
type: string
style: form
f:
description: The optional f parameter indicates the output format which the
server shall provide as part of the response document. The default format
is GeoJSON.
explode: false
in: query
name: f
required: false
schema:
default: json
enum:
- json
- html
- jsonld
type: string
style: form
lang:
description: The optional lang parameter instructs the server return a response
in a certain language, if supported. If the language is not among the available
values, the Accept-Language header language will be used if it is supported.
If the header is missing, the default server language is used. Note that providers
may only support a single language (or often no language at all), that can
be different from the server language. Language strings can be written in
a complex (e.g. "fr-CA,fr;q=0.9,en-US;q=0.8,en;q=0.7"), simple (e.g. "de")
or locale-like (e.g. "de-CH" or "fr_BE") fashion.
in: query
name: lang
required: false
schema:
default: en-US
enum:
- en-US
- fr-CA
type: string
offset:
description: The optional offset parameter indicates the index within the result
set from which the server shall begin presenting results in the response document. The
first element has an index of 0 (default).
explode: false
in: query
name: offset
required: false
schema:
default: 0
minimum: 0
type: integer
style: form
properties:
description: The properties that should be included for each feature. The parameter
value is a comma-separated list of property names.
explode: false
in: query
name: properties
required: false
schema:
items:
type: string
type: array
style: form
resourceId:
description: Configuration resource identifier
in: path
name: resourceId
required: true
schema:
type: string
skipGeometry:
description: This option can be used to skip response geometries for each feature.
explode: false
in: query
name: skipGeometry
required: false
schema:
default: false
type: boolean
style: form
vendorSpecificParameters:
description: Additional "free-form" parameters that are not explicitly defined
in: query
name: vendorSpecificParameters
schema:
additionalProperties: true
type: object
style: form
responses:
'200':
description: successful operation
'204':
description: no content
Queryables:
content:
application/json:
schema:
$ref: '#/components/schemas/queryables'
description: successful queryables operation
default:
content:
application/json:
schema:
$ref: https://schemas.opengis.net/ogcapi/processes/part1/1.0/openapi/schemas/exception.yaml
description: Unexpected error
schemas:
queryable:
properties:
description:
description: a human-readable narrative describing the queryable
type: string
language:
default:
- en
description: the language used for the title and description
type: string
queryable:
description: the token that may be used in a CQL predicate
type: string
title:
description: a human readable title for the queryable
type: string
type:
description: the data type of the queryable
type: string
type-ref:
description: a reference to the formal definition of the type
format: url
type: string
required:
- queryable
- type
type: object
queryables:
properties:
queryables:
items:
$ref: '#/components/schemas/queryable'
type: array
required:
- queryables
type: object
info:
contact:
email: geo@nrcan-rncan.gc.ca
name:
en: Canadian Geospatial Platform (CGP)
fr: "Plateforme G\xE9ospatiale Canadienne (PGC)"
url:
en: https://geo.ca/home/
fr: https://geo.ca/fr/accueil/
description: An OGC API - Records compliant website for the Canadian Geospatial
Platform (CGP). The application is based on the pygeoapi core version provided
in the footer. This service has been augmented with a 'geocore' provider to connect
with the geo.ca backend
license:
name:
en: Open Government Licence - Canada
fr: "Licence du gouvernement ouvert \u2013 Canada"
url:
en: https://open.canada.ca/en/open-government-licence-canada
fr: https://ouvert.canada.ca/fr/licence-du-gouvernement-ouvert-canada
termsOfService:
en: https://geo.ca/terms-and-conditions/
fr: https://geo.ca/fr/avis/
title: OGC API - Records for geo.ca
version: 0.16.dev0
x-keywords:
- geospatial
- data
- api
openapi: 3.0.2
paths:
/:
get:
description: Landing page
operationId: getLandingPage
parameters:
- $ref: '#/components/parameters/f'
- $ref: '#/components/parameters/lang'
responses:
'200':
$ref: https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/LandingPage
'400':
$ref: https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter
'500':
$ref: https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError
summary: Landing page
tags:
- server
/collections:
get:
description: Collections
operationId: getCollections
parameters:
- $ref: '#/components/parameters/f'
- $ref: '#/components/parameters/lang'
responses:
'200':
$ref: https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/LandingPage
'400':
$ref: https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter
'500':
$ref: https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError
summary: Collections
tags:
- server
/collections/canadian-geospatial-platform:
get:
description: Canadian Geospatial Platform metadata (GeoCore API provider)
operationId: describeCanadian-geospatial-platformCollection
parameters:
- $ref: '#/components/parameters/f'
- $ref: '#/components/parameters/lang'
responses:
'200':
$ref: https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Collection
'400':
$ref: https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter
'404':
$ref: https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound
'500':
$ref: https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError
summary: Get Canadian Geospatial Platform (CGP) metadata metadata
tags:
- canadian-geospatial-platform
/collections/canadian-geospatial-platform/items:
get:
description: Canadian Geospatial Platform metadata (GeoCore API provider)
operationId: getCanadian-geospatial-platformFeatures
parameters:
- &id001
description: The optional f parameter indicates the output format which the
server shall provide as part of the response document. The default format
is GeoJSON.
explode: false
in: query
name: f
required: false
schema:
default: json
enum:
- json
- html
- jsonld
- csv
type: string
style: form
- &id002
description: The optional lang parameter instructs the server return a response
in a certain language, if supported. If the language is not among the available
values, the Accept-Language header language will be used if it is supported.
If the header is missing, the default server language is used. Note that
providers may only support a single language (or often no language at all),
that can be different from the server language. Language strings can be
written in a complex (e.g. "fr-CA,fr;q=0.9,en-US;q=0.8,en;q=0.7"), simple
(e.g. "de") or locale-like (e.g. "de-CH" or "fr_BE") fashion.
in: query
name: lang
required: false
schema:
default: en-US
enum:
- en-US
- fr-CA
type: string
- $ref: '#/components/parameters/bbox'
- $ref: https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/parameters/limit
- $ref: '#/components/parameters/crs'
- $ref: '#/components/parameters/bbox-crs'
- description: The properties that should be included for each feature. The
parameter value is a comma-separated list of property names.
explode: false
in: query
name: properties
required: false
schema:
items:
enum:
- theme
- type
- org
type: string
type: array
style: form
- $ref: '#/components/parameters/vendorSpecificParameters'
- $ref: '#/components/parameters/skipGeometry'
- $ref: https://raw.githubusercontent.com/opengeospatial/ogcapi-records/master/core/openapi/parameters/sortby.yaml
- $ref: '#/components/parameters/offset'
- $ref: https://raw.githubusercontent.com/opengeospatial/ogcapi-records/master/core/openapi/parameters/q.yaml
- $ref: https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/parameters/datetime
- explode: false
in: query
name: theme
required: false
schema:
label-en: Themes
label-fr: "Th\xE8mes"
type: string
values-en:
- administration
- economy
- environment
- imagery
- infrastructure
- science
- society
- legal
- emergency
values-fr:
- administration
- "\xE9conomie"
- environnement
- imagerie
- infrastructure
- renseignements juridiques
- science
- "soci\xE9t\xE9"
- urgences
style: form
- explode: false
in: query
name: type
required: false
schema:
label-en: Types
label-fr: Types
type: string
values-en:
- API
- Application
- Collection
- Community
- Dataset
- Service
values-fr:
- API
- Application
- Collection
- "Communaut\xE9"
- "Jeu de donn\xE9es"
- Service
style: form
- explode: false
in: query
name: org
required: false
schema:
label-en: Organizations
label-fr: Organisations
type: string
values-en:
- Agriculture and Agri-Food Canada
- Canadian Geospatial Data Infrastructure Web Harvester
- Canadian Heritage
- Canadian Northern Economic Development Agency
- Canadian Nuclear Safety Commission
- Canadian Space Agency
- Department of Justice
- Elections Canada
- Employment and Social Development Canada
- Environment and Climate Change Canada
- Fisheries and Oceans Canada
- "Government and Municipalities of Qu\xE9bec"
- Government of Alberta
- Government of British Columbia
- Government of Manitoba
- Government of New Brunswick
- Government of Newfoundland and Labrador
- Government of Northwest Territories
- Government of Nova Scotia
- Government of Nunavut
- Government of Ontario
- Government of Prince Edward Island
- Government of Saskatchewan
- Government of Yukon
- Impact Assessment Agency of Canada
- Indigenous Services Canada
- Innovation, Science and Economic Development Canada
- Natural Resources Canada
- Parks Canada
- Public Health Agency of Canada
- Statistics Canada
- Transport Canada
values-fr:
- "Agence Canadienne de D\xE9veloppement \xE9conomique du Nord"
- "Agence d'\xE9valuation d'impact du Canada"
- "Agence de la sant\xE9 publique du Canada"
- Agence spatiale canadienne
- Agriculture et Agroalimentaire Canada
- "Commission canadienne de s\xFBret\xE9 nucl\xE9aire"
- "D\xE9fense nationale"
- "\xC9lections Canada"
- "Emploi et D\xE9veloppement social Canada"
- Environnement et Changement climatique Canada
- Gouvernement de l'Alberta
- "Gouvernement de l'\xCEle-du-Prince-\xC9douard"
- Gouvernement de l'Ontario
- Gouvernement de la Colombie-Britannique
- "Gouvernement de la Nouvelle-\xC9cosse"
- Gouvernement de la Saskatchewan
- Gouvernement de Terre-Neuve-et-Labrador
- Gouvernement des Territoires du Nord-Ouest
- Gouvernement du Manitoba
- Gouvernement du Nouveau-Brunswick
- Gouvernement du Nunavut
- Gouvernement du Yukon
- "Gouvernement et municipalit\xE9s du Qu\xE9bec"
- "Minist\xE8re de la Justice"
- "Moissonneur web de l'Infrastructure canadienne de donn\xE9es g\xE9ospatiales"
- Parcs Canada
- Patrimoine canadien
- "P\xEAches et Oc\xE9ans Canada"
- Ressources naturelles Canada
- Services aux Autochtones Canada
- Statistique Canada
- Transports Canada
style: form
responses:
'200':
$ref: https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Features
'400':
$ref: https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter
'404':
$ref: https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound
'500':
$ref: https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError
summary: Get Canadian Geospatial Platform (CGP) metadata items
tags:
- canadian-geospatial-platform
options:
description: Canadian Geospatial Platform metadata (GeoCore API provider)
operationId: optionsCanadian-geospatial-platformFeatures
responses:
'200':
description: options response
summary: Options for Canadian Geospatial Platform (CGP) metadata items
tags:
- canadian-geospatial-platform
/collections/canadian-geospatial-platform/items/{featureId}:
get:
description: Canadian Geospatial Platform metadata (GeoCore API provider)
operationId: getCanadian-geospatial-platformFeature
parameters:
- $ref: https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/parameters/featureId
- $ref: '#/components/parameters/crs'
- $ref: '#/components/parameters/f'
- $ref: '#/components/parameters/lang'
responses:
'200':
$ref: https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Feature
'400':
$ref: https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter
'404':
$ref: https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound
'500':
$ref: https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError
summary: Get Canadian Geospatial Platform (CGP) metadata item by id
tags:
- canadian-geospatial-platform
options:
description: Canadian Geospatial Platform metadata (GeoCore API provider)
operationId: optionsCanadian-geospatial-platformFeature
parameters:
- $ref: https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/parameters/featureId
responses:
'200':
description: options response
summary: Options for Canadian Geospatial Platform (CGP) metadata item by id
tags:
- canadian-geospatial-platform
/collections/canadian-geospatial-platform/queryables:
get:
description: Canadian Geospatial Platform metadata (GeoCore API provider)
operationId: getCanadian-geospatial-platformQueryables
parameters:
- *id001
- *id002
responses:
'200':
$ref: '#/components/responses/Queryables'
'400':
$ref: https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter
'404':
$ref: https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound
'500':
$ref: https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError
summary: Get Canadian Geospatial Platform (CGP) metadata queryables
tags:
- canadian-geospatial-platform
/collections/canadian-geospatial-platform/schema:
get:
description: Canadian Geospatial Platform metadata (GeoCore API provider)
operationId: getCanadian-geospatial-platformQueryables
parameters:
- *id001
- *id002
responses:
'200':
$ref: '#/components/responses/Queryables'
'400':
$ref: https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter
'404':
$ref: https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound
'500':
$ref: https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError
summary: Get Canadian Geospatial Platform (CGP) metadata schema
tags:
- canadian-geospatial-platform
/conformance:
get:
description: API conformance definition
operationId: getConformanceDeclaration
parameters:
- $ref: '#/components/parameters/f'
- $ref: '#/components/parameters/lang'
responses:
'200':
$ref: https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/LandingPage
'400':
$ref: https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter
'500':
$ref: https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError
summary: API conformance definition
tags:
- server
/openapi:
get:
description: This document
operationId: getOpenapi
parameters:
- $ref: '#/components/parameters/f'
- $ref: '#/components/parameters/lang'
- description: UI to render the OpenAPI document
explode: false
in: query
name: ui
required: false
schema:
default: swagger
enum:
- swagger
- redoc
type: string
style: form
responses:
'200':
$ref: '#/components/responses/200'
'400':
$ref: https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter
default:
$ref: '#/components/responses/default'
summary: This document
tags:
- server
servers:
- description: An OGC API - Records compliant website for the Canadian Geospatial
Platform (CGP). The application is based on the pygeoapi core version provided
in the footer. This service has been augmented with a 'geocore' provider to connect
with the geo.ca backend
url: http://localhost:5000
tags:
- description: An OGC API - Records compliant website for the Canadian Geospatial
Platform (CGP). The application is based on the pygeoapi core version provided
in the footer. This service has been augmented with a 'geocore' provider to connect
with the geo.ca backend
externalDocs:
description: information
url:
en: https://canadian-geospatial-platform.github.io/geocore/
fr: https://canadian-geospatial-platform.github.io/geocore/
name: server
- description: SpatioTemporal Asset Catalog
name: stac
- description: Canadian Geospatial Platform metadata (GeoCore API provider)
name: canadian-geospatial-platform