Skip to content

Latest commit

 

History

History

synapse-client

Rust API client for openapi

API for Axon Synapse http services

Overview

This API client was generated by the OpenAPI Generator project. By using the openapi-spec from a remote server, you can easily generate an API client.

  • API version: 1.0.0
  • Package version: 1.0.0
  • Build package: org.openapitools.codegen.languages.RustClientCodegen

Installation

Put the package under your project folder in a directory named openapi and add the following to Cargo.toml under [dependencies]:

openapi = { path = "./openapi" }

Documentation for API Endpoints

All URIs are relative to http://localhost

Class Method HTTP request Description
AggregateApi read_aggregate_events GET /v1/contexts/{context}/aggregate/{aggregateId}/events Returns all events for the aggregate
AuthenticationApi create_client_authentication_token POST /v1/authentications/client/tokens Creates the provided client authentication token
AuthenticationApi create_server_authentication_token POST /v1/authentications/server/tokens Creates the provided server authentication token
AuthenticationApi delete_client_authentication_token DELETE /v1/authentications/client/tokens/{authId} Deletes the provided client authentication token
AuthenticationApi delete_server_authentication_token DELETE /v1/authentications/server/tokens/{authId} Deletes the provided server authentication token
AuthenticationApi get_client_authentication_token GET /v1/authentications/client/tokens/{authId} Returns a single client authentication token
AuthenticationApi get_server_authentication_token GET /v1/authentications/server/tokens/{authId} Returns a single server authentication token
AuthenticationApi list_authentication GET /v1/authentications Returns a list of all authentications (client and server) of all types (token, etc.)
AuthenticationApi list_client_authentication_token GET /v1/authentications/client/tokens Returns a list of client authentication tokens
AuthenticationApi list_server_authentication_token GET /v1/authentications/server/tokens Returns a list of server authentication tokens
AuthenticationApi update_client_authentication_token PUT /v1/authentications/client/tokens/{authId} Updates the provided client authentication token
AuthenticationApi update_server_authentication_token PUT /v1/authentications/server/tokens/{authId} Updates the provided server authentication token
CommandHandlersApi command_endpoint_types GET /v1/handlers/commands/endpointTypes Returns a list of all endpoint types for commands
CommandHandlersApi enable_command_handler PATCH /v1/contexts/{context}/handlers/commands/{commandHandlerId} Enables/disables the command handler
CommandHandlersApi get_command_handler GET /v1/contexts/{context}/handlers/commands/{commandHandlerId} Returns the command handler
CommandHandlersApi list_command_handlers GET /v1/contexts/{context}/handlers/commands Returns a list of command handlers
CommandHandlersApi list_command_handlers_all_contexts GET /v1/handlers/commands Returns a list of command handlers of all contexts
CommandHandlersApi register_command_handler POST /v1/contexts/{context}/handlers/commands Registers a new command handler
CommandHandlersApi replace_command_handler PUT /v1/contexts/{context}/handlers/commands/{commandHandlerId} Creates or replaces the command handler
CommandHandlersApi unregister_command_handler DELETE /v1/contexts/{context}/handlers/commands/{commandHandlerId} Unregisters the command handler
CommandsApi send_command POST /v1/contexts/{context}/commands/{commandName} Sends the command
CommandsApi send_command_message POST /v1/contexts/{context}/commands Sends the command message
EventHandlersApi enable_event_handler PATCH /v1/contexts/{context}/handlers/events/{eventHandlerId} Enables/disables the event handler
EventHandlersApi event_endpoint_types GET /v1/handlers/events/endpointTypes Returns a list of all endpoint types for events
EventHandlersApi get_event_handler GET /v1/contexts/{context}/handlers/events/{eventHandlerId} Returns the event handler
EventHandlersApi list_event_handlers GET /v1/contexts/{context}/handlers/events Returns a list of event handlers
EventHandlersApi list_event_handlers_of_all_contexts GET /v1/handlers/events Returns a list of event handlers of all contexts
EventHandlersApi register_event_handler POST /v1/contexts/{context}/handlers/events Registers a new event handler
EventHandlersApi replace_event_handler PUT /v1/contexts/{context}/handlers/events/{eventHandlerId} Created or replaces the event handler
EventHandlersApi unregister_event_handler DELETE /v1/contexts/{context}/handlers/events/{eventHandlerId} Unregisters the event handler
EventsApi publish_event POST /v1/contexts/{context}/events/{eventName} Publishes the event
EventsApi publish_event_message POST /v1/contexts/{context}/events Publishes the event message
QueriesApi query POST /v1/contexts/{context}/queries/{queryName} Issues the query
QueriesApi query_message POST /v1/contexts/{context}/queries Issues the query message
QueryHandlersApi enable_query_handler PATCH /v1/contexts/{context}/handlers/queries/{queryHandlerId} Enables/disables the query handler
QueryHandlersApi get_query_handler GET /v1/contexts/{context}/handlers/queries/{queryHandlerId} Returns the query handler
QueryHandlersApi list_query_handlers GET /v1/contexts/{context}/handlers/queries Returns a list of query handlers
QueryHandlersApi list_query_handlers_all_contexts GET /v1/handlers/queries Returns a list of query handlers of all contexts
QueryHandlersApi query_endpoint_types GET /v1/handlers/queries/endpointTypes Returns a list of all endpoint types for queries
QueryHandlersApi register_query_handler POST /v1/contexts/{context}/handlers/queries Registers a new query handler
QueryHandlersApi replace_query_handler PUT /v1/contexts/{context}/handlers/queries/{queryHandlerId} Creates or replaces the query handler
QueryHandlersApi unregister_query_handler DELETE /v1/contexts/{context}/handlers/queries/{queryHandlerId} Unregisters the query handler

Documentation For Models

To get access to the crate's generated documentation, use:

cargo doc --open

Author