Skip to content

Commit 4b85712

Browse files
committed
Review comments by Scott Simmons
1 parent 3227e33 commit 4b85712

File tree

1 file changed

+18
-19
lines changed

1 file changed

+18
-19
lines changed

openapi.yaml

Lines changed: 18 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ info:
117117
If a URL should be publicly available to everyone, it can simply a user-specific URL, e.g. `https://openeo.example/processes/john_doe/ndvi`.
118118
For resources that should only be accessible to a certain group of user, a signed URL could be given, e.g. `https://openeo.example/processes/81zjh1tc2pt52gbx/ndvi`.
119119
120-
Generally, it is RECOMMENDED adding descriptive titles (propertty `title`) and media type information (propertty `type`) for a better user experience.
120+
Generally, it is RECOMMENDED adding descriptive titles (property `title`) and media type information (property `type`) for a better user experience.
121121
122122
## Error Handling
123123
@@ -193,7 +193,7 @@ info:
193193
194194
## Temporal data
195195
196-
Date, time, time intervals, and durations are formatted based on ISO 8601 or its profile [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339.html) whenever there is an appropriate encoding available in the standard. All temporal data are specified based on the Gregorian calendar.
196+
Date, time, time intervals, and durations are formatted based on [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) or its profile [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339.html) whenever there is an appropriate encoding available in the standard. All temporal data are specified based on the Gregorian calendar.
197197
198198
# Authentication
199199
@@ -493,7 +493,7 @@ info:
493493
494494
### Full example for an EVI computation
495495
496-
Deriving minimum EVI (Enhanced Vegetation Index) measurements over pixel time series of Sentinel 2 imagery. The main process graph in blue, child process graphs in yellow:
496+
Deriving minimum EVI (Enhanced Vegetation Index) measurements over pixel time series of Sentinel-2 imagery. The main process graph in blue, child process graphs in yellow:
497497
498498
![Graph with processing instructions](assets/pg-evi-example.png)
499499
@@ -507,7 +507,7 @@ info:
507507
508508
2. A more dynamic way of processing and accessing data is to create a **secondary web service**. They allow web-based access using different protocols such as [OGC WMS](http://www.opengeospatial.org/standards/wms), [OGC WCS](http://www.opengeospatial.org/standards/wcs), [OGC API - Features](https://www.ogc.org/standards/ogcapi-features) or [XYZ tiles](https://wiki.openstreetmap.org/wiki/Slippy_map_tilenames). Some protocols such as the OGC WMS or XYZ tiles allow users to change the viewing extent or level of detail (zoom level). Therefore, computations often run *on demand* so that the requested data is calculated during the request. Back-ends should make sure to cache processed data to avoid additional/high costs and reduce waiting times for the user.
509509
510-
3. Processes can also be executed **on-demand** (i.e. synchronously). Results are delivered with the request itself and no job is created. Only lightweight computations, for example previews, should be executed using this approach as timeouts are to be expected for [long-polling HTTP requests](https://www.pubnub.com/blog/2014-12-01-http-long-polling/).
510+
3. Processes can also be executed **on-demand** (i.e. synchronously). Results are delivered with the request itself and no job is created. Only lightweight computations, for example previews, should be executed using this approach as timeouts are to be expected for [long-polling HTTP requests](https://www.pubnub.com/guides/long-polling/).
511511
512512
### Validation
513513
@@ -671,7 +671,7 @@ paths:
671671
api_version:
672672
type: string
673673
description: >-
674-
Version number of the openEO specification this back-end
674+
Version number of the openEO specification the back-end
675675
implements.
676676
enum:
677677
- 1.2.0
@@ -1003,7 +1003,7 @@ paths:
10031003
path. Make sure to correctly handle leading/trailing slashes.
10041004
3. Send a request to the new URI.
10051005
A. On success: Detect the most suitable API instance/version (see above)
1006-
and read the [capabilites](#tag/Capabilities/operation/capabilities)
1006+
and read the [capabilities](#tag/Capabilities/operation/capabilities)
10071007
from there.
10081008
B. On failure: Directly try to read the capabilities from the original URI
10091009
given by the user.
@@ -1247,7 +1247,7 @@ paths:
12471247
all OGC API standards and the STAC API specification. openEO adds relatively
12481248
broadly defined conformance classes, especially for the extensions.
12491249
Otherwise, the implemented functionality can usually be retrieved from
1250-
the [capabilties](#tag/Capabilities/operation/capabilities) in openEO.
1250+
the [capabilities](#tag/Capabilities/operation/capabilities) in openEO.
12511251
12521252
The general openEO conformance class is `https://api.openeo.org/1.2.0`.
12531253
See the individual openEO API extensions for their conformance classes.
@@ -1670,7 +1670,7 @@ paths:
16701670
$schema: https://json-schema.org/draft/2019-09/schema
16711671
$id: https://openeo.example/api/v1/collections/Sentinel-2A/queryables
16721672
type: object
1673-
title: Sentinel 2A
1673+
title: Sentinel-2A
16741674
properties:
16751675
'eo:cloud_cover':
16761676
title: Cloud Cover
@@ -1953,7 +1953,7 @@ paths:
19531953
- {}
19541954
responses:
19551955
'200':
1956-
description: Lists the the OpenID Connect Providers.
1956+
description: Lists the OpenID Connect Providers.
19571957
content:
19581958
application/json:
19591959
schema:
@@ -2270,7 +2270,7 @@ paths:
22702270
can be used to generate small previews or test user-defined processes before
22712271
starting a batch job.
22722272
2273-
Timeouts on either client- or server-side are to be expected for complex
2273+
Timeouts on either client-side or server-side are to be expected for complex
22742274
computations. Back-ends MAY send the openEO error `ProcessGraphComplexity`
22752275
immediately if the computation is expected to time out. Otherwise requests
22762276
MAY time-out after a certain amount of time by sending openEO error `RequestTimeout`.
@@ -3177,8 +3177,8 @@ paths:
31773177
duration:
31783178
type: string
31793179
description: >-
3180-
Estimated duration for the operation. Duration MUST be
3181-
specified as a ISO 8601 duration.
3180+
Estimated duration for the operation. Duration MUST be specified as an
3181+
[ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations).
31823182
example: P1Y2M10DT2H30M
31833183
size:
31843184
type: integer
@@ -3346,8 +3346,8 @@ paths:
33463346
example:
33473347
stac_version: 1.0.0
33483348
id: a3cca2b2aa1e3b5b
3349-
title: NDVI based on Sentinel 2
3350-
description: Deriving minimum NDVI measurements over pixel time series of Sentinel 2
3349+
title: NDVI based on Sentinel-2
3350+
description: Deriving minimum NDVI measurements over pixel time series of Sentinel-2
33513351
license: Apache-2.0
33523352
providers:
33533353
- name: Example Cloud Corp.
@@ -5006,9 +5006,8 @@ components:
50065006
nullable: true
50075007
step:
50085008
description: >-
5009-
The space between the temporal instances as
5010-
[ISO 8601
5011-
duration](https://en.wikipedia.org/wiki/ISO_8601#Durations),
5009+
The space between the temporal instances as an
5010+
[ISO 8601 Duration](https://en.wikipedia.org/wiki/ISO_8601#Durations),
50125011
e.g. `P1D`. Use `null` for irregularly
50135012
spaced steps.
50145013
type: string
@@ -5723,7 +5722,7 @@ components:
57235722
description: A short description to easily distinguish entities.
57245723
type: string
57255724
nullable: true
5726-
example: NDVI based on Sentinel 2
5725+
example: NDVI based on Sentinel-2
57275726
eo_description:
57285727
type: string
57295728
format: commonmark
@@ -5734,7 +5733,7 @@ components:
57345733
[CommonMark 0.29](http://commonmark.org/) syntax MAY be used for rich
57355734
text representation.
57365735
nullable: true
5737-
example: Deriving minimum NDVI measurements over pixel time series of Sentinel 2
5736+
example: Deriving minimum NDVI measurements over pixel time series of Sentinel-2
57385737
process_description:
57395738
type: string
57405739
format: commonmark

0 commit comments

Comments
 (0)