Skip to content

Commit e9ed2bb

Browse files
committed
Renamed according to PR review
1 parent 917a3fd commit e9ed2bb

File tree

2 files changed

+16
-16
lines changed

2 files changed

+16
-16
lines changed

extensions/processing-parameters/README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Processing Parameters Extension
22

3-
The Processing Parameters Extension to the openEO API provides an interface to explore and handle additional processing options that a back-end can offer for the three processing modes (synchronous processing, batch jobs, secondary web services).
3+
The Processing Parameters Extension to the openEO API provides an interface to explore and handle additional processing parameters that a back-end can offer for the three processing modes (synchronous processing, batch jobs, secondary web services).
44

55
- Version: **0.1.0**
66
- Stability: **experimental**
@@ -10,8 +10,8 @@ The Processing Parameters Extension to the openEO API provides an interface to e
1010
**Note:** This document only documents the additions to the specification.
1111
Extensions can not change or break existing behavior of the openEO API.
1212

13-
This extension adds a new endpoint (`GET /processing_options`, see [OpenAPI document](openapi.yaml))
14-
to discover the additional processing options that a back-end offers.
13+
This extension adds a new endpoint (`GET /processing_parameters`, see [OpenAPI document](openapi.yaml))
14+
to discover the additional processing parameters that a back-end offers.
1515

1616
Additionally, this extension allows to provide specific default values for user-defined processes (UDPs, see below).
1717

@@ -21,12 +21,12 @@ In both cases, the parameters and its values are provided separately for each pr
2121

2222
UDPs can provide default values for specific processing parameters.
2323

24-
The values for each parameter are provided separately for each processing mode.
24+
The values for each parameter (so called 'options') are provided separately for each processing mode.
2525
The following properties are added to the top-level of a UDP for the respective processing modes:
2626

27-
- `default_synchronous_parameters` for synchronous processing
28-
- `default_job_parameters` for batch jobs
29-
- `default_service_parameters` for secondary web services
27+
- `default_synchronous_options` for synchronous processing
28+
- `default_job_options` for batch jobs
29+
- `default_service_options` for secondary web services
3030

3131
The schema for each of these properties is:
3232

@@ -38,7 +38,7 @@ additionalProperties:
3838
3939
The keys of the object are the respective parameter names.
4040
The values of the object are the default values for the parameters.
41-
Schematic restrictions are not defined for the object, but the schemas for the parameters as defined in `GET /processing_options` apply to the given values.
41+
Schematic restrictions are not defined for the object, but the schemas for the parameters as defined in `GET /processing_parameters` apply to the given values.
4242
These values provide the defaults unless a user overrides them in the actual data processing request (e.g. `POST /jobs`, see below).
4343

4444
## Resolving parameters
@@ -48,7 +48,7 @@ list defines how the parameters must be resolved. The prioritization is as follo
4848

4949
1. If present, use the parameter specified in the processing request directly (e.g. in `POST /jobs` as a top-level property)
5050
2. If present, use the default parameter specified in the UDP
51-
3. Otherwise, use the default value for the parameter as specified in `GET /processing_options`
51+
3. Otherwise, use the default value for the parameter as specified in `GET /processing_parameters`
5252

5353
"Present" means that the property is present in the JSON representation regardless of the value given, i.e.
5454
properties are present if an empty string, an empty array, an empty object, `false`, `0`, or `null` are provided.

extensions/processing-parameters/openapi.yaml

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ info:
33
title: openEO API - Processing Parameters Extension
44
version: 0.1.0
55
description: >-
6-
The Processing Parameters Extension to the openEO API provides an interface to explore and handle additional processing options that a back-end can offer for the three processing modes (synchronous processing, batch jobs, and secondary web services).
6+
The Processing Parameters Extension to the openEO API provides an interface to explore and handle additional processing parameters that a back-end can offer for the three processing modes (synchronous processing, batch jobs, and secondary web services).
77
The openEO API specification allows back-ends to accept "additional back-end specific properties" for each of the processing modes.
88
As the openEO API specification does not define the name and schemas of these properties, this extension provides a standardized way to define and document these properties.
99
contact:
@@ -44,15 +44,15 @@ servers:
4444
the version number of the API. Use the version number returned from
4545
`GET /` instead.
4646
paths:
47-
/processing_options:
47+
/processing_parameters:
4848
get:
49-
summary: Additional processing options
50-
operationId: list-processing-options
49+
summary: Additional processing parameters
50+
operationId: list-processing-parameters
5151
description: |-
52-
Lists additional custom processing options
52+
Lists additional custom processing parameters
5353
that a back-end offers for the different processing modes (synchronous processing, batch jobs, secondary web services).
54-
The options specified here can be added to the corresponding `POST` requests at the top-level of the object that is sent as the payload.
55-
All options SHOULD explicitly be made optional with reasonable defaults as otherwise the interoperability between the implementations decreases.
54+
The parameters specified here can be added to the corresponding `POST` requests at the top-level of the object that is sent as the payload.
55+
All parameters SHOULD explicitly be made optional with reasonable defaults as otherwise the interoperability between the implementations decreases.
5656
tags:
5757
- Capabilities
5858
- Data Processing

0 commit comments

Comments
 (0)