@kananindzya/airbyte_configuration_api v1.0.0

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

Documentation for Models

• AirbyteConfigurationApi.AdvancedAuth
• AirbyteConfigurationApi.AirbyteCatalog
• AirbyteConfigurationApi.AirbyteStream
• AirbyteConfigurationApi.AirbyteStreamAndConfiguration
• AirbyteConfigurationApi.AirbyteStreamConfiguration
• AirbyteConfigurationApi.AttemptInfoRead
• AirbyteConfigurationApi.AttemptRead
• AirbyteConfigurationApi.AttemptStats
• AirbyteConfigurationApi.AttemptStatus
• AirbyteConfigurationApi.AttemptStreamStats
• AirbyteConfigurationApi.AuthSpecification
• AirbyteConfigurationApi.CheckConnectionRead
• AirbyteConfigurationApi.CheckOperationRead
• AirbyteConfigurationApi.CompleteDestinationOAuthRequest
• AirbyteConfigurationApi.CompleteSourceOauthRequest
• AirbyteConfigurationApi.ConnectionCreate
• AirbyteConfigurationApi.ConnectionIdRequestBody
• AirbyteConfigurationApi.ConnectionRead
• AirbyteConfigurationApi.ConnectionReadList
• AirbyteConfigurationApi.ConnectionSchedule
• AirbyteConfigurationApi.ConnectionSearch
• AirbyteConfigurationApi.ConnectionState
• AirbyteConfigurationApi.ConnectionStatus
• AirbyteConfigurationApi.ConnectionUpdate
• AirbyteConfigurationApi.DataType
• AirbyteConfigurationApi.DbMigrationExecutionRead
• AirbyteConfigurationApi.DbMigrationRead
• AirbyteConfigurationApi.DbMigrationReadList
• AirbyteConfigurationApi.DbMigrationRequestBody
• AirbyteConfigurationApi.DbMigrationState
• AirbyteConfigurationApi.DestinationCoreConfig
• AirbyteConfigurationApi.DestinationCreate
• AirbyteConfigurationApi.DestinationDefinitionCreate
• AirbyteConfigurationApi.DestinationDefinitionIdRequestBody
• AirbyteConfigurationApi.DestinationDefinitionRead
• AirbyteConfigurationApi.DestinationDefinitionReadList
• AirbyteConfigurationApi.DestinationDefinitionSpecificationRead
• AirbyteConfigurationApi.DestinationDefinitionUpdate
• AirbyteConfigurationApi.DestinationIdRequestBody
• AirbyteConfigurationApi.DestinationOauthConsentRequest
• AirbyteConfigurationApi.DestinationRead
• AirbyteConfigurationApi.DestinationReadList
• AirbyteConfigurationApi.DestinationSearch
• AirbyteConfigurationApi.DestinationSyncMode
• AirbyteConfigurationApi.DestinationUpdate
• AirbyteConfigurationApi.HealthCheckRead
• AirbyteConfigurationApi.ImportRead
• AirbyteConfigurationApi.ImportRequestBody
• AirbyteConfigurationApi.InvalidInputExceptionInfo
• AirbyteConfigurationApi.InvalidInputProperty
• AirbyteConfigurationApi.JobConfigType
• AirbyteConfigurationApi.JobDebugInfoRead
• AirbyteConfigurationApi.JobDebugRead
• AirbyteConfigurationApi.JobIdRequestBody
• AirbyteConfigurationApi.JobInfoRead
• AirbyteConfigurationApi.JobListRequestBody
• AirbyteConfigurationApi.JobRead
• AirbyteConfigurationApi.JobReadList
• AirbyteConfigurationApi.JobStatus
• AirbyteConfigurationApi.JobWithAttemptsRead
• AirbyteConfigurationApi.KnownExceptionInfo
• AirbyteConfigurationApi.LogRead
• AirbyteConfigurationApi.LogType
• AirbyteConfigurationApi.LogsRequestBody
• AirbyteConfigurationApi.NamespaceDefinitionType
• AirbyteConfigurationApi.NotFoundKnownExceptionInfo
• AirbyteConfigurationApi.Notification
• AirbyteConfigurationApi.NotificationRead
• AirbyteConfigurationApi.NotificationType
• AirbyteConfigurationApi.OAuth2Specification
• AirbyteConfigurationApi.OAuthConfigSpecification
• AirbyteConfigurationApi.OAuthConsentRead
• AirbyteConfigurationApi.OperationCreate
• AirbyteConfigurationApi.OperationIdRequestBody
• AirbyteConfigurationApi.OperationRead
• AirbyteConfigurationApi.OperationReadList
• AirbyteConfigurationApi.OperationUpdate
• AirbyteConfigurationApi.OperatorConfiguration
• AirbyteConfigurationApi.OperatorDbt
• AirbyteConfigurationApi.OperatorNormalization
• AirbyteConfigurationApi.OperatorType
• AirbyteConfigurationApi.Pagination
• AirbyteConfigurationApi.ResourceRequirements
• AirbyteConfigurationApi.SetInstancewideDestinationOauthParamsRequestBody
• AirbyteConfigurationApi.SetInstancewideSourceOauthParamsRequestBody
• AirbyteConfigurationApi.SlackNotificationConfiguration
• AirbyteConfigurationApi.SlugRequestBody
• AirbyteConfigurationApi.SourceCoreConfig
• AirbyteConfigurationApi.SourceCreate
• AirbyteConfigurationApi.SourceDefinitionCreate
• AirbyteConfigurationApi.SourceDefinitionIdRequestBody
• AirbyteConfigurationApi.SourceDefinitionRead
• AirbyteConfigurationApi.SourceDefinitionReadList
• AirbyteConfigurationApi.SourceDefinitionSpecificationRead
• AirbyteConfigurationApi.SourceDefinitionUpdate
• AirbyteConfigurationApi.SourceDiscoverSchemaRead
• AirbyteConfigurationApi.SourceIdRequestBody
• AirbyteConfigurationApi.SourceOauthConsentRequest
• AirbyteConfigurationApi.SourceRead
• AirbyteConfigurationApi.SourceReadList
• AirbyteConfigurationApi.SourceSearch
• AirbyteConfigurationApi.SourceUpdate
• AirbyteConfigurationApi.SyncMode
• AirbyteConfigurationApi.SynchronousJobRead
• AirbyteConfigurationApi.UploadRead
• AirbyteConfigurationApi.WebBackendConnectionCreate
• AirbyteConfigurationApi.WebBackendConnectionRead
• AirbyteConfigurationApi.WebBackendConnectionReadList
• AirbyteConfigurationApi.WebBackendConnectionRequestBody
• AirbyteConfigurationApi.WebBackendConnectionSearch
• AirbyteConfigurationApi.WebBackendConnectionUpdate
• AirbyteConfigurationApi.WebBackendOperationCreateOrUpdate
• AirbyteConfigurationApi.WorkspaceCreate
• AirbyteConfigurationApi.WorkspaceGiveFeedback
• AirbyteConfigurationApi.WorkspaceIdRequestBody
• AirbyteConfigurationApi.WorkspaceRead
• AirbyteConfigurationApi.WorkspaceReadList
• AirbyteConfigurationApi.WorkspaceUpdate
• AirbyteConfigurationApi.WorkspaceUpdateName

Documentation for Authorization

bearerAuth

• Type: Bearer authentication (JWT)