1. Overview
2. Installation
3. Scope of functionalities
4. Examples of use
5. Appendix
The goal is to provide a openEO compliant HTTP API which can communicate with other micorservices in the project. It can create and execute batch jobs. These jobs load data and execute two predefined processes. For more information on the other micorservices you can look at their repositories:
This subproject covers the points /F0010/ to /F0060/ of the requirements.
There also exists a Docker Repository, which is linked with this one and from which the service can be obtained as an image. And can then be used locally as a container.
The installation and execution is possible exclusively provided within the framework of the docker-compose.yml.docker-compose up
You can now checkout every endpoint with the base url localhost/api/v1/.
This HTTP API is structured after the openEO API specification. At the moment only the most basic endpoints are implemented.
The first main function of this microservice is to provide basic information on the processes and collections offered by the whole project under the endpoints /processes and /collections. The second one is to create, change and execute the batch jobs which can start the other microservices.
GET /collections
List all available collectionsGET /processes
Lists all available processesGET /jobs
Lists all created batch jobsPOST /jobs
Creates a new batch job with the posted JSONGET /jobs/{job_id}/
Returns information about the specified jobDELETE /jobs/{job_id}/
Deletes the specified jobPATCH /jobs/{job_id}/
Updates the specified job with posted JSONGET /jobs/{job_id}/results
Get a download link for the specified job
Software | Version |
---|---|
flask | 1.1.2 |
requests | 2.25.0 |
flask_cors | 3.0.9 |
xarray | 0.16.1 |
dask | 2.30.0 |
numpy | 1.19.3 |
scipy | 1.6.0 |
netCDF4 | 1.19.3 |