Skip to content

Commit 1a49346

Browse files
committed
Secondary web services: Specify variables that can be used in process graphs (#172), updated changelog.
1 parent 5e85547 commit 1a49346

File tree

2 files changed

+41
-5
lines changed

2 files changed

+41
-5
lines changed

CHANGELOG.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ All notable changes to this project will be documented in this file.
44
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
55
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
66

7-
## [0.4.0] - 2019-03-06
7+
## [0.4.0] - 2019-03-07
88
### Added
99
- `GET /jobs/{job_id}/estimate` can return the estimated required storage capacity. [#122](https://github.com/Open-EO/openeo-api/issues/122)
1010
- `GET /jobs/{job_id}` has two new properties:
@@ -23,10 +23,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
2323
- Processes and parameters can be declared to be `experimental`.
2424
- `GET /output_formats` and `GET /service_types` can now provide links per entry.
2525
- `GET /udf_runtimes` provide a list of UDF runtime environments. [#87](https://github.com/Open-EO/openeo-api/issues/87)
26+
- `GET /service_types` allows to specify `variables` that can be used in process graphs. [#172](https://github.com/Open-EO/openeo-api/issues/172)
2627

2728
### Changed
28-
- Completely new version of the processes
29+
- Completely new version of the processes.
2930
- Changed process graph to a flexible graph-like structure, which also allows callbacks. [#160](https://github.com/Open-EO/openeo-api/issues/160)
31+
- Updated `GET /collections` and `GET /collections/{collection_id}` to follow STAC v0.6.2. [#158](https://github.com/Open-EO/openeo-api/issues/158), [#173](https://github.com/Open-EO/openeo-api/issues/173)
3032
- The `process_graph_id` of stored process graphs, the `service_id` of services and the `job_id` of jobs has changed to `id` in responses. [#130](https://github.com/Open-EO/openeo-api/issues/130)
3133
- The `status` property for jobs is now required.
3234
- `POST /preview` renamed to `POST /result`. [#162](https://github.com/Open-EO/openeo-api/issues/162)

openapi.json

Lines changed: 37 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2206,7 +2206,7 @@
22062206
"/service_types": {
22072207
"get": {
22082208
"summary": "Supported secondary web service protocols",
2209-
"description": "The request will ask the back-end for supported secondary web service protocols, e.g. WMS or WCS. The response is an object of all available secondary web service protocols, including their parameters and attributes.\nParameters configure the service and therefore need to be defined upon creation of a service. Attributes are read-only characteristics of the service and may be computed based on the parameters, e.g. available layers for a WMS based on the bands in the underlying GeoTiff.\nTo improve interoperability between back-ends common names for the services SHOULD be used, e.g. the abbreviations used in the official [OGC Schema Repository](http://schemas.opengis.net/) for the respective services.\nService names are allowed to be *case insensitive* throughout the API.",
2209+
"description": "The request will ask the back-end for supported secondary web service protocols, e.g. WMS or WCS. The response is an object of all available secondary web service protocols, including their parameters, attributes and process graph variables.\nParameters configure the service and therefore need to be defined upon creation of a service. Attributes are read-only characteristics of the service and may be computed based on the parameters, e.g. available layers for a WMS based on the bands in the underlying GeoTiff.\nA list of process graph variables is also available. This variables can be used by users in a process graph that is used to compute web service results. The objects can directly be used inside the process graph. Such variables are usually things that have to be injected into the process graph from the context of the web service. For example, a map service such as a WMS would need to inject the spatial extent into the process graph so that the back-end can compute the corresponding tile correctly.\nTo improve interoperability between back-ends common names for the services SHOULD be used, e.g. the abbreviations used in the official [OGC Schema Repository](http://schemas.opengis.net/) for the respective services.\nService names are allowed to be *case insensitive* throughout the API.",
22102210
"tags": [
22112211
"Capabilities",
22122212
"Secondary Services Management"
@@ -2231,21 +2231,29 @@
22312231
"type": "object",
22322232
"properties": {
22332233
"parameters": {
2234-
"type": "object",
22352234
"title": "Service Type Parameters",
22362235
"description": "List of supported parameters for configuration.",
2236+
"type": "object",
22372237
"additionalProperties": {
22382238
"$ref": "#/components/schemas/argument"
22392239
}
22402240
},
22412241
"attributes": {
2242-
"type": "object",
22432242
"title": "Service Type Attributes",
22442243
"description": "List of supported attributes.",
2244+
"type": "object",
22452245
"additionalProperties": {
22462246
"$ref": "#/components/schemas/argument"
22472247
}
22482248
},
2249+
"variables": {
2250+
"title": "Service Type Variables",
2251+
"description": "List of supported process graph variables.",
2252+
"type": "array",
2253+
"items": {
2254+
"$ref": "#/components/schemas/variable"
2255+
}
2256+
},
22492257
"links": {
22502258
"description": "Additional links related to this service type, e.g. more information about the parameters, attributes or options to access the created services.",
22512259
"type": "array",
@@ -2279,6 +2287,30 @@
22792287
]
22802288
}
22812289
},
2290+
"variables": [
2291+
{
2292+
"variable_id": "layer",
2293+
"type": "string",
2294+
"desctiption": "The layer name.",
2295+
"default": "roads"
2296+
},
2297+
{
2298+
"variable_id": "spetial_extent_west",
2299+
"type": "number"
2300+
},
2301+
{
2302+
"variable_id": "spetial_extent_east",
2303+
"type": "number"
2304+
},
2305+
{
2306+
"variable_id": "spetial_extent_north",
2307+
"type": "number"
2308+
},
2309+
{
2310+
"variable_id": "spetial_extent_south",
2311+
"type": "number"
2312+
}
2313+
],
22822314
"links": [
22832315
{
22842316
"href": "https://www.opengeospatial.org/standards/wms",
@@ -4097,6 +4129,7 @@
40974129
"enum": [
40984130
"string",
40994131
"number",
4132+
"integer",
41004133
"boolean",
41014134
"array",
41024135
"object"
@@ -4165,6 +4198,7 @@
41654198
}
41664199
},
41674200
"process_argument_value": {
4201+
"title": "Process Argument Value",
41684202
"description": "Arguments for a process. See the API documentation for more information.",
41694203
"nullable": true,
41704204
"oneOf": [

0 commit comments

Comments
 (0)