@kananindzya/airbyte_configuration_api

v1.0.0

Published

4 years ago

Airbyte_Configuration_API_https__airbyte_io_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_

0High
0Medium
0Low

kananindzya

airbyte_configuration_api

AirbyteConfigurationApi - JavaScript client for airbyte_configuration_api 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.
All web_backend APIs are not considered public APIs and are not guaranteeing backwards compatibility.

This SDK is automatically generated by the OpenAPI Generator project:

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

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install airbyte_configuration_api --save

Finally, you need to build the module:

npm run build

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

To use the link you just defined in your project, switch to the directory you want to use your airbyte_configuration_api from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

git

If the library is hosted at a git repository, e.g.https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var AirbyteConfigurationApi = require('airbyte_configuration_api');


var api = new AirbyteConfigurationApi.ConnectionApi()
var connectionCreate = new AirbyteConfigurationApi.ConnectionCreate(); // {ConnectionCreate} 
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createConnection(connectionCreate, callback);

Documentation for API Endpoints

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

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- AirbyteConfigurationApi.ConnectionApi | createConnection | POST /v1/connections/create | Create a connection between a source and a destination AirbyteConfigurationApi.ConnectionApi | deleteConnection | POST /v1/connections/delete | Delete a connection AirbyteConfigurationApi.ConnectionApi | getConnection | POST /v1/connections/get | Get a connection AirbyteConfigurationApi.ConnectionApi | getState | POST /v1/state/get | Fetch the current state for a connection. AirbyteConfigurationApi.ConnectionApi | listAllConnectionsForWorkspace | POST /v1/connections/list_all | Returns all connections for a workspace, including deleted connections. AirbyteConfigurationApi.ConnectionApi | listConnectionsForWorkspace | POST /v1/connections/list | Returns all connections for a workspace. AirbyteConfigurationApi.ConnectionApi | resetConnection | 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. AirbyteConfigurationApi.ConnectionApi | searchConnections | POST /v1/connections/search | Search connections AirbyteConfigurationApi.ConnectionApi | syncConnection | POST /v1/connections/sync | Trigger a manual sync of the connection AirbyteConfigurationApi.ConnectionApi | updateConnection | POST /v1/connections/update | Update a connection AirbyteConfigurationApi.DbMigrationApi | executeMigrations | POST /v1/db_migrations/migrate | Migrate the database to the latest version AirbyteConfigurationApi.DbMigrationApi | listMigrations | POST /v1/db_migrations/list | List all database migrations AirbyteConfigurationApi.DeploymentApi | exportArchive | POST /v1/deployment/export | Export Airbyte Configuration and Data Archive AirbyteConfigurationApi.DeploymentApi | exportWorkspace | POST /v1/deployment/export_workspace | Export Airbyte Workspace Configuration AirbyteConfigurationApi.DeploymentApi | importArchive | POST /v1/deployment/import | Import Airbyte Configuration and Data Archive AirbyteConfigurationApi.DeploymentApi | importIntoWorkspace | 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 AirbyteConfigurationApi.DeploymentApi | uploadArchiveResource | POST /v1/deployment/upload_archive_resource | Upload a GZIP archive tarball and stage it in the server's cache as a temporary resource AirbyteConfigurationApi.DestinationApi | checkConnectionToDestination | POST /v1/destinations/check_connection | Check connection to the destination AirbyteConfigurationApi.DestinationApi | checkConnectionToDestinationForUpdate | POST /v1/destinations/check_connection_for_update | Check connection for a proposed update to a destination AirbyteConfigurationApi.DestinationApi | createDestination | POST /v1/destinations/create | Create a destination AirbyteConfigurationApi.DestinationApi | deleteDestination | POST /v1/destinations/delete | Delete the destination AirbyteConfigurationApi.DestinationApi | getDestination | POST /v1/destinations/get | Get configured destination AirbyteConfigurationApi.DestinationApi | listDestinationsForWorkspace | POST /v1/destinations/list | List configured destinations for a workspace AirbyteConfigurationApi.DestinationApi | searchDestinations | POST /v1/destinations/search | Search destinations AirbyteConfigurationApi.DestinationApi | updateDestination | POST /v1/destinations/update | Update a destination AirbyteConfigurationApi.DestinationDefinitionApi | createDestinationDefinition | POST /v1/destination_definitions/create | Creates a destinationsDefinition AirbyteConfigurationApi.DestinationDefinitionApi | deleteDestinationDefinition | POST /v1/destination_definitions/delete | Delete a destination definition AirbyteConfigurationApi.DestinationDefinitionApi | getDestinationDefinition | POST /v1/destination_definitions/get | Get destinationDefinition AirbyteConfigurationApi.DestinationDefinitionApi | listDestinationDefinitions | POST /v1/destination_definitions/list | List all the destinationDefinitions the current Airbyte deployment is configured to use AirbyteConfigurationApi.DestinationDefinitionApi | listLatestDestinationDefinitions | POST /v1/destination_definitions/list_latest | List the latest destinationDefinitions Airbyte supports AirbyteConfigurationApi.DestinationDefinitionApi | updateDestinationDefinition | POST /v1/destination_definitions/update | Update destinationDefinition AirbyteConfigurationApi.DestinationDefinitionSpecificationApi | getDestinationDefinitionSpecification | POST /v1/destination_definition_specifications/get | Get specification for a destinationDefinition AirbyteConfigurationApi.HealthApi | getHealthCheck | GET /v1/health | Health Check AirbyteConfigurationApi.JobsApi | cancelJob | POST /v1/jobs/cancel | Cancels a job AirbyteConfigurationApi.JobsApi | getJobDebugInfo | POST /v1/jobs/get_debug_info | Gets all information needed to debug this job AirbyteConfigurationApi.JobsApi | getJobInfo | POST /v1/jobs/get | Get information about a job AirbyteConfigurationApi.JobsApi | listJobsFor | POST /v1/jobs/list | Returns recent jobs for a connection. Jobs are returned in descending order by createdAt. AirbyteConfigurationApi.LogsApi | getLogs | POST /v1/logs/get | Get logs AirbyteConfigurationApi.NotificationsApi | tryNotificationConfig | POST /v1/notifications/try | Try sending a notifications AirbyteConfigurationApi.OauthApi | completeDestinationOAuth | POST /v1/destination_oauths/complete_oauth | Given a destination def ID generate an access/refresh token etc. AirbyteConfigurationApi.OauthApi | completeSourceOAuth | POST /v1/source_oauths/complete_oauth | Given a source def ID generate an access/refresh token etc. AirbyteConfigurationApi.OauthApi | getDestinationOAuthConsent | 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. AirbyteConfigurationApi.OauthApi | getSourceOAuthConsent | 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. AirbyteConfigurationApi.OauthApi | setInstancewideDestinationOauthParams | 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. AirbyteConfigurationApi.OauthApi | setInstancewideSourceOauthParams | 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. AirbyteConfigurationApi.OpenapiApi | getOpenApiSpec | GET /v1/openapi | Returns the openapi specification AirbyteConfigurationApi.OperationApi | checkOperation | POST /v1/operations/check | Check if an operation to be created is valid AirbyteConfigurationApi.OperationApi | createOperation | POST /v1/operations/create | Create an operation to be applied as part of a connection pipeline AirbyteConfigurationApi.OperationApi | deleteOperation | POST /v1/operations/delete | Delete an operation AirbyteConfigurationApi.OperationApi | getOperation | POST /v1/operations/get | Returns an operation AirbyteConfigurationApi.OperationApi | listOperationsForConnection | POST /v1/operations/list | Returns all operations for a connection. AirbyteConfigurationApi.OperationApi | updateOperation | POST /v1/operations/update | Update an operation AirbyteConfigurationApi.SchedulerApi | executeDestinationCheckConnection | POST /v1/scheduler/destinations/check_connection | Run check connection for a given destination configuration AirbyteConfigurationApi.SchedulerApi | executeSourceCheckConnection | POST /v1/scheduler/sources/check_connection | Run check connection for a given source configuration AirbyteConfigurationApi.SchedulerApi | executeSourceDiscoverSchema | POST /v1/scheduler/sources/discover_schema | Run discover schema for a given source a source configuration AirbyteConfigurationApi.SourceApi | checkConnectionToSource | POST /v1/sources/check_connection | Check connection to the source AirbyteConfigurationApi.SourceApi | checkConnectionToSourceForUpdate | POST /v1/sources/check_connection_for_update | Check connection for a proposed update to a source AirbyteConfigurationApi.SourceApi | createSource | POST /v1/sources/create | Create a source AirbyteConfigurationApi.SourceApi | deleteSource | POST /v1/sources/delete | Delete a source AirbyteConfigurationApi.SourceApi | discoverSchemaForSource | POST /v1/sources/discover_schema | Discover the schema catalog of the source AirbyteConfigurationApi.SourceApi | getSource | POST /v1/sources/get | Get source AirbyteConfigurationApi.SourceApi | listSourcesForWorkspace | POST /v1/sources/list | List sources for workspace AirbyteConfigurationApi.SourceApi | searchSources | POST /v1/sources/search | Search sources AirbyteConfigurationApi.SourceApi | updateSource | POST /v1/sources/update | Update a source AirbyteConfigurationApi.SourceDefinitionApi | createSourceDefinition | POST /v1/source_definitions/create | Creates a sourceDefinition AirbyteConfigurationApi.SourceDefinitionApi | deleteSourceDefinition | POST /v1/source_definitions/delete | Delete a source definition AirbyteConfigurationApi.SourceDefinitionApi | getSourceDefinition | POST /v1/source_definitions/get | Get source AirbyteConfigurationApi.SourceDefinitionApi | listLatestSourceDefinitions | POST /v1/source_definitions/list_latest | List the latest sourceDefinitions Airbyte supports AirbyteConfigurationApi.SourceDefinitionApi | listSourceDefinitions | POST /v1/source_definitions/list | List all the sourceDefinitions the current Airbyte deployment is configured to use AirbyteConfigurationApi.SourceDefinitionApi | updateSourceDefinition | POST /v1/source_definitions/update | Update a sourceDefinition AirbyteConfigurationApi.SourceDefinitionSpecificationApi | getSourceDefinitionSpecification | POST /v1/source_definition_specifications/get | Get specification for a SourceDefinition. AirbyteConfigurationApi.WebBackendApi | webBackendCreateConnection | POST /v1/web_backend/connections/create | Create a connection AirbyteConfigurationApi.WebBackendApi | webBackendGetConnection | POST /v1/web_backend/connections/get | Get a connection AirbyteConfigurationApi.WebBackendApi | webBackendListAllConnectionsForWorkspace | POST /v1/web_backend/connections/list_all | Returns all connections for a workspace. AirbyteConfigurationApi.WebBackendApi | webBackendListConnectionsForWorkspace | POST /v1/web_backend/connections/list | Returns all non-deleted connections for a workspace. AirbyteConfigurationApi.WebBackendApi | webBackendSearchConnections | POST /v1/web_backend/connections/search | Search connections AirbyteConfigurationApi.WebBackendApi | webBackendUpdateConnection | POST /v1/web_backend/connections/update | Update a connection AirbyteConfigurationApi.WorkspaceApi | createWorkspace | POST /v1/workspaces/create | Creates a workspace AirbyteConfigurationApi.WorkspaceApi | deleteWorkspace | POST /v1/workspaces/delete | Deletes a workspace AirbyteConfigurationApi.WorkspaceApi | getWorkspace | POST /v1/workspaces/get | Find workspace by ID AirbyteConfigurationApi.WorkspaceApi | getWorkspaceBySlug | POST /v1/workspaces/get_by_slug | Find workspace by slug AirbyteConfigurationApi.WorkspaceApi | listWorkspaces | POST /v1/workspaces/list | List all workspaces registered in the current Airbyte deployment AirbyteConfigurationApi.WorkspaceApi | updateWorkspace | POST /v1/workspaces/update | Update workspace state AirbyteConfigurationApi.WorkspaceApi | updateWorkspaceFeedback | POST /v1/workspaces/tag_feedback_status_as_done | Update workspace feedback state AirbyteConfigurationApi.WorkspaceApi | updateWorkspaceName | POST /v1/workspaces/update_name | Update workspace name

Documentation for Models

Documentation for Authorization

bearerAuth

Type: Bearer authentication (JWT)