airbyte_client 0.0.1

Airbyte Client is an unofficial client library for the Airbyte API
Documentation

Rust API client for airbyte_client

Airbyte Configuration API https://airbyte.io.

This API is a collection of HTTP RPC-style methods. While it is not a REST API, those familiar with REST should find the conventions of this API recognizable.

Here are some conventions that this API follows:

  • All endpoints are http POST methods.
  • All endpoints accept data via application/json request bodies. The API does not accept any data via query params.
  • The naming convention for endpoints is: localhost:8000/{VERSION}/{METHOD_FAMILY}/{METHOD_NAME} e.g. localhost:8000/v1/connections/create.
  • For all update methods, the whole object must be passed in, even the fields that did not change.

Change Management:

  • The major version of the API endpoint can be determined / specified in the URL localhost:8080/v1/connections/create
  • Minor version bumps will be invisible to the end user. The user cannot specify minor versions in requests.
  • All backwards incompatible changes will happen in major version bumps. We will not make backwards incompatible changes in minor version bumps. Examples of non-breaking changes (includes but not limited to...):
    • Adding fields to request or response bodies.
    • Adding new HTTP endpoints.

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: 0.0.1
  • Build package: org.openapitools.codegen.languages.RustClientCodegen

Installation

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

airbyte_client = { path = "./airbyte_client" }

Documentation for API Endpoints

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

Class Method HTTP request Description
ConnectionApi create_connection POST /v1/connections/create Create a connection between a source and a destination
ConnectionApi delete_connection POST /v1/connections/delete Delete a connection
ConnectionApi get_connection POST /v1/connections/get Get a connection
ConnectionApi get_state POST /v1/state/get Fetch the current state for a connection.
ConnectionApi list_all_connections_for_workspace POST /v1/connections/list_all Returns all connections for a workspace, including deleted connections.
ConnectionApi list_connections_for_workspace POST /v1/connections/list Returns all connections for a workspace.
ConnectionApi reset_connection POST /v1/connections/reset Reset the data for the connection. Deletes data generated by the connection in the destination. Resets any cursors back to initial state.
ConnectionApi search_connections POST /v1/connections/search Search connections
ConnectionApi sync_connection POST /v1/connections/sync Trigger a manual sync of the connection
ConnectionApi update_connection POST /v1/connections/update Update a connection
DbMigrationApi execute_migrations POST /v1/db_migrations/migrate Migrate the database to the latest version
DbMigrationApi list_migrations POST /v1/db_migrations/list List all database migrations
DeploymentApi export_archive POST /v1/deployment/export Export Airbyte Configuration and Data Archive
DeploymentApi export_workspace POST /v1/deployment/export_workspace Export Airbyte Workspace Configuration
DeploymentApi import_archive POST /v1/deployment/import Import Airbyte Configuration and Data Archive
DeploymentApi import_into_workspace POST /v1/deployment/import_into_workspace Import Airbyte Configuration into Workspace (this operation might change ids of imported configurations). Note, in order to use this api endpoint, you might need to upload a temporary archive resource with 'deployment/upload_archive_resource' first
DeploymentApi upload_archive_resource POST /v1/deployment/upload_archive_resource Upload a GZIP archive tarball and stage it in the server's cache as a temporary resource
DestinationApi check_connection_to_destination POST /v1/destinations/check_connection Check connection to the destination
DestinationApi check_connection_to_destination_for_update POST /v1/destinations/check_connection_for_update Check connection for a proposed update to a destination
DestinationApi create_destination POST /v1/destinations/create Create a destination
DestinationApi delete_destination POST /v1/destinations/delete Delete the destination
DestinationApi get_destination POST /v1/destinations/get Get configured destination
DestinationApi list_destinations_for_workspace POST /v1/destinations/list List configured destinations for a workspace
DestinationApi search_destinations POST /v1/destinations/search Search destinations
DestinationApi update_destination POST /v1/destinations/update Update a destination
DestinationDefinitionApi create_destination_definition POST /v1/destination_definitions/create Creates a destinationsDefinition
DestinationDefinitionApi delete_destination_definition POST /v1/destination_definitions/delete Delete a destination definition
DestinationDefinitionApi get_destination_definition POST /v1/destination_definitions/get Get destinationDefinition
DestinationDefinitionApi list_destination_definitions POST /v1/destination_definitions/list List all the destinationDefinitions the current Airbyte deployment is configured to use
DestinationDefinitionApi list_latest_destination_definitions POST /v1/destination_definitions/list_latest List the latest destinationDefinitions Airbyte supports
DestinationDefinitionApi update_destination_definition POST /v1/destination_definitions/update Update destinationDefinition
DestinationDefinitionSpecificationApi get_destination_definition_specification POST /v1/destination_definition_specifications/get Get specification for a destinationDefinition
HealthApi get_health_check GET /v1/health Health Check
JobsApi cancel_job POST /v1/jobs/cancel Cancels a job
JobsApi get_job_info POST /v1/jobs/get Get information about a job
JobsApi list_jobs_for POST /v1/jobs/list Returns recent jobs for a connection. Jobs are returned in descending order by createdAt.
LogsApi get_logs POST /v1/logs/get Get logs
NotificationsApi try_notification_config POST /v1/notifications/try Try sending a notifications
OauthApi complete_destination_o_auth POST /v1/destination_oauths/complete_oauth Given a destination def ID generate an access/refresh token etc.
OauthApi complete_source_o_auth POST /v1/source_oauths/complete_oauth Given a source def ID generate an access/refresh token etc.
OauthApi get_destination_o_auth_consent POST /v1/destination_oauths/get_consent_url Given a destination connector definition ID, return the URL to the consent screen where to redirect the user to.
OauthApi get_source_o_auth_consent POST /v1/source_oauths/get_consent_url Given a source connector definition ID, return the URL to the consent screen where to redirect the user to.
OauthApi set_instancewide_destination_oauth_params POST /v1/destination_oauths/oauth_params/create Sets instancewide variables to be used for the oauth flow when creating this destination. When set, these variables will be injected into a connector's configuration before any interaction with the connector image itself. This enables running oauth flows with consistent variables e.g: the company's Google Ads developer_token, client_id, and client_secret without the user having to know about these variables.
OauthApi set_instancewide_source_oauth_params POST /v1/source_oauths/oauth_params/create Sets instancewide variables to be used for the oauth flow when creating this source. When set, these variables will be injected into a connector's configuration before any interaction with the connector image itself. This enables running oauth flows with consistent variables e.g: the company's Google Ads developer_token, client_id, and client_secret without the user having to know about these variables.
OpenapiApi get_open_api_spec GET /v1/openapi Returns the openapi specification
OperationApi check_operation POST /v1/operations/check Check if an operation to be created is valid
OperationApi create_operation POST /v1/operations/create Create an operation to be applied as part of a connection pipeline
OperationApi delete_operation POST /v1/operations/delete Delete an operation
OperationApi get_operation POST /v1/operations/get Returns an operation
OperationApi list_operations_for_connection POST /v1/operations/list Returns all operations for a connection.
OperationApi update_operation POST /v1/operations/update Update an operation
SchedulerApi execute_destination_check_connection POST /v1/scheduler/destinations/check_connection Run check connection for a given destination configuration
SchedulerApi execute_source_check_connection POST /v1/scheduler/sources/check_connection Run check connection for a given source configuration
SchedulerApi execute_source_discover_schema POST /v1/scheduler/sources/discover_schema Run discover schema for a given source a source configuration
SourceApi check_connection_to_source POST /v1/sources/check_connection Check connection to the source
SourceApi check_connection_to_source_for_update POST /v1/sources/check_connection_for_update Check connection for a proposed update to a source
SourceApi create_source POST /v1/sources/create Create a source
SourceApi delete_source POST /v1/sources/delete Delete a source
SourceApi discover_schema_for_source POST /v1/sources/discover_schema Discover the schema catalog of the source
SourceApi get_source POST /v1/sources/get Get source
SourceApi list_sources_for_workspace POST /v1/sources/list List sources for workspace
SourceApi search_sources POST /v1/sources/search Search sources
SourceApi update_source POST /v1/sources/update Update a source
SourceDefinitionApi create_source_definition POST /v1/source_definitions/create Creates a sourceDefinition
SourceDefinitionApi delete_source_definition POST /v1/source_definitions/delete Delete a source definition
SourceDefinitionApi get_source_definition POST /v1/source_definitions/get Get source
SourceDefinitionApi list_latest_source_definitions POST /v1/source_definitions/list_latest List the latest sourceDefinitions Airbyte supports
SourceDefinitionApi list_source_definitions POST /v1/source_definitions/list List all the sourceDefinitions the current Airbyte deployment is configured to use
SourceDefinitionApi update_source_definition POST /v1/source_definitions/update Update a sourceDefinition
SourceDefinitionSpecificationApi get_source_definition_specification POST /v1/source_definition_specifications/get Get specification for a SourceDefinition.
WebBackendApi web_backend_create_connection POST /v1/web_backend/connections/create Create a connection
WebBackendApi web_backend_get_connection POST /v1/web_backend/connections/get Get a connection
WebBackendApi web_backend_list_all_connections_for_workspace POST /v1/web_backend/connections/list_all Returns all connections for a workspace.
WebBackendApi web_backend_list_connections_for_workspace POST /v1/web_backend/connections/list Returns all non-deleted connections for a workspace.
WebBackendApi web_backend_search_connections POST /v1/web_backend/connections/search Search connections
WebBackendApi web_backend_update_connection POST /v1/web_backend/connections/update Update a connection
WorkspaceApi create_workspace POST /v1/workspaces/create Creates a workspace
WorkspaceApi delete_workspace POST /v1/workspaces/delete Deletes a workspace
WorkspaceApi get_workspace POST /v1/workspaces/get Find workspace by ID
WorkspaceApi get_workspace_by_slug POST /v1/workspaces/get_by_slug Find workspace by slug
WorkspaceApi list_workspaces POST /v1/workspaces/list List all workspaces registered in the current Airbyte deployment
WorkspaceApi update_workspace POST /v1/workspaces/update Update workspace state
WorkspaceApi update_workspace_feedback POST /v1/workspaces/tag_feedback_status_as_done Update workspace feedback state

Documentation For Models

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

cargo doc --open