Table of Contents

openeo_fastapi.api.app

OpenEO Api class for preparing the FastApi object from the client that is provided by the user.

OpenEOApi Objects

@attr.define
class OpenEOApi()

Factory for creating FastApi applications conformant to the OpenEO Api specification.

register_well_known

def register_well_known()

Register well known endpoint (GET /.well-known/openeo).

register_get_capabilities

def register_get_capabilities()

Register endpoint for capabilities (GET /).

register_get_conformance

def register_get_conformance()

Register endpoint for api conformance (GET /conformance).

register_get_credentials_oidc

def register_get_credentials_oidc()

Register endpoint for api conformance (GET /conformance).

register_get_file_formats

def register_get_file_formats()

Register endpoint for supported file formats (GET /file_formats).

register_get_health

def register_get_health()

Register endpoint for api health (GET /health).

register_get_user_info

def register_get_user_info()

Register endpoint for user info (GET /me).

register_get_udf_runtimes

def register_get_udf_runtimes()

Register endpoint to list the supported udf runtimes (GET /udf_runtimes).

register_validate_user_process_graph

def register_validate_user_process_graph()

Register endpoint for validating a user process graph (GET /validation).

register_run_sync_job

def register_run_sync_job()

Register endpoint for executing synchronous jobs (GET /result).

register_get_collections

def register_get_collections()

Register endpoint for listing available collections (GET /collections).

register_get_collection

def register_get_collection()

Register endpoint for getting a specific collection (GET /collections/{collection_id}).

register_get_collection_items

def register_get_collection_items()

Register endpoint for getting collection items (GET /collections/{collection_id}/items).

register_get_collection_item

def register_get_collection_item()

Register endpoint for getting a specific collection item (GET /collections/{collection_id}/items/{item_id}).

register_get_processes

def register_get_processes()

Register endpoint for listing all predefined processes (GET /processes).

register_list_user_process_graphs

def register_list_user_process_graphs()

Register endpoint for listing user defined processes graphs (GET /processes_graphs).

register_get_user_process_graph

def register_get_user_process_graph()

Register endpoint for getting a specific user defined processes graphs (GET /processes_graphs/{process_graph_id}).

register_put_user_process_graph

def register_put_user_process_graph()

Register endpoint for creatings a user defined processes graph (PUT /processes_graphs/{process_graph_id}).

register_delete_user_process_graph

def register_delete_user_process_graph()

Register endpoint for deleting a user defined processes graph (DELETE /processes_graphs/{process_graph_id}).

register_get_jobs

def register_get_jobs()

Register endpoint for listing all jobs (GET /jobs).

register_create_job

def register_create_job()

Register endpoint for creating a new job (POST /jobs).

register_update_job

def register_update_job()

Register update jobs endpoint (POST /jobs/{job_id}).

register_get_job

def register_get_job()

Register endpoint for retreiving job metadata (GET /jobs/{job_id}).

register_delete_job

def register_delete_job()

Register endpoint for deleting the record of a batch job (GET /jobs/{job_id}).

register_get_estimate

def register_get_estimate()

Register endpoint for estimating a batch job (GET /jobs/{job_id}).

register_get_logs

def register_get_logs()

Register endpoint for retrieving job logs (GET /jobs/{job_id}).

register_get_results

def register_get_results()

Register endpoint for getting the results from a batch job (GET /jobs/{job_id}).

register_start_job

def register_start_job()

Register endpoint for starting batch job processing (GET /jobs/{job_id}).

register_cancel_job

def register_cancel_job()

Register endpoint for cancelling job processing (GET /jobs/{job_id}).

register_list_files

def register_list_files()

Register endpoint for listing a user's fils (GET /files).

register_download_file

def register_download_file()

Register endpoint for downloading a specific file (GET /files/{path}).

register_upload_file

def register_upload_file()

Register endpoint for uploading a new file (PUT /files/{path}).

register_delete_file

def register_delete_file()

Register endpoint for deleting a new file (DELETE /files/{path}).

register_core

def register_core()

Add application logic to the API layer.

http_exception_handler

def http_exception_handler(request, exception)

Register exception handler to turn python exceptions into expected OpenEO error output.

__attrs_post_init__

def __attrs_post_init__()

Post-init hook responsible for setting up the application upon instantiation of the class.