Skip to content

Latest commit

 

History

History
241 lines (135 loc) · 7.79 KB

CommandHandlersApi.md

File metadata and controls

241 lines (135 loc) · 7.79 KB

\CommandHandlersApi

All URIs are relative to http://localhost

Method HTTP request Description
command_endpoint_types GET /v1/handlers/commands/endpointTypes Returns a list of all endpoint types for commands
enable_command_handler PATCH /v1/contexts/{context}/handlers/commands/{commandHandlerId} Enables/disables the command handler
get_command_handler GET /v1/contexts/{context}/handlers/commands/{commandHandlerId} Returns the command handler
list_command_handlers GET /v1/contexts/{context}/handlers/commands Returns a list of command handlers
list_command_handlers_all_contexts GET /v1/handlers/commands Returns a list of command handlers of all contexts
register_command_handler POST /v1/contexts/{context}/handlers/commands Registers a new command handler
replace_command_handler PUT /v1/contexts/{context}/handlers/commands/{commandHandlerId} Creates or replaces the command handler
unregister_command_handler DELETE /v1/contexts/{context}/handlers/commands/{commandHandlerId} Unregisters the command handler

command_endpoint_types

Veccrate::models::EndpointType command_endpoint_types() Returns a list of all endpoint types for commands

Parameters

This endpoint does not need any parameter.

Return type

Veccrate::models::EndpointType

Authorization

ApiKeyAuth

HTTP request headers

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

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

enable_command_handler

enable_command_handler(context, command_handler_id, enabled) Enables/disables the command handler

Parameters

Name Type Description Required Notes
context String Context name [required] [default to default]
command_handler_id String Command handler id [required]
enabled bool true to enable the handler, false to disable the handler [required]

Return type

(empty response body)

Authorization

ApiKeyAuth

HTTP request headers

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

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

get_command_handler

crate::models::CommandHandler get_command_handler(context, command_handler_id) Returns the command handler

Parameters

Name Type Description Required Notes
context String Context name [required] [default to default]
command_handler_id String Command handler id [required]

Return type

crate::models::CommandHandler

Authorization

ApiKeyAuth

HTTP request headers

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

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

list_command_handlers

crate::models::ListOfCommandHandlers list_command_handlers(context) Returns a list of command handlers

Parameters

Name Type Description Required Notes
context String Context name [required] [default to default]

Return type

crate::models::ListOfCommandHandlers

Authorization

ApiKeyAuth

HTTP request headers

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

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

list_command_handlers_all_contexts

crate::models::ListOfCommandHandlers list_command_handlers_all_contexts() Returns a list of command handlers of all contexts

Parameters

This endpoint does not need any parameter.

Return type

crate::models::ListOfCommandHandlers

Authorization

ApiKeyAuth

HTTP request headers

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

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

register_command_handler

crate::models::CommandHandler register_command_handler(context, command_handler_registration) Registers a new command handler

Parameters

Name Type Description Required Notes
context String Context name [required] [default to default]
command_handler_registration Option<CommandHandlerRegistration>

Return type

crate::models::CommandHandler

Authorization

ApiKeyAuth

HTTP request headers

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

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

replace_command_handler

crate::models::CommandHandler replace_command_handler(context, command_handler_id, command_handler_registration) Creates or replaces the command handler

Parameters

Name Type Description Required Notes
context String Context name [required] [default to default]
command_handler_id String Command handler id [required]
command_handler_registration Option<CommandHandlerRegistration>

Return type

crate::models::CommandHandler

Authorization

ApiKeyAuth

HTTP request headers

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

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

unregister_command_handler

unregister_command_handler(context, command_handler_id) Unregisters the command handler

Parameters

Name Type Description Required Notes
context String Context name [required] [default to default]
command_handler_id String Command handler id [required]

Return type

(empty response body)

Authorization

ApiKeyAuth

HTTP request headers

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

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