Skip to content

Development Overview

Jump to bottom
Florian Lahn edited this page Oct 21, 2019 · 2 revisions

Implementation overview v0.5.x

Version
R-Client 0.5.x
API 0.4.0 / 0.4.1 / 0.4.2
Backend Endpoint Wrapper Function supported
[GET] / capabilities
    • [GET] /output_formats list_file_types
    • [GET] /service_types list_service_types
    • [GET] /udf_runtimes list_udf_runtimes
    • [GET] /collections list_collections
    • [GET] /collections/{collection_id} describe_collection
    • [GET] /processes list_processes
    • [GET] /process_graphs list_process_graphs
    • [POST] /process_graphs create_process_graph
    • [GET] /process_graphs/{process_graph_id} describe_process_graph
    • [PATCH] /process_graphs/{process_graph_id} update_process_graph
    • [DELETE] /process_graphs/{process_graph_id} delete_process_graph
    • [GET] /files/{user_id} list_files
    • [GET] /files/{user_id}/{path} download_file
    • [PUT] /files/{user_id}/{path} upload_file
    • [DELETE] /files/{user_id}/{path} delete_file
    • [GET] /credentials/basic login
    • [GET] /credentials/oidc login
    • [POST] /result compute_result
    • [GET] /jobs list_jobs
    • [POST] /jobs create_job
    • [PATCH] /jobs/{job_id} update_job
    • [GET] /jobs/{job_id} describe_job
    • [DELETE] /jobs/{job_id} delete_job
    • [GET] /jobs/{job_id}/estimate estimate_job
    • [POST] /jobs/{job_id}/results start_job
    • [DELETE] /jobs/{job_id}/results stop_job
    • [GET] /jobs/{job_id}/results list_results
    • [GET] /subscription follow_job
    • [GET] /services list_services
    • [POST] /services create_service
    • [GET] /services/{service_id} describe_service
    • [PATCH] /services/{service_id} update_service
    • [DELETE] /services/{service_id} delete_service
    • [GET] /me describe_account
    • [POST] /validation validate_process_graph

    • Implementation overview v0.4.1

    Version
    R-Client 0.4.1
    API 0.4.0 / 0.4.1 / 0.4.2
    Backend Endpoint Wrapper Function supported
    [GET] / capabilities
    • [GET] /output_formats list_file_types
    • [GET] /service_types list_service_types
    • [GET] /udf_runtimes list_udf_runtimes
    • [GET] /collections list_collections
    • [GET] /collections/{collection_id} describe_collection
    • [GET] /processes list_processes
    • [GET] /process_graphs list_process_graphs
    • [POST] /process_graphs create_process_graph
    • [GET] /process_graphs/{process_graph_id} describe_process_graph
    • [PATCH] /process_graphs/{process_graph_id} update_process_graph
    • [DELETE] /process_graphs/{process_graph_id} delete_process_graph
    • [GET] /files/{user_id} list_files
    • [GET] /files/{user_id}/{path} download_file
    • [PUT] /files/{user_id}/{path} upload_file
    • [DELETE] /files/{user_id}/{path} delete_file
    • [GET] /credentials/basic login
    • [GET] /credentials/oidc login
    • [POST] /result compute_result
    • [GET] /jobs list_jobs
    • [POST] /jobs create_job
    • [PATCH] /jobs/{job_id} update_job
    • [GET] /jobs/{job_id} describe_job
    • [DELETE] /jobs/{job_id} delete_job
    • [GET] /jobs/{job_id}/estimate estimate_job
    • [POST] /jobs/{job_id}/results start_job
    • [DELETE] /jobs/{job_id}/results stop_job
    • [GET] /jobs/{job_id}/results list_results
    • [GET] /subscription follow_job
    • [GET] /services list_services
    • [POST] /services create_service
    • [GET] /services/{service_id} describe_service
    • [PATCH] /services/{service_id} update_service
    • [DELETE] /services/{service_id} delete_service
    • [GET] /me describe_account
    • [POST] /validation validate_process_graph

    • Implementation overview v0.0.2

    Version
    R-Client 0.2.x
    API 0.0.2
    Backend Endpoint R Client Function Wrapper Function supported
    [GET] /capabilities capabilities listCapabilities
    • [GET] /capabilities/output_formats formats listFormats
    • [GET] /capabilities/services services services
    • [GET] /data listData listCollection
    • [GET] /data/opensearch
    • [GET] /data/{product_id} describeProduct describeCollection
    • [GET] /processes listProcesses listProcesses
    • [GET] /processes/opensearch
    • [GET] /processes/{process_id} describeProcess describeProcess
    • [GET] /udf_runtimes udf_runtimes udfRuntimes
    • [GET] /udf/{lang}/{udf_type} describeUdfType describeUdfType
    • [GET] /users/{user_id}/process_graphs listGraphs listGraphs
    • [POST] /users/{user_id}/process_graphs storeGraph storeGraph
    • [GET] /users/{user_id}/process_graphs/{process_graph_id} describeGraph describeGraph
    • [PUT] /users/{user_id}/process_graphs/{process_graph_id} replaceGraph replaceGraph
    • [DELETE] /users/{user_id}/process_graphs/{process_graph_id} deleteGraph deleteGraph
    • [GET] /users/{user_id}/files listUserFiles listFiles
    • [GET] /users/{user_id}/files/{path} downloadUserFile downloadUserData
    • [PUT] /users/{user_id}/files/{path} uploadUserFile uploadUserData
    • [DELETE] /users/{user_id}/files/{path} deleteUserFile deleteUserData
    • [GET] /users/{user_id}/jobs listJobs listJobs
    • [GET] /users/{user_id}/services listServices listServices
    • [GET] /users/{user_id}/credits getUserCredits credits
    • [GET] /auth/login login connect
    • [POST] /auth/register
    • [POST] /execute execute executeTask
    • [POST] /services createService defineService
    • [POST] /jobs storeJob defineJob
    • [PATCH] /jobs/{job_id} modifyJob modifyJob
    • [GET] /jobs/{jobs_id} describeJob describeJob
    • [GET] /jobs/{job_id}/subscribe followJob
    • [PATCH] /jobs/{job_id}/queue queue queueJob
    • [PATCH] /jobs/{job_id}/pause pause pauseJob
    • [PATCH] /jobs/{job_id}/cancel cancel cancelJob
    • [GET] /jobs/{jobs_id}/download results downloadJob
    • [PATCH] /services/{service_id} modifyService modifyService
    • [GET] /services/{service_id} describeService describeService
    • [DELETE] /services/{service_id} deleteService deleteService

    • There are also some utility functions that encapsulate multiple calls like orderResult and defineUdf

    Clone this wiki locally