Skip to content

Commit

Permalink
add OGC preamble
Browse files Browse the repository at this point in the history
  • Loading branch information
m-mohr committed Dec 1, 2024
1 parent fdcc937 commit 3227e33
Showing 1 changed file with 59 additions and 3 deletions.
62 changes: 59 additions & 3 deletions openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,63 @@ info:
title: OGC openEO API Community Standard
version: 1.2.0
description: |-
The openEO API specification for interoperable cloud-based processing of large Earth observation datasets.
# Introduction
The OGC openEO API specification Community Standard defines an API in support of interoperable cloud-based processing of large Earth observation datasets.
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.
## Abstract
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.
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.
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.
## Source of this Document
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.
## Validity of Content
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.
## Keywords
The following are keywords to be used by search engines and document catalogues.
ogcdoc, OGC document, openEO, API, Earth observation, cloud, processing
## Submitting Organizations
The following organizations submitted this Document to the Open Geospatial Consortium (OGC):
- openEO Project Steering Committee
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).
## Supporting Organizations
The following organization (in alphabetical order) support the submission of the openEO Community Standard to the OGC:
- EOX IT Services GmbH
- EUMETSAT
- Eurac Research
- European Space Agency (ESA)
- GeoConnections - Natural Resources Canada
- German Aerospace Center - DLR
- Matthias Mohr - Softwareentwicklung
- Planet Labs PBC
- Telespazio VEGA UK Ltd
- University of Münster - Institute for Geoinformatics
- VITO (Flemish Institute for Technological Research)
## License Agreement
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.
## Conformance
**Conformance class:** `https://api.openeo.org/1.2.0`
Expand Down Expand Up @@ -161,7 +217,7 @@ info:
Source: [https://en.wikipedia.org/wiki/Cross-origin_resource_sharing](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing)
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.
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.
**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.
Expand Down Expand Up @@ -473,7 +529,7 @@ info:
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!
contact:
name: openEO Consortium
name: openEO Project Steering Committee
url: 'https://openeo.org'
email: [email protected]
license:
Expand Down

0 comments on commit 3227e33

Please sign in to comment.