Skip to content

Latest commit

 

History

History
184 lines (101 loc) · 5.41 KB

OperationApi.md

File metadata and controls

184 lines (101 loc) · 5.41 KB

\OperationApi

All URIs are relative to http://localhost:8000/api

Method HTTP request Description
check_operation POST /v1/operations/check Check if an operation to be created is valid
create_operation POST /v1/operations/create Create an operation to be applied as part of a connection pipeline
delete_operation POST /v1/operations/delete Delete an operation
get_operation POST /v1/operations/get Returns an operation
list_operations_for_connection POST /v1/operations/list Returns all operations for a connection.
update_operation POST /v1/operations/update Update an operation

check_operation

crate::models::CheckOperationRead check_operation(operator_configuration) Check if an operation to be created is valid

Parameters

Name Type Description Required Notes
operator_configuration OperatorConfiguration [required]

Return type

crate::models::CheckOperationRead

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_operation

crate::models::OperationRead create_operation(operation_create) Create an operation to be applied as part of a connection pipeline

Parameters

Name Type Description Required Notes
operation_create OperationCreate [required]

Return type

crate::models::OperationRead

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_operation

delete_operation(operation_id_request_body) Delete an operation

Parameters

Name Type Description Required Notes
operation_id_request_body OperationIdRequestBody [required]

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_operation

crate::models::OperationRead get_operation(operation_id_request_body) Returns an operation

Parameters

Name Type Description Required Notes
operation_id_request_body OperationIdRequestBody [required]

Return type

crate::models::OperationRead

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_operations_for_connection

crate::models::OperationReadList list_operations_for_connection(connection_id_request_body) Returns all operations for a connection.

List operations for connection.

Parameters

Name Type Description Required Notes
connection_id_request_body ConnectionIdRequestBody [required]

Return type

crate::models::OperationReadList

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_operation

crate::models::OperationRead update_operation(operation_update) Update an operation

Parameters

Name Type Description Required Notes
operation_update OperationUpdate [required]

Return type

crate::models::OperationRead

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]