diff --git a/pygeoapi-openapi.yml b/pygeoapi-openapi.yml index 5577241..45df001 100644 --- a/pygeoapi-openapi.yml +++ b/pygeoapi-openapi.yml @@ -48,8 +48,7 @@ components: type: string style: form f: - description: - The optional f parameter indicates the output format which the + 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 @@ -59,14 +58,13 @@ components: schema: default: json enum: - - json - - html - - jsonld + - json + - html + - jsonld type: string style: form lang: - description: - The optional lang parameter instructs the server return a response + 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 @@ -80,12 +78,11 @@ components: schema: default: en-US enum: - - en-US - - fr-CA + - en-US + - fr-CA type: string offset: - description: - The optional offset parameter indicates the index within the result + 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 @@ -98,8 +95,7 @@ components: type: integer style: form properties: - description: - The properties that should be included for each feature. The parameter + 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 @@ -129,7 +125,7 @@ components: type: object style: form responses: - "200": + '200': description: successful operation "204": description: no content @@ -137,7 +133,7 @@ components: content: application/json: schema: - $ref: "#/components/schemas/queryables" + $ref: '#/components/schemas/queryables' description: successful queryables operation default: content: @@ -153,7 +149,7 @@ components: type: string language: default: - - en + - en description: the language used for the title and description type: string queryable: @@ -170,17 +166,17 @@ components: format: url type: string required: - - queryable - - type + - queryable + - type type: object queryables: properties: queryables: items: - $ref: "#/components/schemas/queryable" + $ref: '#/components/schemas/queryable' type: array required: - - queryables + - queryables type: object info: contact: @@ -195,9 +191,9 @@ info: title: pygeoapi default instance version: 0.16.dev0 x-keywords: - - geospatial - - data - - api + - geospatial + - data + - api openapi: 3.0.2 paths: /: @@ -205,75 +201,113 @@ paths: description: Landing page operationId: getLandingPage parameters: - - $ref: "#/components/parameters/f" - - $ref: "#/components/parameters/lang" + - $ref: '#/components/parameters/f' + - $ref: '#/components/parameters/lang' responses: - "200": + '200': $ref: https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/LandingPage - "400": + '400': $ref: https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter - "500": + '500': $ref: https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError summary: Landing page tags: - - server + - server /collections: get: description: Collections operationId: getCollections parameters: - - $ref: "#/components/parameters/f" - - $ref: "#/components/parameters/lang" + - $ref: '#/components/parameters/f' + - $ref: '#/components/parameters/lang' responses: - "200": + '200': $ref: https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/LandingPage - "400": + '400': $ref: https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter - "500": + '500': $ref: https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError summary: Collections tags: - - server + - server /collections/lakes: get: description: lakes of the world, public domain operationId: describeLakesCollection parameters: - - $ref: "#/components/parameters/f" - - $ref: "#/components/parameters/lang" + - $ref: '#/components/parameters/f' + - $ref: '#/components/parameters/lang' responses: - "200": + '200': $ref: https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Collection - "400": + '400': $ref: https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter - "404": + '404': $ref: https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound - "500": + '500': $ref: https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError summary: Get Large Lakes metadata tags: - - lakes + - lakes /collections/lakes/items: get: description: lakes of the world, public domain operationId: getLakesFeatures 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 + - &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: - - json - - html - - jsonld - - csv + - id + - scalerank + - name + - name_alt + - admin + - featureclass type: string style: form - &id002 @@ -365,13 +399,13 @@ paths: type: string style: form responses: - "200": + '200': $ref: https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Features - "400": + '400': $ref: https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter - "404": + '404': $ref: https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound - "500": + '500': $ref: https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError summary: Get Large Lakes items tags: @@ -394,13 +428,13 @@ paths: - $ref: "#/components/parameters/f" - $ref: "#/components/parameters/lang" responses: - "200": + '200': $ref: https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Feature - "400": + '400': $ref: https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter - "404": + '404': $ref: https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound - "500": + '500': $ref: https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError summary: Get Large Lakes item by id tags: @@ -420,39 +454,39 @@ paths: description: lakes of the world, public domain operationId: getLakesQueryables parameters: - - *id001 - - *id002 + - *id001 + - *id002 responses: - "200": - $ref: "#/components/responses/Queryables" - "400": + '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": + '404': $ref: https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound - "500": + '500': $ref: https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError summary: Get Large Lakes queryables tags: - - lakes + - lakes /collections/obs: get: description: My cool observations operationId: describeObsCollection parameters: - - $ref: "#/components/parameters/f" - - $ref: "#/components/parameters/lang" + - $ref: '#/components/parameters/f' + - $ref: '#/components/parameters/lang' responses: - "200": + '200': $ref: https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Collection - "400": + '400': $ref: https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter - "404": + '404': $ref: https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound - "500": + '500': $ref: https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError summary: Get Observations metadata tags: - - obs + - obs /collections/obs/items: get: description: My cool observations @@ -491,36 +525,48 @@ paths: required: false schema: type: string - style: form - - explode: false - in: query - name: stn_id - required: false - schema: - type: integer - style: form - - explode: false - in: query - name: datetime - required: false - schema: - type: string - style: form - - explode: false - in: query - name: value - required: false - schema: - type: number - style: form + 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' + - explode: false + in: query + name: id + required: false + schema: + type: string + style: form + - explode: false + in: query + name: stn_id + required: false + schema: + type: integer + style: form + - explode: false + in: query + name: datetime + required: false + schema: + type: string + style: form + - explode: false + in: query + name: value + required: false + schema: + type: number + style: form responses: - "200": + '200': $ref: https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Features - "400": + '400': $ref: https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter - "404": + '404': $ref: https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound - "500": + '500': $ref: https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError summary: Get Observations items tags: @@ -543,13 +589,13 @@ paths: - $ref: "#/components/parameters/f" - $ref: "#/components/parameters/lang" responses: - "200": + '200': $ref: https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Feature - "400": + '400': $ref: https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter - "404": + '404': $ref: https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound - "500": + '500': $ref: https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError summary: Get Observations item by id tags: @@ -569,33 +615,33 @@ paths: description: My cool observations operationId: getObsQueryables parameters: - - *id001 - - *id002 + - *id001 + - *id002 responses: - "200": - $ref: "#/components/responses/Queryables" - "400": + '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": + '404': $ref: https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound - "500": + '500': $ref: https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError summary: Get Observations queryables tags: - - obs + - obs /conformance: get: description: API conformance definition operationId: getConformanceDeclaration parameters: - - $ref: "#/components/parameters/f" - - $ref: "#/components/parameters/lang" + - $ref: '#/components/parameters/f' + - $ref: '#/components/parameters/lang' responses: - "200": + '200': $ref: https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/LandingPage - "400": + '400': $ref: https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter - "500": + '500': $ref: https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError summary: API conformance definition tags: @@ -674,65 +720,63 @@ paths: 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 + - $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": + '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" + $ref: '#/components/responses/default' summary: This document tags: - - server + - server /processes: get: description: Processes operationId: getProcesses parameters: - - $ref: "#/components/parameters/f" + - $ref: '#/components/parameters/f' responses: - "200": + '200': $ref: https://schemas.opengis.net/ogcapi/processes/part1/1.0/openapi/responses/ProcessList.yaml default: - $ref: "#/components/responses/default" + $ref: '#/components/responses/default' summary: Processes tags: - - server + - server /processes/hello-world: get: - description: - An example process that takes a name as input, and echoes it back + description: An example process that takes a name as input, and echoes it back as output. Intended to demonstrate a simple process with a single literal input. operationId: describeHello-worldProcess parameters: - - $ref: "#/components/parameters/f" + - $ref: '#/components/parameters/f' responses: - "200": - $ref: "#/components/responses/200" + '200': + $ref: '#/components/responses/200' default: - $ref: "#/components/responses/default" + $ref: '#/components/responses/default' summary: Get process metadata tags: - - hello-world + - hello-world /processes/hello-world/execution: post: - description: - An example process that takes a name as input, and echoes it back + description: An example process that takes a name as input, and echoes it back as output. Intended to demonstrate a simple process with a single literal input. operationId: executeHello-worldJob @@ -748,19 +792,19 @@ paths: description: Mandatory execute request JSON required: true responses: - "200": - $ref: "#/components/responses/200" - "201": + '200': + $ref: '#/components/responses/200' + '201': $ref: https://schemas.opengis.net/ogcapi/processes/part1/1.0/openapi/responses/ExecuteAsync.yaml - "404": + '404': $ref: https://schemas.opengis.net/ogcapi/processes/part1/1.0/openapi/responses/NotFound.yaml - "500": + '500': $ref: https://schemas.opengis.net/ogcapi/processes/part1/1.0/openapi/responses/ServerError.yaml default: - $ref: "#/components/responses/default" + $ref: '#/components/responses/default' summary: Process Hello World execution tags: - - hello-world + - hello-world servers: - description: pygeoapi provides an API to geospatial data url: http://localhost:5000/geoapi