Supported openEO versions
Lists all implemented openEO versions supported by the service provider. This endpoint is the Well-Known URI (see RFC 5785) for openEO.
This allows a client to easily identify the most recent openEO implementation it supports. By default, a client SHOULD connect to the most recent production-ready version it supports. If not available, the most recent supported version of all versions SHOULD be connected to. Clients MAY let users choose to connect to versions that are not production-ready or outdated. The most recent version is determined by comparing the version numbers according to rules from Semantic Versioning, especially §11. Any pair of API versions in this list MUST NOT be equal according to Semantic Versioning.
The Well-Known URI is the entry point for clients and users, so make sure it is permanent and easy to use and remember. Clients MUST NOT require the well-known path (/.well-known/openeo) in the URL that is specified by a user to connect to the back-end.
For clients, the usual behavior SHOULD follow these steps:
- The user provides a URI, which may consist of a scheme (protocol), an authority (host, port) and a path.
- The client parses the URI and appends /.well-knwon/openeo to the path. Make sure to correctly handle leading/trailing slashes.
- Send a request to the new URI. A. On success: Detect the most suitable API instance/version (see above) and read the capabilities from there. B. On failure: Directly try to read the capabilities from the original URI given by the user.
This URI MUST NOT be versioned as the other endpoints. If your API is available at https://openeo.example/api/v1, and you instruct your API users to use https://openeo.example as connection URI, the Well-Known URI SHOULD be located at https://openeo.example/.well-known/openeo. The Well-Known URI is usually directly located at the top-level, but it is not a requirement. For example, https://openeo.example/eo/.well-known/openeo is also allowed.
Clients MAY get additional information (e.g. title or description) about a back-end from the most recent version that has the production flag set to true.
Response
List of all available API instances, each with URL and the implemented openEO API version.
Example response
{
"versions": [
{
"url": "https://openeo.example/api/v1"
}
]
}