Skip to content

Commit 27e483f

Browse files
committed
GET /service_types: Added specification property to identify the actual specification the exposed services implement.
1 parent 5f6aab6 commit 27e483f

File tree

2 files changed

+38
-0
lines changed

2 files changed

+38
-0
lines changed

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1212
- [Remote Process Definition Extension](./extensions/remote-process-definition/README.md)
1313
- [Processing Parameters Extension](./extensions/processing-parameters/README.md)
1414
- `GET /`: New relation type `web-editor` [#577](https://github.com/Open-EO/openeo-api/issues/577)
15+
- `GET /service_types`: Added `specification` property to identify the actual specification the exposed services implement. [#580](https://github.com/Open-EO/openeo-api/issues/580)
1516
- `GET /credentials/oidc`: Added `authorization_parameters` property to enforce specific parameters for the authorization endpoint [#534](https://github.com/Open-EO/openeo-api/issues/534)
1617
- `POST /result`: Added response header "OpenEO-Identifier" to expose an identifier associated with a synchronous processing request.
1718
- Added `stacktrace` to log entries (e.g. for `GET /jobs/{job_id}/logs`) [#512](https://github.com/Open-EO/openeo-api/issues/512)

openapi.yaml

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2521,6 +2521,9 @@ paths:
25212521
[OGC Schema Repository](http://schemas.opengis.net/) for the respective
25222522
services.
25232523
2524+
It is RECOMMENDED to use the values provided in the `specification` property as
2525+
the service names.
2526+
25242527
Service names MUST be accepted in a *case insensitive* manner throughout the API.
25252528
tags:
25262529
- Capabilities
@@ -2555,6 +2558,8 @@ paths:
25552558
$ref: '#/components/schemas/deprecated'
25562559
experimental:
25572560
$ref: '#/components/schemas/experimental'
2561+
specification:
2562+
$ref: '#/components/schemas/service_specification'
25582563
configuration:
25592564
title: Service Configuration
25602565
description: Map of supported configuration settings made available to the creator of the service.
@@ -5860,6 +5865,38 @@ components:
58605865
- $ref: '#/components/schemas/usage'
58615866
log_level:
58625867
$ref: '#/components/schemas/min_log_level_default'
5868+
service_specification:
5869+
type: string
5870+
description: |-
5871+
The type of the service that is implemented.
5872+
Provides an indication of what clients can expect for the service.
5873+
It is REQUIRED to use the official abbreviations as shown as otherwise
5874+
client software might not recognize the service type.
5875+
5876+
- OGC WCS: wcs
5877+
- OGC WFS: wfs
5878+
- OGC WMS: wms
5879+
- OGC WMTS: wmts
5880+
- OGC API - Discrete Global Grid Systems (DGGS) - ogcapi-dggs
5881+
- OGC API - Environmental Data Retrieval (EDR): ogcapi-edr
5882+
- OGC API - Features: ogcapi-features
5883+
- OGC API - Coverages: ogcapi-coverages
5884+
- OGC API - Maps: ogcapi-maps
5885+
- OGC API - Tiles: ogcapi-tiles
5886+
- OSGeo Tile Map Service (TMS): tms
5887+
- STAC: stac
5888+
- XYZ: xyz
5889+
5890+
For other OGC APIs, use the the result of the following regular expression applied
5891+
to the external identifier of respective OGC document:
5892+
`^http://www.opengis.net/doc/IS/([\w-]+)-\d+/`
5893+
5894+
For other legacy OGC specifications, use the abbreviations used in the official
5895+
[OGC Schema Repository](http://schemas.opengis.net/) for the respective specification.
5896+
5897+
For other missing service types, please open an issue in the
5898+
[openEO API repository](https://github.com/Open-EO/openeo-api).
5899+
example: xyz
58635900
service_type:
58645901
description: >-
58655902
Definition of the service type to access result data. All available

0 commit comments

Comments
 (0)