Skip to content

Commit 3227e33

Browse files
committed
add OGC preamble
1 parent fdcc937 commit 3227e33

File tree

1 file changed

+59
-3
lines changed

1 file changed

+59
-3
lines changed

openapi.yaml

Lines changed: 59 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,63 @@ info:
33
title: OGC openEO API Community Standard
44
version: 1.2.0
55
description: |-
6-
The openEO API specification for interoperable cloud-based processing of large Earth observation datasets.
6+
# Introduction
7+
8+
The OGC openEO API specification Community Standard defines an API in support of interoperable cloud-based processing of large Earth observation datasets.
9+
10+
We recommend reading the [glossary](https://openeo.org/documentation/1.0/glossary.html) before diving into the API specification. The glossary explains the most important terms used in the API specification.
11+
12+
## Abstract
13+
14+
openEO specifies an open application programming interface (API) for connecting applications and other client software to big Earth observation cloud back-ends in a simple and unified way.
15+
16+
The openEO specification aims at increasing the interoperability of big EO data processing of satellite imagery in the cloud. Implementations of openEO can be used to add an interoperability layer on top of existing services. Its development has been driven by the need to overcome the challenges associated with different tools, APIs, and data formats in geospatial technology. openEO has been developed from the bottom up, with each version of the specification supported by implementations.
17+
18+
The primary use case for specifying openEO was to simplify and unify the data processing using a common API and a specification for a set of pre-defined processes. As such, users can still work in their favored programming language without worrying about data organization and pre-processing. Users can avoid vendor lock-in as the generated process descriptions can be executed at multiple provider endpoints, making it easier to compare and reproduce processing results between different providers.
19+
20+
## Source of this Document
21+
22+
The majority of the content in this OGC document is a direct copy of the content contained at <https://github.com/Open-EO/openeo-api>. No normative changes have been made to the content. This OGC document does contain content not in source openEO API GitHub repository. Specifically, while derived from content on the openEO API repository, the chapters "Abstract", "Source of this Document", "Validity of Content", "Keywords", "Submitting Organizations", and "Supporting Organizations" in this document are not found on the openEO API repository.
23+
24+
## Validity of Content
25+
26+
The Submission Team has reviewed and certified that the snapshot content in this Community Standard is true and accurate. The snapshot for openEO API Version 1.2.0 was taken on December 1, 2024 from the openEO API Git Repository.
27+
28+
## Keywords
29+
30+
The following are keywords to be used by search engines and document catalogues.
31+
32+
ogcdoc, OGC document, openEO, API, Earth observation, cloud, processing
33+
34+
## Submitting Organizations
35+
36+
The following organizations submitted this Document to the Open Geospatial Consortium (OGC):
37+
38+
- openEO Project Steering Committee
39+
40+
The companies listed above have granted the Open Geospatial Consortium (OGC) a nonexclusive, royalty-free, paid up, worldwide license to copy and distribute this document and to modify this document and distribute copies of the modified version under a Apache License, Version 2.0 (see below).
41+
42+
## Supporting Organizations
43+
44+
The following organization (in alphabetical order) support the submission of the openEO Community Standard to the OGC:
45+
46+
- EOX IT Services GmbH
47+
- EUMETSAT
48+
- Eurac Research
49+
- European Space Agency (ESA)
50+
- GeoConnections - Natural Resources Canada
51+
- German Aerospace Center - DLR
52+
- Matthias Mohr - Softwareentwicklung
53+
- Planet Labs PBC
54+
- Telespazio VEGA UK Ltd
55+
- University of Münster - Institute for Geoinformatics
56+
- VITO (Flemish Institute for Technological Research)
57+
58+
## License Agreement
59+
60+
The standard is licensed under the [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0.html). You can implement this standard in services, clients or processing tools without restrictions.
61+
62+
## Conformance
763
864
**Conformance class:** `https://api.openeo.org/1.2.0`
965
@@ -161,7 +217,7 @@ info:
161217
162218
Source: [https://en.wikipedia.org/wiki/Cross-origin_resource_sharing](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing)
163219
164-
openEO-based back-ends are usually hosted on a different domain / host than the client that is requesting data from the back-end. Therefore, most requests to the back-end are blocked by all modern browsers. This leads to the problem that the JavaScript library and any browser-based application can not access back-ends. Therefore, all back-end providers SHOULD support CORS to enable browser-based applications to access back-ends. [CORS is a recommendation of the W3C organization](https://www.w3.org/TR/cors/). The following chapters explain how back-end providers can implement CORS support.
220+
openEO-based back-ends are usually hosted on a different domain / host than the client that is requesting data from the back-end. Therefore, most requests to the back-end are blocked by all modern browsers. This leads to the problem that the JavaScript library and any browser-based application can not access back-ends. Therefore, all back-end providers SHOULD support CORS to enable browser-based applications to access back-ends. [CORS is a recommendation of the W3C organization](https://www.w3.org/TR/2020/SPSD-cors-20200602/). The following chapters explain how back-end providers can implement CORS support.
165221
166222
**Tip**: Most servers can send the required headers and the responses to the OPTIONS requests automatically for all endpoints. Otherwise, a proxy server may be used to add the headers and OPTIONS responses.
167223
@@ -473,7 +529,7 @@ info:
473529
474530
Please be aware that the result node (`result` set to `true`) is not necessarily the last node that is executed. The author of the process graph may choose to set a non-end node to the result node!
475531
contact:
476-
name: openEO Consortium
532+
name: openEO Project Steering Committee
477533
url: 'https://openeo.org'
478534
email: openeo.psc@uni-muenster.de
479535
license:

0 commit comments

Comments
 (0)