diff --git a/airbyte-api/src/main/openapi/config.yaml b/airbyte-api/src/main/openapi/config.yaml index c1cd8f8974b98..b5060b6f38a8e 100644 --- a/airbyte-api/src/main/openapi/config.yaml +++ b/airbyte-api/src/main/openapi/config.yaml @@ -359,6 +359,170 @@ paths: $ref: "#/components/responses/NotFoundResponse" "422": $ref: "#/components/responses/InvalidInputResponse" + /v1/source_definitions/list_private: + post: + tags: + - source_definition + summary: + List all private, non-custom sourceDefinitions, and for each indicate whether the given workspace has a grant for using the definition. Used + by admins to view and modify a given workspace's grants. + operationId: listPrivateSourceDefinitions + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/WorkspaceIdRequestBody" + responses: + "200": + description: Successful operation + content: + application/json: + schema: + $ref: "#/components/schemas/PrivateSourceDefinitionReadList" + /v1/source_definitions/list_for_workspace: + post: + tags: + - source_definition + summary: List all the sourceDefinitions the given workspace is configured to use + operationId: listSourceDefinitionsForWorkspace + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/WorkspaceIdRequestBody" + responses: + "200": + description: Successful operation + content: + application/json: + schema: + $ref: "#/components/schemas/SourceDefinitionReadList" + /v1/source_definitions/create_custom: + post: + tags: + - source_definition + summary: Creates a custom sourceDefinition for the given workspace + operationId: createCustomSourceDefinition + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/CustomSourceDefinitionCreate" + responses: + "200": + description: Successful operation + content: + application/json: + schema: + $ref: "#/components/schemas/SourceDefinitionRead" + "422": + $ref: "#/components/responses/InvalidInputResponse" + /v1/source_definitions/get_for_workspace: + post: + tags: + - source_definition + summary: Get a sourceDefinition that is configured for the given workspace + operationId: getSourceDefinitionForWorkspace + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/SourceDefinitionIdWithWorkspaceId" + required: true + responses: + "200": + description: Successful operation + content: + application/json: + schema: + $ref: "#/components/schemas/SourceDefinitionRead" + "404": + $ref: "#/components/responses/NotFoundResponse" + "422": + $ref: "#/components/responses/InvalidInputResponse" + /v1/source_definitions/update_custom: + post: + tags: + - source_definition + summary: Update a custom sourceDefinition for the given workspace + operationId: updateCustomSourceDefinition + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/CustomSourceDefinitionUpdate" + responses: + "200": + description: Successful operation + content: + application/json: + schema: + $ref: "#/components/schemas/SourceDefinitionRead" + "404": + $ref: "#/components/responses/NotFoundResponse" + "422": + $ref: "#/components/responses/InvalidInputResponse" + /v1/source_definitions/delete_custom: + post: + tags: + - source_definition + summary: Delete a custom source definition for the given workspace + operationId: deleteCustomSourceDefinition + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/SourceDefinitionIdWithWorkspaceId" + required: true + responses: + "204": + description: The resource was deleted successfully. + "404": + $ref: "#/components/responses/NotFoundResponse" + "422": + $ref: "#/components/responses/InvalidInputResponse" + /v1/source_definitions/grant_definition: + post: + tags: + - source_definition + summary: grant a private, non-custom sourceDefinition to a given workspace + operationId: grantSourceDefinitionToWorkspace + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/SourceDefinitionIdWithWorkspaceId" + required: true + responses: + "200": + description: Successful operation + content: + application/json: + schema: + $ref: "#/components/schemas/PrivateSourceDefinitionRead" + "404": + $ref: "#/components/responses/NotFoundResponse" + "422": + $ref: "#/components/responses/InvalidInputResponse" + /v1/source_definitions/revoke_definition: + post: + tags: + - source_definition + summary: revoke a grant to a private, non-custom sourceDefinition from a given workspace + operationId: revokeSourceDefinitionFromWorkspace + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/SourceDefinitionIdWithWorkspaceId" + required: true + responses: + "204": + description: The resource was deleted successfully. + "404": + $ref: "#/components/responses/NotFoundResponse" + "422": + $ref: "#/components/responses/InvalidInputResponse" /v1/source_definition_specifications/get: post: tags: @@ -717,6 +881,170 @@ paths: $ref: "#/components/responses/NotFoundResponse" "422": $ref: "#/components/responses/InvalidInputResponse" + /v1/destination_definitions/list_private: + post: + tags: + - destination_definition + summary: + List all private, non-custom destinationDefinitions, and for each indicate whether the given workspace has a grant for using the + definition. Used by admins to view and modify a given workspace's grants. + operationId: listPrivateDestinationDefinitions + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/WorkspaceIdRequestBody" + responses: + "200": + description: Successful operation + content: + application/json: + schema: + $ref: "#/components/schemas/PrivateDestinationDefinitionReadList" + /v1/destination_definitions/list_for_workspace: + post: + tags: + - destination_definition + summary: List all the destinationDefinitions the given workspace is configured to use + operationId: listDestinationDefinitionsForWorkspace + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/WorkspaceIdRequestBody" + responses: + "200": + description: Successful operation + content: + application/json: + schema: + $ref: "#/components/schemas/DestinationDefinitionReadList" + /v1/destination_definitions/create_custom: + post: + tags: + - destination_definition + summary: Creates a custom destinationDefinition for the given workspace + operationId: createCustomDestinationDefinition + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/CustomDestinationDefinitionCreate" + responses: + "200": + description: Successful operation + content: + application/json: + schema: + $ref: "#/components/schemas/DestinationDefinitionRead" + "422": + $ref: "#/components/responses/InvalidInputResponse" + /v1/destination_definitions/get_for_workspace: + post: + tags: + - destination_definition + summary: Get a destinationDefinition that is configured for the given workspace + operationId: getDestinationDefinitionForWorkspace + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/DestinationDefinitionIdWithWorkspaceId" + required: true + responses: + "200": + description: Successful operation + content: + application/json: + schema: + $ref: "#/components/schemas/DestinationDefinitionRead" + "404": + $ref: "#/components/responses/NotFoundResponse" + "422": + $ref: "#/components/responses/InvalidInputResponse" + /v1/destination_definitions/update_custom: + post: + tags: + - destination_definition + summary: Update a custom destinationDefinition for the given workspace + operationId: updateCustomDestinationDefinition + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/CustomDestinationDefinitionUpdate" + responses: + "200": + description: Successful operation + content: + application/json: + schema: + $ref: "#/components/schemas/DestinationDefinitionRead" + "404": + $ref: "#/components/responses/NotFoundResponse" + "422": + $ref: "#/components/responses/InvalidInputResponse" + /v1/destination_definitions/delete_custom: + post: + tags: + - destination_definition + summary: Delete a custom destination definition for the given workspace + operationId: deleteCustomDestinationDefinition + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/DestinationDefinitionIdWithWorkspaceId" + required: true + responses: + "204": + description: The destination was deleted successfully. + "404": + $ref: "#/components/responses/NotFoundResponse" + "422": + $ref: "#/components/responses/InvalidInputResponse" + /v1/destination_definitions/grant_definition: + post: + tags: + - destination_definition + summary: grant a private, non-custom destinationDefinition to a given workspace + operationId: grantDestinationDefinitionToWorkspace + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/DestinationDefinitionIdWithWorkspaceId" + required: true + responses: + "200": + description: Successful operation + content: + application/json: + schema: + $ref: "#/components/schemas/PrivateDestinationDefinitionRead" + "404": + $ref: "#/components/responses/NotFoundResponse" + "422": + $ref: "#/components/responses/InvalidInputResponse" + /v1/destination_definitions/revoke_definition: + post: + tags: + - destination_definition + summary: revoke a grant to a private, non-custom destinationDefinition from a given workspace + operationId: revokeDestinationDefinitionFromWorkspace + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/DestinationDefinitionIdWithWorkspaceId" + required: true + responses: + "204": + description: The resource was deleted successfully. + "404": + $ref: "#/components/responses/NotFoundResponse" + "422": + $ref: "#/components/responses/InvalidInputResponse" /v1/destination_definition_specifications/get: post: tags: @@ -2177,6 +2505,55 @@ components: type: array items: $ref: "#/components/schemas/SourceDefinitionRead" + CustomSourceDefinitionCreate: + type: object + required: + - workspaceId + - sourceDefinition + properties: + workspaceId: + $ref: "#/components/schemas/WorkspaceId" + sourceDefinition: + $ref: "#/components/schemas/SourceDefinitionCreate" + CustomSourceDefinitionUpdate: + type: object + required: + - workspaceId + - sourceDefinition + properties: + workspaceId: + $ref: "#/components/schemas/WorkspaceId" + sourceDefinition: + $ref: "#/components/schemas/SourceDefinitionUpdate" + SourceDefinitionIdWithWorkspaceId: + type: object + required: + - sourceDefinitionId + - workspaceId + properties: + sourceDefinitionId: + $ref: "#/components/schemas/SourceDefinitionId" + workspaceId: + $ref: "#/components/schemas/WorkspaceId" + PrivateSourceDefinitionRead: + type: object + required: + - sourceDefinition + - granted + properties: + sourceDefinition: + $ref: "#/components/schemas/SourceDefinitionRead" + granted: + type: boolean + PrivateSourceDefinitionReadList: + type: object + required: + - sourceDefinitions + properties: + sourceDefinitions: + type: array + items: + $ref: "#/components/schemas/PrivateSourceDefinitionRead" # SOURCE SPECIFICATION SourceDefinitionSpecification: description: The specification for what values are required to configure the sourceDefinition. @@ -2461,6 +2838,55 @@ components: type: array items: $ref: "#/components/schemas/DestinationDefinitionRead" + CustomDestinationDefinitionCreate: + type: object + required: + - workspaceId + - destinationDefinition + properties: + workspaceId: + $ref: "#/components/schemas/WorkspaceId" + destinationDefinition: + $ref: "#/components/schemas/DestinationDefinitionCreate" + CustomDestinationDefinitionUpdate: + type: object + required: + - workspaceId + - destinationDefinition + properties: + workspaceId: + $ref: "#/components/schemas/WorkspaceId" + destinationDefinition: + $ref: "#/components/schemas/DestinationDefinitionUpdate" + DestinationDefinitionIdWithWorkspaceId: + type: object + required: + - destinationDefinitionId + - workspaceId + properties: + destinationDefinitionId: + $ref: "#/components/schemas/DestinationDefinitionId" + workspaceId: + $ref: "#/components/schemas/WorkspaceId" + PrivateDestinationDefinitionRead: + type: object + required: + - destinationDefinition + - granted + properties: + destinationDefinition: + $ref: "#/components/schemas/DestinationDefinitionRead" + granted: + type: boolean + PrivateDestinationDefinitionReadList: + type: object + required: + - destinationDefinitions + properties: + destinationDefinitions: + type: array + items: + $ref: "#/components/schemas/PrivateDestinationDefinitionRead" # DESTINATION DEFINITION SPECIFICATION DestinationDefinitionSpecification: description: The specification for what values are required to configure the destinationDefinition. diff --git a/airbyte-server/src/main/java/io/airbyte/server/apis/ConfigurationApi.java b/airbyte-server/src/main/java/io/airbyte/server/apis/ConfigurationApi.java index bc757db728e26..f96f51ad4d7df 100644 --- a/airbyte-server/src/main/java/io/airbyte/server/apis/ConfigurationApi.java +++ b/airbyte-server/src/main/java/io/airbyte/server/apis/ConfigurationApi.java @@ -16,6 +16,10 @@ import io.airbyte.api.model.ConnectionSearch; import io.airbyte.api.model.ConnectionState; import io.airbyte.api.model.ConnectionUpdate; +import io.airbyte.api.model.CustomDestinationDefinitionCreate; +import io.airbyte.api.model.CustomDestinationDefinitionUpdate; +import io.airbyte.api.model.CustomSourceDefinitionCreate; +import io.airbyte.api.model.CustomSourceDefinitionUpdate; import io.airbyte.api.model.DbMigrationExecutionRead; import io.airbyte.api.model.DbMigrationReadList; import io.airbyte.api.model.DbMigrationRequestBody; @@ -23,6 +27,7 @@ import io.airbyte.api.model.DestinationCreate; import io.airbyte.api.model.DestinationDefinitionCreate; import io.airbyte.api.model.DestinationDefinitionIdRequestBody; +import io.airbyte.api.model.DestinationDefinitionIdWithWorkspaceId; import io.airbyte.api.model.DestinationDefinitionRead; import io.airbyte.api.model.DestinationDefinitionReadList; import io.airbyte.api.model.DestinationDefinitionSpecificationRead; @@ -51,6 +56,10 @@ import io.airbyte.api.model.OperationReadList; import io.airbyte.api.model.OperationUpdate; import io.airbyte.api.model.OperatorConfiguration; +import io.airbyte.api.model.PrivateDestinationDefinitionRead; +import io.airbyte.api.model.PrivateDestinationDefinitionReadList; +import io.airbyte.api.model.PrivateSourceDefinitionRead; +import io.airbyte.api.model.PrivateSourceDefinitionReadList; import io.airbyte.api.model.SetInstancewideDestinationOauthParamsRequestBody; import io.airbyte.api.model.SetInstancewideSourceOauthParamsRequestBody; import io.airbyte.api.model.SlugRequestBody; @@ -58,6 +67,7 @@ import io.airbyte.api.model.SourceCreate; import io.airbyte.api.model.SourceDefinitionCreate; import io.airbyte.api.model.SourceDefinitionIdRequestBody; +import io.airbyte.api.model.SourceDefinitionIdWithWorkspaceId; import io.airbyte.api.model.SourceDefinitionRead; import io.airbyte.api.model.SourceDefinitionReadList; import io.airbyte.api.model.SourceDefinitionSpecificationRead; @@ -309,26 +319,51 @@ public SourceDefinitionReadList listSourceDefinitions() { return execute(sourceDefinitionsHandler::listSourceDefinitions); } + @Override + public SourceDefinitionReadList listSourceDefinitionsForWorkspace(final WorkspaceIdRequestBody workspaceIdRequestBody) { + return null; + } + @Override public SourceDefinitionReadList listLatestSourceDefinitions() { return execute(sourceDefinitionsHandler::listLatestSourceDefinitions); } + @Override + public PrivateSourceDefinitionReadList listPrivateSourceDefinitions(final WorkspaceIdRequestBody workspaceIdRequestBody) { + return null; + } + @Override public SourceDefinitionRead getSourceDefinition(final SourceDefinitionIdRequestBody sourceDefinitionIdRequestBody) { return execute(() -> sourceDefinitionsHandler.getSourceDefinition(sourceDefinitionIdRequestBody)); } + @Override + public SourceDefinitionRead getSourceDefinitionForWorkspace(final SourceDefinitionIdWithWorkspaceId sourceDefinitionIdWithWorkspaceId) { + return null; + } + @Override public SourceDefinitionRead createSourceDefinition(final SourceDefinitionCreate sourceDefinitionCreate) { return execute(() -> sourceDefinitionsHandler.createCustomSourceDefinition(sourceDefinitionCreate)); } + @Override + public SourceDefinitionRead createCustomSourceDefinition(final CustomSourceDefinitionCreate customSourceDefinitionCreate) { + return null; + } + @Override public SourceDefinitionRead updateSourceDefinition(final SourceDefinitionUpdate sourceDefinitionUpdate) { return execute(() -> sourceDefinitionsHandler.updateSourceDefinition(sourceDefinitionUpdate)); } + @Override + public SourceDefinitionRead updateCustomSourceDefinition(final CustomSourceDefinitionUpdate customSourceDefinitionUpdate) { + return null; + } + @Override public void deleteSourceDefinition(final SourceDefinitionIdRequestBody sourceDefinitionIdRequestBody) { execute(() -> { @@ -337,6 +372,21 @@ public void deleteSourceDefinition(final SourceDefinitionIdRequestBody sourceDef }); } + @Override + public void deleteCustomSourceDefinition(final SourceDefinitionIdWithWorkspaceId sourceDefinitionIdWithWorkspaceId) { + + } + + @Override + public PrivateSourceDefinitionRead grantSourceDefinitionToWorkspace(final SourceDefinitionIdWithWorkspaceId sourceDefinitionIdWithWorkspaceId) { + return null; + } + + @Override + public void revokeSourceDefinitionFromWorkspace(final SourceDefinitionIdWithWorkspaceId sourceDefinitionIdWithWorkspaceId) { + + } + // SOURCE SPECIFICATION @Override @@ -456,26 +506,52 @@ public DestinationDefinitionReadList listDestinationDefinitions() { return execute(destinationDefinitionsHandler::listDestinationDefinitions); } + @Override + public DestinationDefinitionReadList listDestinationDefinitionsForWorkspace(final WorkspaceIdRequestBody workspaceIdRequestBody) { + return null; + } + @Override public DestinationDefinitionReadList listLatestDestinationDefinitions() { return execute(destinationDefinitionsHandler::listLatestDestinationDefinitions); } + @Override + public PrivateDestinationDefinitionReadList listPrivateDestinationDefinitions(final WorkspaceIdRequestBody workspaceIdRequestBody) { + return null; + } + @Override public DestinationDefinitionRead getDestinationDefinition(final DestinationDefinitionIdRequestBody destinationDefinitionIdRequestBody) { return execute(() -> destinationDefinitionsHandler.getDestinationDefinition(destinationDefinitionIdRequestBody)); } + @Override + public DestinationDefinitionRead getDestinationDefinitionForWorkspace( + final DestinationDefinitionIdWithWorkspaceId destinationDefinitionIdWithWorkspaceId) { + return null; + } + @Override public DestinationDefinitionRead createDestinationDefinition(final DestinationDefinitionCreate destinationDefinitionCreate) { return execute(() -> destinationDefinitionsHandler.createCustomDestinationDefinition(destinationDefinitionCreate)); } + @Override + public DestinationDefinitionRead createCustomDestinationDefinition(final CustomDestinationDefinitionCreate customDestinationDefinitionCreate) { + return null; + } + @Override public DestinationDefinitionRead updateDestinationDefinition(final DestinationDefinitionUpdate destinationDefinitionUpdate) { return execute(() -> destinationDefinitionsHandler.updateDestinationDefinition(destinationDefinitionUpdate)); } + @Override + public DestinationDefinitionRead updateCustomDestinationDefinition(final CustomDestinationDefinitionUpdate customDestinationDefinitionUpdate) { + return null; + } + @Override public void deleteDestinationDefinition(final DestinationDefinitionIdRequestBody destinationDefinitionIdRequestBody) { execute(() -> { @@ -484,10 +560,27 @@ public void deleteDestinationDefinition(final DestinationDefinitionIdRequestBody }); } + @Override + public void deleteCustomDestinationDefinition(final DestinationDefinitionIdWithWorkspaceId destinationDefinitionIdWithWorkspaceId) { + + } + + @Override + public PrivateDestinationDefinitionRead grantDestinationDefinitionToWorkspace( + final DestinationDefinitionIdWithWorkspaceId destinationDefinitionIdWithWorkspaceId) { + return null; + } + + @Override + public void revokeDestinationDefinitionFromWorkspace(final DestinationDefinitionIdWithWorkspaceId destinationDefinitionIdWithWorkspaceId) { + + } + // DESTINATION SPECIFICATION @Override - public DestinationDefinitionSpecificationRead getDestinationDefinitionSpecification(final DestinationDefinitionIdRequestBody destinationDefinitionIdRequestBody) { + public DestinationDefinitionSpecificationRead getDestinationDefinitionSpecification( + final DestinationDefinitionIdRequestBody destinationDefinitionIdRequestBody) { return execute(() -> schedulerHandler.getDestinationSpecification(destinationDefinitionIdRequestBody)); } diff --git a/docs/reference/api/generated-api-html/index.html b/docs/reference/api/generated-api-html/index.html index 72b355632265d..84e32e6e0af03 100644 --- a/docs/reference/api/generated-api-html/index.html +++ b/docs/reference/api/generated-api-html/index.html @@ -259,11 +259,19 @@

Destination

DestinationDefinition

DestinationDefinitionSpecification

@@ -332,11 +340,19 @@

Source

SourceDefinition

SourceDefinitionSpecification

@@ -2570,6 +2586,90 @@

422


DestinationDefinition

+
+
+ Up +
post /v1/destination_definitions/create_custom
+
Creates a custom destinationDefinition for the given workspace (createCustomDestinationDefinition)
+
+ + +

Consumes

+ This API call consumes the following media types via the Content-Type request header: + + +

Request body

+
+
CustomDestinationDefinitionCreate CustomDestinationDefinitionCreate (optional)
+ +
Body Parameter
+ +
+ + + + +

Return type

+
+ DestinationDefinitionRead + +
+ + + +

Example data

+
Content-Type: application/json
+
{
+  "resourceRequirements" : {
+    "default" : {
+      "cpu_limit" : "cpu_limit",
+      "memory_request" : "memory_request",
+      "memory_limit" : "memory_limit",
+      "cpu_request" : "cpu_request"
+    },
+    "jobSpecific" : [ {
+      "resourceRequirements" : {
+        "cpu_limit" : "cpu_limit",
+        "memory_request" : "memory_request",
+        "memory_limit" : "memory_limit",
+        "cpu_request" : "cpu_request"
+      }
+    }, {
+      "resourceRequirements" : {
+        "cpu_limit" : "cpu_limit",
+        "memory_request" : "memory_request",
+        "memory_limit" : "memory_limit",
+        "cpu_request" : "cpu_request"
+      }
+    } ]
+  },
+  "documentationUrl" : "https://openapi-generator.tech",
+  "dockerImageTag" : "dockerImageTag",
+  "releaseDate" : "2000-01-23",
+  "dockerRepository" : "dockerRepository",
+  "name" : "name",
+  "icon" : "icon",
+  "destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
+}
+ +

Produces

+ This API call produces the following media types according to the Accept request header; + the media type will be conveyed by the Content-Type response header. + + +

Responses

+

200

+ Successful operation + DestinationDefinitionRead +

422

+ Input failed validation + InvalidInputExceptionInfo +
+
Up @@ -2654,6 +2754,54 @@

422

InvalidInputExceptionInfo

+
+
+ Up +
post /v1/destination_definitions/delete_custom
+
Delete a custom destination definition for the given workspace (deleteCustomDestinationDefinition)
+
+ + +

Consumes

+ This API call consumes the following media types via the Content-Type request header: + + +

Request body

+
+
DestinationDefinitionIdWithWorkspaceId DestinationDefinitionIdWithWorkspaceId (required)
+ +
Body Parameter
+ +
+ + + + + + + + +

Produces

+ This API call produces the following media types according to the Accept request header; + the media type will be conveyed by the Content-Type response header. + + +

Responses

+

204

+ The destination was deleted successfully. + +

404

+ Object with given id was not found. + NotFoundKnownExceptionInfo +

422

+ Input failed validation + InvalidInputExceptionInfo +
+
Up @@ -2789,22 +2937,34 @@

422

InvalidInputExceptionInfo

-
+
Up -
post /v1/destination_definitions/list
-
List all the destinationDefinitions the current Airbyte deployment is configured to use (listDestinationDefinitions)
+
post /v1/destination_definitions/get_for_workspace
+
Get a destinationDefinition that is configured for the given workspace (getDestinationDefinitionForWorkspace)
+

Consumes

+ This API call consumes the following media types via the Content-Type request header: +
    +
  • application/json
  • +
+ +

Request body

+
+
DestinationDefinitionIdWithWorkspaceId DestinationDefinitionIdWithWorkspaceId (required)
+ +
Body Parameter
+

Return type

@@ -2813,69 +2973,36 @@

Return type

Example data

Content-Type: application/json
{
-  "destinationDefinitions" : [ {
-    "resourceRequirements" : {
-      "default" : {
+  "resourceRequirements" : {
+    "default" : {
+      "cpu_limit" : "cpu_limit",
+      "memory_request" : "memory_request",
+      "memory_limit" : "memory_limit",
+      "cpu_request" : "cpu_request"
+    },
+    "jobSpecific" : [ {
+      "resourceRequirements" : {
         "cpu_limit" : "cpu_limit",
         "memory_request" : "memory_request",
         "memory_limit" : "memory_limit",
         "cpu_request" : "cpu_request"
-      },
-      "jobSpecific" : [ {
-        "resourceRequirements" : {
-          "cpu_limit" : "cpu_limit",
-          "memory_request" : "memory_request",
-          "memory_limit" : "memory_limit",
-          "cpu_request" : "cpu_request"
-        }
-      }, {
-        "resourceRequirements" : {
-          "cpu_limit" : "cpu_limit",
-          "memory_request" : "memory_request",
-          "memory_limit" : "memory_limit",
-          "cpu_request" : "cpu_request"
-        }
-      } ]
-    },
-    "documentationUrl" : "https://openapi-generator.tech",
-    "dockerImageTag" : "dockerImageTag",
-    "releaseDate" : "2000-01-23",
-    "dockerRepository" : "dockerRepository",
-    "name" : "name",
-    "icon" : "icon",
-    "destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-  }, {
-    "resourceRequirements" : {
-      "default" : {
+      }
+    }, {
+      "resourceRequirements" : {
         "cpu_limit" : "cpu_limit",
         "memory_request" : "memory_request",
         "memory_limit" : "memory_limit",
         "cpu_request" : "cpu_request"
-      },
-      "jobSpecific" : [ {
-        "resourceRequirements" : {
-          "cpu_limit" : "cpu_limit",
-          "memory_request" : "memory_request",
-          "memory_limit" : "memory_limit",
-          "cpu_request" : "cpu_request"
-        }
-      }, {
-        "resourceRequirements" : {
-          "cpu_limit" : "cpu_limit",
-          "memory_request" : "memory_request",
-          "memory_limit" : "memory_limit",
-          "cpu_request" : "cpu_request"
-        }
-      } ]
-    },
-    "documentationUrl" : "https://openapi-generator.tech",
-    "dockerImageTag" : "dockerImageTag",
-    "releaseDate" : "2000-01-23",
-    "dockerRepository" : "dockerRepository",
-    "name" : "name",
-    "icon" : "icon",
-    "destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-  } ]
+      }
+    } ]
+  },
+  "documentationUrl" : "https://openapi-generator.tech",
+  "dockerImageTag" : "dockerImageTag",
+  "releaseDate" : "2000-01-23",
+  "dockerRepository" : "dockerRepository",
+  "name" : "name",
+  "icon" : "icon",
+  "destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
 }

Produces

@@ -2888,25 +3015,43 @@

Produces

Responses

200

Successful operation - DestinationDefinitionReadList + DestinationDefinitionRead +

404

+ Object with given id was not found. + NotFoundKnownExceptionInfo +

422

+ Input failed validation + InvalidInputExceptionInfo

-
+
Up -
post /v1/destination_definitions/list_latest
-
List the latest destinationDefinitions Airbyte supports (listLatestDestinationDefinitions)
-
Guaranteed to retrieve the latest information on supported destinations.
+
post /v1/destination_definitions/grant_definition
+
grant a private, non-custom destinationDefinition to a given workspace (grantDestinationDefinitionToWorkspace)
+
+ + +

Consumes

+ This API call consumes the following media types via the Content-Type request header: +
    +
  • application/json
  • +
+

Request body

+
+
DestinationDefinitionIdWithWorkspaceId DestinationDefinitionIdWithWorkspaceId (required)
+
Body Parameter
+

Return type

@@ -2915,7 +3060,7 @@

Return type

Example data

Content-Type: application/json
{
-  "destinationDefinitions" : [ {
+  "destinationDefinition" : {
     "resourceRequirements" : {
       "default" : {
         "cpu_limit" : "cpu_limit",
@@ -2946,38 +3091,8 @@ 

Example data

"name" : "name", "icon" : "icon", "destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91" - }, { - "resourceRequirements" : { - "default" : { - "cpu_limit" : "cpu_limit", - "memory_request" : "memory_request", - "memory_limit" : "memory_limit", - "cpu_request" : "cpu_request" - }, - "jobSpecific" : [ { - "resourceRequirements" : { - "cpu_limit" : "cpu_limit", - "memory_request" : "memory_request", - "memory_limit" : "memory_limit", - "cpu_request" : "cpu_request" - } - }, { - "resourceRequirements" : { - "cpu_limit" : "cpu_limit", - "memory_request" : "memory_request", - "memory_limit" : "memory_limit", - "cpu_request" : "cpu_request" - } - } ] - }, - "documentationUrl" : "https://openapi-generator.tech", - "dockerImageTag" : "dockerImageTag", - "releaseDate" : "2000-01-23", - "dockerRepository" : "dockerRepository", - "name" : "name", - "icon" : "icon", - "destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91" - } ] + }, + "granted" : true }

Produces

@@ -2990,37 +3105,31 @@

Produces

Responses

200

Successful operation - DestinationDefinitionReadList + PrivateDestinationDefinitionRead +

404

+ Object with given id was not found. + NotFoundKnownExceptionInfo +

422

+ Input failed validation + InvalidInputExceptionInfo

-
+
Up -
post /v1/destination_definitions/update
-
Update destinationDefinition (updateDestinationDefinition)
+
post /v1/destination_definitions/list
+
List all the destinationDefinitions the current Airbyte deployment is configured to use (listDestinationDefinitions)
-

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
  • -
- -

Request body

-
-
DestinationDefinitionUpdate DestinationDefinitionUpdate (required)
- -
Body Parameter
-

Return type

@@ -3029,36 +3138,69 @@

Return type

Example data

Content-Type: application/json
{
-  "resourceRequirements" : {
-    "default" : {
-      "cpu_limit" : "cpu_limit",
-      "memory_request" : "memory_request",
-      "memory_limit" : "memory_limit",
-      "cpu_request" : "cpu_request"
-    },
-    "jobSpecific" : [ {
-      "resourceRequirements" : {
+  "destinationDefinitions" : [ {
+    "resourceRequirements" : {
+      "default" : {
         "cpu_limit" : "cpu_limit",
         "memory_request" : "memory_request",
         "memory_limit" : "memory_limit",
         "cpu_request" : "cpu_request"
-      }
-    }, {
-      "resourceRequirements" : {
+      },
+      "jobSpecific" : [ {
+        "resourceRequirements" : {
+          "cpu_limit" : "cpu_limit",
+          "memory_request" : "memory_request",
+          "memory_limit" : "memory_limit",
+          "cpu_request" : "cpu_request"
+        }
+      }, {
+        "resourceRequirements" : {
+          "cpu_limit" : "cpu_limit",
+          "memory_request" : "memory_request",
+          "memory_limit" : "memory_limit",
+          "cpu_request" : "cpu_request"
+        }
+      } ]
+    },
+    "documentationUrl" : "https://openapi-generator.tech",
+    "dockerImageTag" : "dockerImageTag",
+    "releaseDate" : "2000-01-23",
+    "dockerRepository" : "dockerRepository",
+    "name" : "name",
+    "icon" : "icon",
+    "destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
+  }, {
+    "resourceRequirements" : {
+      "default" : {
         "cpu_limit" : "cpu_limit",
         "memory_request" : "memory_request",
         "memory_limit" : "memory_limit",
         "cpu_request" : "cpu_request"
-      }
-    } ]
-  },
-  "documentationUrl" : "https://openapi-generator.tech",
-  "dockerImageTag" : "dockerImageTag",
-  "releaseDate" : "2000-01-23",
-  "dockerRepository" : "dockerRepository",
-  "name" : "name",
-  "icon" : "icon",
-  "destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
+      },
+      "jobSpecific" : [ {
+        "resourceRequirements" : {
+          "cpu_limit" : "cpu_limit",
+          "memory_request" : "memory_request",
+          "memory_limit" : "memory_limit",
+          "cpu_request" : "cpu_request"
+        }
+      }, {
+        "resourceRequirements" : {
+          "cpu_limit" : "cpu_limit",
+          "memory_request" : "memory_request",
+          "memory_limit" : "memory_limit",
+          "cpu_request" : "cpu_request"
+        }
+      } ]
+    },
+    "documentationUrl" : "https://openapi-generator.tech",
+    "dockerImageTag" : "dockerImageTag",
+    "releaseDate" : "2000-01-23",
+    "dockerRepository" : "dockerRepository",
+    "name" : "name",
+    "icon" : "icon",
+    "destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
+  } ]
 }

Produces

@@ -3071,21 +3213,14 @@

Produces

Responses

200

Successful operation - DestinationDefinitionRead -

404

- Object with given id was not found. - NotFoundKnownExceptionInfo -

422

- Input failed validation - InvalidInputExceptionInfo + DestinationDefinitionReadList

-

DestinationDefinitionSpecification

-
+
Up -
post /v1/destination_definition_specifications/get
-
Get specification for a destinationDefinition (getDestinationDefinitionSpecification)
+
post /v1/destination_definitions/list_for_workspace
+
List all the destinationDefinitions the given workspace is configured to use (listDestinationDefinitionsForWorkspace)
@@ -3097,7 +3232,7 @@

Consumes

Request body

-
DestinationDefinitionIdRequestBody DestinationDefinitionIdRequestBody (required)
+
WorkspaceIdRequestBody WorkspaceIdRequestBody (optional)
Body Parameter
@@ -3108,7 +3243,7 @@

Request body

Return type

@@ -3117,40 +3252,69 @@

Return type

Example data

Content-Type: application/json
{
-  "documentationUrl" : "documentationUrl",
-  "supportsNormalization" : true,
-  "connectionSpecification" : {
-    "user" : {
-      "type" : "string"
-    }
-  },
-  "supportedDestinationSyncModes" : [ null, null ],
-  "supportsDbt" : true,
-  "destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-  "advancedAuth" : {
-    "predicateValue" : "predicateValue",
-    "oauthConfigSpecification" : { },
-    "predicateKey" : [ "predicateKey", "predicateKey" ],
-    "authFlowType" : "oauth2.0"
-  },
-  "authSpecification" : {
-    "auth_type" : "oauth2.0",
-    "oauth2Specification" : {
-      "oauthFlowOutputParameters" : [ [ "oauthFlowOutputParameters", "oauthFlowOutputParameters" ], [ "oauthFlowOutputParameters", "oauthFlowOutputParameters" ] ],
-      "rootObject" : [ "path", 1 ],
-      "oauthFlowInitParameters" : [ [ "oauthFlowInitParameters", "oauthFlowInitParameters" ], [ "oauthFlowInitParameters", "oauthFlowInitParameters" ] ]
-    }
-  },
-  "jobInfo" : {
-    "createdAt" : 0,
-    "configId" : "configId",
-    "endedAt" : 6,
-    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "logs" : {
-      "logLines" : [ "logLines", "logLines" ]
+  "destinationDefinitions" : [ {
+    "resourceRequirements" : {
+      "default" : {
+        "cpu_limit" : "cpu_limit",
+        "memory_request" : "memory_request",
+        "memory_limit" : "memory_limit",
+        "cpu_request" : "cpu_request"
+      },
+      "jobSpecific" : [ {
+        "resourceRequirements" : {
+          "cpu_limit" : "cpu_limit",
+          "memory_request" : "memory_request",
+          "memory_limit" : "memory_limit",
+          "cpu_request" : "cpu_request"
+        }
+      }, {
+        "resourceRequirements" : {
+          "cpu_limit" : "cpu_limit",
+          "memory_request" : "memory_request",
+          "memory_limit" : "memory_limit",
+          "cpu_request" : "cpu_request"
+        }
+      } ]
     },
-    "succeeded" : true
-  }
+    "documentationUrl" : "https://openapi-generator.tech",
+    "dockerImageTag" : "dockerImageTag",
+    "releaseDate" : "2000-01-23",
+    "dockerRepository" : "dockerRepository",
+    "name" : "name",
+    "icon" : "icon",
+    "destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
+  }, {
+    "resourceRequirements" : {
+      "default" : {
+        "cpu_limit" : "cpu_limit",
+        "memory_request" : "memory_request",
+        "memory_limit" : "memory_limit",
+        "cpu_request" : "cpu_request"
+      },
+      "jobSpecific" : [ {
+        "resourceRequirements" : {
+          "cpu_limit" : "cpu_limit",
+          "memory_request" : "memory_request",
+          "memory_limit" : "memory_limit",
+          "cpu_request" : "cpu_request"
+        }
+      }, {
+        "resourceRequirements" : {
+          "cpu_limit" : "cpu_limit",
+          "memory_request" : "memory_request",
+          "memory_limit" : "memory_limit",
+          "cpu_request" : "cpu_request"
+        }
+      } ]
+    },
+    "documentationUrl" : "https://openapi-generator.tech",
+    "dockerImageTag" : "dockerImageTag",
+    "releaseDate" : "2000-01-23",
+    "dockerRepository" : "dockerRepository",
+    "name" : "name",
+    "icon" : "icon",
+    "destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
+  } ]
 }

Produces

@@ -3163,22 +3327,15 @@

Produces

Responses

200

Successful operation - DestinationDefinitionSpecificationRead -

404

- Object with given id was not found. - NotFoundKnownExceptionInfo -

422

- Input failed validation - InvalidInputExceptionInfo + DestinationDefinitionReadList

-

Health

-
+
Up -
get /v1/health
-
Health Check (getHealthCheck)
-
+
post /v1/destination_definitions/list_latest
+
List the latest destinationDefinitions Airbyte supports (listLatestDestinationDefinitions)
+
Guaranteed to retrieve the latest information on supported destinations.
@@ -3188,7 +3345,7 @@

Health

Return type

@@ -3197,163 +3354,68 @@

Return type

Example data

Content-Type: application/json
{
-  "available" : true
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
  • -
- -

Responses

-

200

- Successful operation - HealthCheckRead -
-
-

Jobs

-
-
- Up -
post /v1/jobs/cancel
-
Cancels a job (cancelJob)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
  • -
- -

Request body

-
-
JobIdRequestBody JobIdRequestBody (required)
- -
Body Parameter
- -
- - - - -

Return type

-
- JobInfoRead - -
- - - -

Example data

-
Content-Type: application/json
-
{
-  "job" : {
-    "createdAt" : 6,
-    "configId" : "configId",
-    "id" : 0,
-    "updatedAt" : 1
-  },
-  "attempts" : [ {
-    "attempt" : {
-      "totalStats" : {
-        "stateMessagesEmitted" : 7,
-        "recordsCommitted" : 1,
-        "bytesEmitted" : 4,
-        "recordsEmitted" : 2
-      },
-      "failureSummary" : {
-        "failures" : [ {
-          "retryable" : true,
-          "stacktrace" : "stacktrace",
-          "externalMessage" : "externalMessage",
-          "timestamp" : 1
-        }, {
-          "retryable" : true,
-          "stacktrace" : "stacktrace",
-          "externalMessage" : "externalMessage",
-          "timestamp" : 1
-        } ],
-        "partialSuccess" : true
+  "destinationDefinitions" : [ {
+    "resourceRequirements" : {
+      "default" : {
+        "cpu_limit" : "cpu_limit",
+        "memory_request" : "memory_request",
+        "memory_limit" : "memory_limit",
+        "cpu_request" : "cpu_request"
       },
-      "createdAt" : 5,
-      "bytesSynced" : 9,
-      "endedAt" : 7,
-      "streamStats" : [ {
-        "stats" : {
-          "stateMessagesEmitted" : 7,
-          "recordsCommitted" : 1,
-          "bytesEmitted" : 4,
-          "recordsEmitted" : 2
-        },
-        "streamName" : "streamName"
+      "jobSpecific" : [ {
+        "resourceRequirements" : {
+          "cpu_limit" : "cpu_limit",
+          "memory_request" : "memory_request",
+          "memory_limit" : "memory_limit",
+          "cpu_request" : "cpu_request"
+        }
       }, {
-        "stats" : {
-          "stateMessagesEmitted" : 7,
-          "recordsCommitted" : 1,
-          "bytesEmitted" : 4,
-          "recordsEmitted" : 2
-        },
-        "streamName" : "streamName"
-      } ],
-      "id" : 5,
-      "recordsSynced" : 3,
-      "updatedAt" : 2
+        "resourceRequirements" : {
+          "cpu_limit" : "cpu_limit",
+          "memory_request" : "memory_request",
+          "memory_limit" : "memory_limit",
+          "cpu_request" : "cpu_request"
+        }
+      } ]
     },
-    "logs" : {
-      "logLines" : [ "logLines", "logLines" ]
-    }
+    "documentationUrl" : "https://openapi-generator.tech",
+    "dockerImageTag" : "dockerImageTag",
+    "releaseDate" : "2000-01-23",
+    "dockerRepository" : "dockerRepository",
+    "name" : "name",
+    "icon" : "icon",
+    "destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
   }, {
-    "attempt" : {
-      "totalStats" : {
-        "stateMessagesEmitted" : 7,
-        "recordsCommitted" : 1,
-        "bytesEmitted" : 4,
-        "recordsEmitted" : 2
-      },
-      "failureSummary" : {
-        "failures" : [ {
-          "retryable" : true,
-          "stacktrace" : "stacktrace",
-          "externalMessage" : "externalMessage",
-          "timestamp" : 1
-        }, {
-          "retryable" : true,
-          "stacktrace" : "stacktrace",
-          "externalMessage" : "externalMessage",
-          "timestamp" : 1
-        } ],
-        "partialSuccess" : true
+    "resourceRequirements" : {
+      "default" : {
+        "cpu_limit" : "cpu_limit",
+        "memory_request" : "memory_request",
+        "memory_limit" : "memory_limit",
+        "cpu_request" : "cpu_request"
       },
-      "createdAt" : 5,
-      "bytesSynced" : 9,
-      "endedAt" : 7,
-      "streamStats" : [ {
-        "stats" : {
-          "stateMessagesEmitted" : 7,
-          "recordsCommitted" : 1,
-          "bytesEmitted" : 4,
-          "recordsEmitted" : 2
-        },
-        "streamName" : "streamName"
+      "jobSpecific" : [ {
+        "resourceRequirements" : {
+          "cpu_limit" : "cpu_limit",
+          "memory_request" : "memory_request",
+          "memory_limit" : "memory_limit",
+          "cpu_request" : "cpu_request"
+        }
       }, {
-        "stats" : {
-          "stateMessagesEmitted" : 7,
-          "recordsCommitted" : 1,
-          "bytesEmitted" : 4,
-          "recordsEmitted" : 2
-        },
-        "streamName" : "streamName"
-      } ],
-      "id" : 5,
-      "recordsSynced" : 3,
-      "updatedAt" : 2
+        "resourceRequirements" : {
+          "cpu_limit" : "cpu_limit",
+          "memory_request" : "memory_request",
+          "memory_limit" : "memory_limit",
+          "cpu_request" : "cpu_request"
+        }
+      } ]
     },
-    "logs" : {
-      "logLines" : [ "logLines", "logLines" ]
-    }
+    "documentationUrl" : "https://openapi-generator.tech",
+    "dockerImageTag" : "dockerImageTag",
+    "releaseDate" : "2000-01-23",
+    "dockerRepository" : "dockerRepository",
+    "name" : "name",
+    "icon" : "icon",
+    "destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
   } ]
 }
@@ -3367,20 +3429,14 @@

Produces

Responses

200

Successful operation - JobInfoRead -

404

- Object with given id was not found. - NotFoundKnownExceptionInfo -

422

- Input failed validation - InvalidInputExceptionInfo + DestinationDefinitionReadList

-
+
Up -
post /v1/jobs/get_debug_info
-
Gets all information needed to debug this job (getJobDebugInfo)
+
post /v1/destination_definitions/list_private
+
List all private, non-custom destinationDefinitions, and for each indicate whether the given workspace has a grant for using the definition. Used by admins to view and modify a given workspace's grants. (listPrivateDestinationDefinitions)
@@ -3392,7 +3448,7 @@

Consumes

Request body

-
JobIdRequestBody JobIdRequestBody (required)
+
WorkspaceIdRequestBody WorkspaceIdRequestBody (optional)
Body Parameter
@@ -3403,7 +3459,7 @@

Request body

Return type

@@ -3412,9 +3468,8 @@

Return type

Example data

Content-Type: application/json
{
-  "job" : {
-    "configId" : "configId",
-    "sourceDefinition" : {
+  "destinationDefinitions" : [ {
+    "destinationDefinition" : {
       "resourceRequirements" : {
         "default" : {
           "cpu_limit" : "cpu_limit",
@@ -3444,10 +3499,10 @@ 

Example data

"dockerRepository" : "dockerRepository", "name" : "name", "icon" : "icon", - "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91" + "destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91" }, - "airbyteVersion" : "airbyteVersion", - "id" : 0, + "granted" : true + }, { "destinationDefinition" : { "resourceRequirements" : { "default" : { @@ -3479,106 +3534,8 @@

Example data

"name" : "name", "icon" : "icon", "destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91" - } - }, - "attempts" : [ { - "attempt" : { - "totalStats" : { - "stateMessagesEmitted" : 7, - "recordsCommitted" : 1, - "bytesEmitted" : 4, - "recordsEmitted" : 2 - }, - "failureSummary" : { - "failures" : [ { - "retryable" : true, - "stacktrace" : "stacktrace", - "externalMessage" : "externalMessage", - "timestamp" : 1 - }, { - "retryable" : true, - "stacktrace" : "stacktrace", - "externalMessage" : "externalMessage", - "timestamp" : 1 - } ], - "partialSuccess" : true - }, - "createdAt" : 5, - "bytesSynced" : 9, - "endedAt" : 7, - "streamStats" : [ { - "stats" : { - "stateMessagesEmitted" : 7, - "recordsCommitted" : 1, - "bytesEmitted" : 4, - "recordsEmitted" : 2 - }, - "streamName" : "streamName" - }, { - "stats" : { - "stateMessagesEmitted" : 7, - "recordsCommitted" : 1, - "bytesEmitted" : 4, - "recordsEmitted" : 2 - }, - "streamName" : "streamName" - } ], - "id" : 5, - "recordsSynced" : 3, - "updatedAt" : 2 - }, - "logs" : { - "logLines" : [ "logLines", "logLines" ] - } - }, { - "attempt" : { - "totalStats" : { - "stateMessagesEmitted" : 7, - "recordsCommitted" : 1, - "bytesEmitted" : 4, - "recordsEmitted" : 2 - }, - "failureSummary" : { - "failures" : [ { - "retryable" : true, - "stacktrace" : "stacktrace", - "externalMessage" : "externalMessage", - "timestamp" : 1 - }, { - "retryable" : true, - "stacktrace" : "stacktrace", - "externalMessage" : "externalMessage", - "timestamp" : 1 - } ], - "partialSuccess" : true - }, - "createdAt" : 5, - "bytesSynced" : 9, - "endedAt" : 7, - "streamStats" : [ { - "stats" : { - "stateMessagesEmitted" : 7, - "recordsCommitted" : 1, - "bytesEmitted" : 4, - "recordsEmitted" : 2 - }, - "streamName" : "streamName" - }, { - "stats" : { - "stateMessagesEmitted" : 7, - "recordsCommitted" : 1, - "bytesEmitted" : 4, - "recordsEmitted" : 2 - }, - "streamName" : "streamName" - } ], - "id" : 5, - "recordsSynced" : 3, - "updatedAt" : 2 }, - "logs" : { - "logLines" : [ "logLines", "logLines" ] - } + "granted" : true } ] }
@@ -3592,7 +3549,49 @@

Produces

Responses

200

Successful operation - JobDebugInfoRead + PrivateDestinationDefinitionReadList +
+
+
+
+ Up +
post /v1/destination_definitions/revoke_definition
+
revoke a grant to a private, non-custom destinationDefinition from a given workspace (revokeDestinationDefinitionFromWorkspace)
+
+ + +

Consumes

+ This API call consumes the following media types via the Content-Type request header: +
    +
  • application/json
  • +
+ +

Request body

+
+
DestinationDefinitionIdWithWorkspaceId DestinationDefinitionIdWithWorkspaceId (required)
+ +
Body Parameter
+ +
+ + + + + + + + +

Produces

+ This API call produces the following media types according to the Accept request header; + the media type will be conveyed by the Content-Type response header. +
    +
  • application/json
  • +
+ +

Responses

+

204

+ The resource was deleted successfully. +

404

Object with given id was not found. NotFoundKnownExceptionInfo @@ -3601,11 +3600,11 @@

422

InvalidInputExceptionInfo

-
+
Up -
post /v1/jobs/get
-
Get information about a job (getJobInfo)
+
post /v1/destination_definitions/update_custom
+
Update a custom destinationDefinition for the given workspace (updateCustomDestinationDefinition)
@@ -3617,7 +3616,7 @@

Consumes

Request body

-
JobIdRequestBody JobIdRequestBody (required)
+
CustomDestinationDefinitionUpdate CustomDestinationDefinitionUpdate (optional)
Body Parameter
@@ -3628,7 +3627,7 @@

Request body

Return type

@@ -3637,111 +3636,36 @@

Return type

Example data

Content-Type: application/json
{
-  "job" : {
-    "createdAt" : 6,
-    "configId" : "configId",
-    "id" : 0,
-    "updatedAt" : 1
-  },
-  "attempts" : [ {
-    "attempt" : {
-      "totalStats" : {
-        "stateMessagesEmitted" : 7,
-        "recordsCommitted" : 1,
-        "bytesEmitted" : 4,
-        "recordsEmitted" : 2
-      },
-      "failureSummary" : {
-        "failures" : [ {
-          "retryable" : true,
-          "stacktrace" : "stacktrace",
-          "externalMessage" : "externalMessage",
-          "timestamp" : 1
-        }, {
-          "retryable" : true,
-          "stacktrace" : "stacktrace",
-          "externalMessage" : "externalMessage",
-          "timestamp" : 1
-        } ],
-        "partialSuccess" : true
-      },
-      "createdAt" : 5,
-      "bytesSynced" : 9,
-      "endedAt" : 7,
-      "streamStats" : [ {
-        "stats" : {
-          "stateMessagesEmitted" : 7,
-          "recordsCommitted" : 1,
-          "bytesEmitted" : 4,
-          "recordsEmitted" : 2
-        },
-        "streamName" : "streamName"
-      }, {
-        "stats" : {
-          "stateMessagesEmitted" : 7,
-          "recordsCommitted" : 1,
-          "bytesEmitted" : 4,
-          "recordsEmitted" : 2
-        },
-        "streamName" : "streamName"
-      } ],
-      "id" : 5,
-      "recordsSynced" : 3,
-      "updatedAt" : 2
-    },
-    "logs" : {
-      "logLines" : [ "logLines", "logLines" ]
-    }
-  }, {
-    "attempt" : {
-      "totalStats" : {
-        "stateMessagesEmitted" : 7,
-        "recordsCommitted" : 1,
-        "bytesEmitted" : 4,
-        "recordsEmitted" : 2
-      },
-      "failureSummary" : {
-        "failures" : [ {
-          "retryable" : true,
-          "stacktrace" : "stacktrace",
-          "externalMessage" : "externalMessage",
-          "timestamp" : 1
-        }, {
-          "retryable" : true,
-          "stacktrace" : "stacktrace",
-          "externalMessage" : "externalMessage",
-          "timestamp" : 1
-        } ],
-        "partialSuccess" : true
-      },
-      "createdAt" : 5,
-      "bytesSynced" : 9,
-      "endedAt" : 7,
-      "streamStats" : [ {
-        "stats" : {
-          "stateMessagesEmitted" : 7,
-          "recordsCommitted" : 1,
-          "bytesEmitted" : 4,
-          "recordsEmitted" : 2
-        },
-        "streamName" : "streamName"
-      }, {
-        "stats" : {
-          "stateMessagesEmitted" : 7,
-          "recordsCommitted" : 1,
-          "bytesEmitted" : 4,
-          "recordsEmitted" : 2
-        },
-        "streamName" : "streamName"
-      } ],
-      "id" : 5,
-      "recordsSynced" : 3,
-      "updatedAt" : 2
+  "resourceRequirements" : {
+    "default" : {
+      "cpu_limit" : "cpu_limit",
+      "memory_request" : "memory_request",
+      "memory_limit" : "memory_limit",
+      "cpu_request" : "cpu_request"
     },
-    "logs" : {
-      "logLines" : [ "logLines", "logLines" ]
-    }
-  } ]
+    "jobSpecific" : [ {
+      "resourceRequirements" : {
+        "cpu_limit" : "cpu_limit",
+        "memory_request" : "memory_request",
+        "memory_limit" : "memory_limit",
+        "cpu_request" : "cpu_request"
+      }
+    }, {
+      "resourceRequirements" : {
+        "cpu_limit" : "cpu_limit",
+        "memory_request" : "memory_request",
+        "memory_limit" : "memory_limit",
+        "cpu_request" : "cpu_request"
+      }
+    } ]
+  },
+  "documentationUrl" : "https://openapi-generator.tech",
+  "dockerImageTag" : "dockerImageTag",
+  "releaseDate" : "2000-01-23",
+  "dockerRepository" : "dockerRepository",
+  "name" : "name",
+  "icon" : "icon",
+  "destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
 }

Produces

@@ -3754,7 +3678,7 @@

Produces

Responses

200

Successful operation - JobInfoRead + DestinationDefinitionRead

404

Object with given id was not found. NotFoundKnownExceptionInfo @@ -3763,11 +3687,11 @@

422

InvalidInputExceptionInfo

-
+
Up -
post /v1/jobs/list
-
Returns recent jobs for a connection. Jobs are returned in descending order by createdAt. (listJobsFor)
+
post /v1/destination_definitions/update
+
Update destinationDefinition (updateDestinationDefinition)
@@ -3779,7 +3703,7 @@

Consumes

Request body

-
JobListRequestBody JobListRequestBody (required)
+
DestinationDefinitionUpdate DestinationDefinitionUpdate (required)
Body Parameter
@@ -3790,7 +3714,7 @@

Request body

Return type

@@ -3799,14 +3723,235 @@

Return type

Example data

Content-Type: application/json
{
-  "jobs" : [ {
-    "job" : {
-      "createdAt" : 6,
-      "configId" : "configId",
-      "id" : 0,
-      "updatedAt" : 1
+  "resourceRequirements" : {
+    "default" : {
+      "cpu_limit" : "cpu_limit",
+      "memory_request" : "memory_request",
+      "memory_limit" : "memory_limit",
+      "cpu_request" : "cpu_request"
     },
-    "attempts" : [ {
+    "jobSpecific" : [ {
+      "resourceRequirements" : {
+        "cpu_limit" : "cpu_limit",
+        "memory_request" : "memory_request",
+        "memory_limit" : "memory_limit",
+        "cpu_request" : "cpu_request"
+      }
+    }, {
+      "resourceRequirements" : {
+        "cpu_limit" : "cpu_limit",
+        "memory_request" : "memory_request",
+        "memory_limit" : "memory_limit",
+        "cpu_request" : "cpu_request"
+      }
+    } ]
+  },
+  "documentationUrl" : "https://openapi-generator.tech",
+  "dockerImageTag" : "dockerImageTag",
+  "releaseDate" : "2000-01-23",
+  "dockerRepository" : "dockerRepository",
+  "name" : "name",
+  "icon" : "icon",
+  "destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
+}
+ +

Produces

+ This API call produces the following media types according to the Accept request header; + the media type will be conveyed by the Content-Type response header. +
    +
  • application/json
  • +
+ +

Responses

+

200

+ Successful operation + DestinationDefinitionRead +

404

+ Object with given id was not found. + NotFoundKnownExceptionInfo +

422

+ Input failed validation + InvalidInputExceptionInfo +
+
+

DestinationDefinitionSpecification

+
+
+ Up +
post /v1/destination_definition_specifications/get
+
Get specification for a destinationDefinition (getDestinationDefinitionSpecification)
+
+ + +

Consumes

+ This API call consumes the following media types via the Content-Type request header: +
    +
  • application/json
  • +
+ +

Request body

+
+
DestinationDefinitionIdRequestBody DestinationDefinitionIdRequestBody (required)
+ +
Body Parameter
+ +
+ + + + +

Return type

+ + + + +

Example data

+
Content-Type: application/json
+
{
+  "documentationUrl" : "documentationUrl",
+  "supportsNormalization" : true,
+  "connectionSpecification" : {
+    "user" : {
+      "type" : "string"
+    }
+  },
+  "supportedDestinationSyncModes" : [ null, null ],
+  "supportsDbt" : true,
+  "destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
+  "advancedAuth" : {
+    "predicateValue" : "predicateValue",
+    "oauthConfigSpecification" : { },
+    "predicateKey" : [ "predicateKey", "predicateKey" ],
+    "authFlowType" : "oauth2.0"
+  },
+  "authSpecification" : {
+    "auth_type" : "oauth2.0",
+    "oauth2Specification" : {
+      "oauthFlowOutputParameters" : [ [ "oauthFlowOutputParameters", "oauthFlowOutputParameters" ], [ "oauthFlowOutputParameters", "oauthFlowOutputParameters" ] ],
+      "rootObject" : [ "path", 1 ],
+      "oauthFlowInitParameters" : [ [ "oauthFlowInitParameters", "oauthFlowInitParameters" ], [ "oauthFlowInitParameters", "oauthFlowInitParameters" ] ]
+    }
+  },
+  "jobInfo" : {
+    "createdAt" : 0,
+    "configId" : "configId",
+    "endedAt" : 6,
+    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
+    "logs" : {
+      "logLines" : [ "logLines", "logLines" ]
+    },
+    "succeeded" : true
+  }
+}
+ +

Produces

+ This API call produces the following media types according to the Accept request header; + the media type will be conveyed by the Content-Type response header. +
    +
  • application/json
  • +
+ +

Responses

+

200

+ Successful operation + DestinationDefinitionSpecificationRead +

404

+ Object with given id was not found. + NotFoundKnownExceptionInfo +

422

+ Input failed validation + InvalidInputExceptionInfo +
+
+

Health

+
+
+ Up +
get /v1/health
+
Health Check (getHealthCheck)
+
+ + + + + + + +

Return type

+ + + + +

Example data

+
Content-Type: application/json
+
{
+  "available" : true
+}
+ +

Produces

+ This API call produces the following media types according to the Accept request header; + the media type will be conveyed by the Content-Type response header. +
    +
  • application/json
  • +
+ +

Responses

+

200

+ Successful operation + HealthCheckRead +
+
+

Jobs

+
+
+ Up +
post /v1/jobs/cancel
+
Cancels a job (cancelJob)
+
+ + +

Consumes

+ This API call consumes the following media types via the Content-Type request header: +
    +
  • application/json
  • +
+ +

Request body

+
+
JobIdRequestBody JobIdRequestBody (required)
+ +
Body Parameter
+ +
+ + + + +

Return type

+
+ JobInfoRead + +
+ + + +

Example data

+
Content-Type: application/json
+
{
+  "job" : {
+    "createdAt" : 6,
+    "configId" : "configId",
+    "id" : 0,
+    "updatedAt" : 1
+  },
+  "attempts" : [ {
+    "attempt" : {
       "totalStats" : {
         "stateMessagesEmitted" : 7,
         "recordsCommitted" : 1,
@@ -3850,7 +3995,12 @@ 

Example data

"id" : 5, "recordsSynced" : 3, "updatedAt" : 2 - }, { + }, + "logs" : { + "logLines" : [ "logLines", "logLines" ] + } + }, { + "attempt" : { "totalStats" : { "stateMessagesEmitted" : 7, "recordsCommitted" : 1, @@ -3894,20 +4044,144 @@

Example data

"id" : 5, "recordsSynced" : 3, "updatedAt" : 2 - } ] - }, { - "job" : { - "createdAt" : 6, - "configId" : "configId", - "id" : 0, - "updatedAt" : 1 }, - "attempts" : [ { - "totalStats" : { - "stateMessagesEmitted" : 7, - "recordsCommitted" : 1, - "bytesEmitted" : 4, - "recordsEmitted" : 2 + "logs" : { + "logLines" : [ "logLines", "logLines" ] + } + } ] +}
+ +

Produces

+ This API call produces the following media types according to the Accept request header; + the media type will be conveyed by the Content-Type response header. +
    +
  • application/json
  • +
+ +

Responses

+

200

+ Successful operation + JobInfoRead +

404

+ Object with given id was not found. + NotFoundKnownExceptionInfo +

422

+ Input failed validation + InvalidInputExceptionInfo +
+
+
+
+ Up +
post /v1/jobs/get_debug_info
+
Gets all information needed to debug this job (getJobDebugInfo)
+
+ + +

Consumes

+ This API call consumes the following media types via the Content-Type request header: +
    +
  • application/json
  • +
+ +

Request body

+
+
JobIdRequestBody JobIdRequestBody (required)
+ +
Body Parameter
+ +
+ + + + +

Return type

+ + + + +

Example data

+
Content-Type: application/json
+
{
+  "job" : {
+    "configId" : "configId",
+    "sourceDefinition" : {
+      "resourceRequirements" : {
+        "default" : {
+          "cpu_limit" : "cpu_limit",
+          "memory_request" : "memory_request",
+          "memory_limit" : "memory_limit",
+          "cpu_request" : "cpu_request"
+        },
+        "jobSpecific" : [ {
+          "resourceRequirements" : {
+            "cpu_limit" : "cpu_limit",
+            "memory_request" : "memory_request",
+            "memory_limit" : "memory_limit",
+            "cpu_request" : "cpu_request"
+          }
+        }, {
+          "resourceRequirements" : {
+            "cpu_limit" : "cpu_limit",
+            "memory_request" : "memory_request",
+            "memory_limit" : "memory_limit",
+            "cpu_request" : "cpu_request"
+          }
+        } ]
+      },
+      "documentationUrl" : "https://openapi-generator.tech",
+      "dockerImageTag" : "dockerImageTag",
+      "releaseDate" : "2000-01-23",
+      "dockerRepository" : "dockerRepository",
+      "name" : "name",
+      "icon" : "icon",
+      "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
+    },
+    "airbyteVersion" : "airbyteVersion",
+    "id" : 0,
+    "destinationDefinition" : {
+      "resourceRequirements" : {
+        "default" : {
+          "cpu_limit" : "cpu_limit",
+          "memory_request" : "memory_request",
+          "memory_limit" : "memory_limit",
+          "cpu_request" : "cpu_request"
+        },
+        "jobSpecific" : [ {
+          "resourceRequirements" : {
+            "cpu_limit" : "cpu_limit",
+            "memory_request" : "memory_request",
+            "memory_limit" : "memory_limit",
+            "cpu_request" : "cpu_request"
+          }
+        }, {
+          "resourceRequirements" : {
+            "cpu_limit" : "cpu_limit",
+            "memory_request" : "memory_request",
+            "memory_limit" : "memory_limit",
+            "cpu_request" : "cpu_request"
+          }
+        } ]
+      },
+      "documentationUrl" : "https://openapi-generator.tech",
+      "dockerImageTag" : "dockerImageTag",
+      "releaseDate" : "2000-01-23",
+      "dockerRepository" : "dockerRepository",
+      "name" : "name",
+      "icon" : "icon",
+      "destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
+    }
+  },
+  "attempts" : [ {
+    "attempt" : {
+      "totalStats" : {
+        "stateMessagesEmitted" : 7,
+        "recordsCommitted" : 1,
+        "bytesEmitted" : 4,
+        "recordsEmitted" : 2
       },
       "failureSummary" : {
         "failures" : [ {
@@ -3946,7 +4220,12 @@ 

Example data

"id" : 5, "recordsSynced" : 3, "updatedAt" : 2 - }, { + }, + "logs" : { + "logLines" : [ "logLines", "logLines" ] + } + }, { + "attempt" : { "totalStats" : { "stateMessagesEmitted" : 7, "recordsCommitted" : 1, @@ -3990,7 +4269,10 @@

Example data

"id" : 5, "recordsSynced" : 3, "updatedAt" : 2 - } ] + }, + "logs" : { + "logLines" : [ "logLines", "logLines" ] + } } ] }
@@ -4004,7 +4286,7 @@

Produces

Responses

200

Successful operation - JobReadList + JobDebugInfoRead

404

Object with given id was not found. NotFoundKnownExceptionInfo @@ -4013,12 +4295,11 @@

422

InvalidInputExceptionInfo

-

Logs

-
+
Up -
post /v1/logs/get
-
Get logs (getLogs)
+
post /v1/jobs/get
+
Get information about a job (getJobInfo)
@@ -4030,7 +4311,7 @@

Consumes

Request body

-
LogsRequestBody LogsRequestBody (required)
+
JobIdRequestBody JobIdRequestBody (required)
Body Parameter
@@ -4041,99 +4322,867 @@

Request body

Return type

+ JobInfoRead - File
+

Example data

+
Content-Type: application/json
+
{
+  "job" : {
+    "createdAt" : 6,
+    "configId" : "configId",
+    "id" : 0,
+    "updatedAt" : 1
+  },
+  "attempts" : [ {
+    "attempt" : {
+      "totalStats" : {
+        "stateMessagesEmitted" : 7,
+        "recordsCommitted" : 1,
+        "bytesEmitted" : 4,
+        "recordsEmitted" : 2
+      },
+      "failureSummary" : {
+        "failures" : [ {
+          "retryable" : true,
+          "stacktrace" : "stacktrace",
+          "externalMessage" : "externalMessage",
+          "timestamp" : 1
+        }, {
+          "retryable" : true,
+          "stacktrace" : "stacktrace",
+          "externalMessage" : "externalMessage",
+          "timestamp" : 1
+        } ],
+        "partialSuccess" : true
+      },
+      "createdAt" : 5,
+      "bytesSynced" : 9,
+      "endedAt" : 7,
+      "streamStats" : [ {
+        "stats" : {
+          "stateMessagesEmitted" : 7,
+          "recordsCommitted" : 1,
+          "bytesEmitted" : 4,
+          "recordsEmitted" : 2
+        },
+        "streamName" : "streamName"
+      }, {
+        "stats" : {
+          "stateMessagesEmitted" : 7,
+          "recordsCommitted" : 1,
+          "bytesEmitted" : 4,
+          "recordsEmitted" : 2
+        },
+        "streamName" : "streamName"
+      } ],
+      "id" : 5,
+      "recordsSynced" : 3,
+      "updatedAt" : 2
+    },
+    "logs" : {
+      "logLines" : [ "logLines", "logLines" ]
+    }
+  }, {
+    "attempt" : {
+      "totalStats" : {
+        "stateMessagesEmitted" : 7,
+        "recordsCommitted" : 1,
+        "bytesEmitted" : 4,
+        "recordsEmitted" : 2
+      },
+      "failureSummary" : {
+        "failures" : [ {
+          "retryable" : true,
+          "stacktrace" : "stacktrace",
+          "externalMessage" : "externalMessage",
+          "timestamp" : 1
+        }, {
+          "retryable" : true,
+          "stacktrace" : "stacktrace",
+          "externalMessage" : "externalMessage",
+          "timestamp" : 1
+        } ],
+        "partialSuccess" : true
+      },
+      "createdAt" : 5,
+      "bytesSynced" : 9,
+      "endedAt" : 7,
+      "streamStats" : [ {
+        "stats" : {
+          "stateMessagesEmitted" : 7,
+          "recordsCommitted" : 1,
+          "bytesEmitted" : 4,
+          "recordsEmitted" : 2
+        },
+        "streamName" : "streamName"
+      }, {
+        "stats" : {
+          "stateMessagesEmitted" : 7,
+          "recordsCommitted" : 1,
+          "bytesEmitted" : 4,
+          "recordsEmitted" : 2
+        },
+        "streamName" : "streamName"
+      } ],
+      "id" : 5,
+      "recordsSynced" : 3,
+      "updatedAt" : 2
+    },
+    "logs" : {
+      "logLines" : [ "logLines", "logLines" ]
+    }
+  } ]
+}
+ +

Produces

+ This API call produces the following media types according to the Accept request header; + the media type will be conveyed by the Content-Type response header. +
    +
  • application/json
  • +
+ +

Responses

+

200

+ Successful operation + JobInfoRead +

404

+ Object with given id was not found. + NotFoundKnownExceptionInfo +

422

+ Input failed validation + InvalidInputExceptionInfo +
+
+
+
+ Up +
post /v1/jobs/list
+
Returns recent jobs for a connection. Jobs are returned in descending order by createdAt. (listJobsFor)
+
+ + +

Consumes

+ This API call consumes the following media types via the Content-Type request header: +
    +
  • application/json
  • +
+ +

Request body

+
+
JobListRequestBody JobListRequestBody (required)
+ +
Body Parameter
+ +
+ + + + +

Return type

+
+ JobReadList + +
+ + + +

Example data

+
Content-Type: application/json
+
{
+  "jobs" : [ {
+    "job" : {
+      "createdAt" : 6,
+      "configId" : "configId",
+      "id" : 0,
+      "updatedAt" : 1
+    },
+    "attempts" : [ {
+      "totalStats" : {
+        "stateMessagesEmitted" : 7,
+        "recordsCommitted" : 1,
+        "bytesEmitted" : 4,
+        "recordsEmitted" : 2
+      },
+      "failureSummary" : {
+        "failures" : [ {
+          "retryable" : true,
+          "stacktrace" : "stacktrace",
+          "externalMessage" : "externalMessage",
+          "timestamp" : 1
+        }, {
+          "retryable" : true,
+          "stacktrace" : "stacktrace",
+          "externalMessage" : "externalMessage",
+          "timestamp" : 1
+        } ],
+        "partialSuccess" : true
+      },
+      "createdAt" : 5,
+      "bytesSynced" : 9,
+      "endedAt" : 7,
+      "streamStats" : [ {
+        "stats" : {
+          "stateMessagesEmitted" : 7,
+          "recordsCommitted" : 1,
+          "bytesEmitted" : 4,
+          "recordsEmitted" : 2
+        },
+        "streamName" : "streamName"
+      }, {
+        "stats" : {
+          "stateMessagesEmitted" : 7,
+          "recordsCommitted" : 1,
+          "bytesEmitted" : 4,
+          "recordsEmitted" : 2
+        },
+        "streamName" : "streamName"
+      } ],
+      "id" : 5,
+      "recordsSynced" : 3,
+      "updatedAt" : 2
+    }, {
+      "totalStats" : {
+        "stateMessagesEmitted" : 7,
+        "recordsCommitted" : 1,
+        "bytesEmitted" : 4,
+        "recordsEmitted" : 2
+      },
+      "failureSummary" : {
+        "failures" : [ {
+          "retryable" : true,
+          "stacktrace" : "stacktrace",
+          "externalMessage" : "externalMessage",
+          "timestamp" : 1
+        }, {
+          "retryable" : true,
+          "stacktrace" : "stacktrace",
+          "externalMessage" : "externalMessage",
+          "timestamp" : 1
+        } ],
+        "partialSuccess" : true
+      },
+      "createdAt" : 5,
+      "bytesSynced" : 9,
+      "endedAt" : 7,
+      "streamStats" : [ {
+        "stats" : {
+          "stateMessagesEmitted" : 7,
+          "recordsCommitted" : 1,
+          "bytesEmitted" : 4,
+          "recordsEmitted" : 2
+        },
+        "streamName" : "streamName"
+      }, {
+        "stats" : {
+          "stateMessagesEmitted" : 7,
+          "recordsCommitted" : 1,
+          "bytesEmitted" : 4,
+          "recordsEmitted" : 2
+        },
+        "streamName" : "streamName"
+      } ],
+      "id" : 5,
+      "recordsSynced" : 3,
+      "updatedAt" : 2
+    } ]
+  }, {
+    "job" : {
+      "createdAt" : 6,
+      "configId" : "configId",
+      "id" : 0,
+      "updatedAt" : 1
+    },
+    "attempts" : [ {
+      "totalStats" : {
+        "stateMessagesEmitted" : 7,
+        "recordsCommitted" : 1,
+        "bytesEmitted" : 4,
+        "recordsEmitted" : 2
+      },
+      "failureSummary" : {
+        "failures" : [ {
+          "retryable" : true,
+          "stacktrace" : "stacktrace",
+          "externalMessage" : "externalMessage",
+          "timestamp" : 1
+        }, {
+          "retryable" : true,
+          "stacktrace" : "stacktrace",
+          "externalMessage" : "externalMessage",
+          "timestamp" : 1
+        } ],
+        "partialSuccess" : true
+      },
+      "createdAt" : 5,
+      "bytesSynced" : 9,
+      "endedAt" : 7,
+      "streamStats" : [ {
+        "stats" : {
+          "stateMessagesEmitted" : 7,
+          "recordsCommitted" : 1,
+          "bytesEmitted" : 4,
+          "recordsEmitted" : 2
+        },
+        "streamName" : "streamName"
+      }, {
+        "stats" : {
+          "stateMessagesEmitted" : 7,
+          "recordsCommitted" : 1,
+          "bytesEmitted" : 4,
+          "recordsEmitted" : 2
+        },
+        "streamName" : "streamName"
+      } ],
+      "id" : 5,
+      "recordsSynced" : 3,
+      "updatedAt" : 2
+    }, {
+      "totalStats" : {
+        "stateMessagesEmitted" : 7,
+        "recordsCommitted" : 1,
+        "bytesEmitted" : 4,
+        "recordsEmitted" : 2
+      },
+      "failureSummary" : {
+        "failures" : [ {
+          "retryable" : true,
+          "stacktrace" : "stacktrace",
+          "externalMessage" : "externalMessage",
+          "timestamp" : 1
+        }, {
+          "retryable" : true,
+          "stacktrace" : "stacktrace",
+          "externalMessage" : "externalMessage",
+          "timestamp" : 1
+        } ],
+        "partialSuccess" : true
+      },
+      "createdAt" : 5,
+      "bytesSynced" : 9,
+      "endedAt" : 7,
+      "streamStats" : [ {
+        "stats" : {
+          "stateMessagesEmitted" : 7,
+          "recordsCommitted" : 1,
+          "bytesEmitted" : 4,
+          "recordsEmitted" : 2
+        },
+        "streamName" : "streamName"
+      }, {
+        "stats" : {
+          "stateMessagesEmitted" : 7,
+          "recordsCommitted" : 1,
+          "bytesEmitted" : 4,
+          "recordsEmitted" : 2
+        },
+        "streamName" : "streamName"
+      } ],
+      "id" : 5,
+      "recordsSynced" : 3,
+      "updatedAt" : 2
+    } ]
+  } ]
+}
+ +

Produces

+ This API call produces the following media types according to the Accept request header; + the media type will be conveyed by the Content-Type response header. +
    +
  • application/json
  • +
+ +

Responses

+

200

+ Successful operation + JobReadList +

404

+ Object with given id was not found. + NotFoundKnownExceptionInfo +

422

+ Input failed validation + InvalidInputExceptionInfo +
+
+

Logs

+
+
+ Up +
post /v1/logs/get
+
Get logs (getLogs)
+
+ + +

Consumes

+ This API call consumes the following media types via the Content-Type request header: +
    +
  • application/json
  • +
+ +

Request body

+
+
LogsRequestBody LogsRequestBody (required)
+ +
Body Parameter
+ +
+ + + + +

Return type

+
+ + File +
+ + + + +

Produces

+ This API call produces the following media types according to the Accept request header; + the media type will be conveyed by the Content-Type response header. +
    +
  • text/plain
  • +
  • application/json
  • +
+ +

Responses

+

200

+ Returns the log file + File +

404

+ Object with given id was not found. + NotFoundKnownExceptionInfo +

422

+ Input failed validation + InvalidInputExceptionInfo +
+
+

Notifications

+
+
+ Up +
post /v1/notifications/try
+
Try sending a notifications (tryNotificationConfig)
+
+ + +

Consumes

+ This API call consumes the following media types via the Content-Type request header: +
    +
  • application/json
  • +
+ +

Request body

+
+
Notification Notification (required)
+ +
Body Parameter
+ +
+ + + + +

Return type

+ + + + +

Example data

+
Content-Type: application/json
+
{
+  "message" : "message",
+  "status" : "succeeded"
+}
+ +

Produces

+ This API call produces the following media types according to the Accept request header; + the media type will be conveyed by the Content-Type response header. +
    +
  • application/json
  • +
+ +

Responses

+

200

+ Successful operation + NotificationRead +

404

+ Object with given id was not found. + NotFoundKnownExceptionInfo +

422

+ Input failed validation + InvalidInputExceptionInfo +
+
+

Oauth

+
+
+ Up +
post /v1/destination_oauths/complete_oauth
+
Given a destination def ID generate an access/refresh token etc. (completeDestinationOAuth)
+
+ + +

Consumes

+ This API call consumes the following media types via the Content-Type request header: +
    +
  • application/json
  • +
+ +

Request body

+
+
CompleteDestinationOAuthRequest CompleteDestinationOAuthRequest (required)
+ +
Body Parameter
+ +
+ + + + +

Return type

+
+ + map[String, Object] +
+ + + + +

Produces

+ This API call produces the following media types according to the Accept request header; + the media type will be conveyed by the Content-Type response header. +
    +
  • application/json
  • +
+ +

Responses

+

200

+ Successful operation + map[String, Object] +

404

+ Object with given id was not found. + NotFoundKnownExceptionInfo +

422

+ Input failed validation + InvalidInputExceptionInfo +
+
+
+
+ Up +
post /v1/source_oauths/complete_oauth
+
Given a source def ID generate an access/refresh token etc. (completeSourceOAuth)
+
+ + +

Consumes

+ This API call consumes the following media types via the Content-Type request header: +
    +
  • application/json
  • +
+ +

Request body

+
+
CompleteSourceOauthRequest CompleteSourceOauthRequest (required)
+ +
Body Parameter
+ +
+ + + + +

Return type

+
+ + map[String, Object] +
+ + + + +

Produces

+ This API call produces the following media types according to the Accept request header; + the media type will be conveyed by the Content-Type response header. +
    +
  • application/json
  • +
+ +

Responses

+

200

+ Successful operation + map[String, Object] +

404

+ Object with given id was not found. + NotFoundKnownExceptionInfo +

422

+ Input failed validation + InvalidInputExceptionInfo +
+
+
+
+ Up +
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. (getDestinationOAuthConsent)
+
+ + +

Consumes

+ This API call consumes the following media types via the Content-Type request header: +
    +
  • application/json
  • +
+ +

Request body

+
+
DestinationOauthConsentRequest DestinationOauthConsentRequest (required)
+ +
Body Parameter
+ +
+ + + + +

Return type

+ + + + +

Example data

+
Content-Type: application/json
+
{
+  "consentUrl" : "consentUrl"
+}
+ +

Produces

+ This API call produces the following media types according to the Accept request header; + the media type will be conveyed by the Content-Type response header. +
    +
  • application/json
  • +
+ +

Responses

+

200

+ Successful operation + OAuthConsentRead +

404

+ Object with given id was not found. + NotFoundKnownExceptionInfo +

422

+ Input failed validation + InvalidInputExceptionInfo +
+
+
+
+ Up +
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. (getSourceOAuthConsent)
+
+ + +

Consumes

+ This API call consumes the following media types via the Content-Type request header: +
    +
  • application/json
  • +
+ +

Request body

+
+
SourceOauthConsentRequest SourceOauthConsentRequest (required)
+ +
Body Parameter
+ +
+ + + + +

Return type

+ + + + +

Example data

+
Content-Type: application/json
+
{
+  "consentUrl" : "consentUrl"
+}
+ +

Produces

+ This API call produces the following media types according to the Accept request header; + the media type will be conveyed by the Content-Type response header. +
    +
  • application/json
  • +
+ +

Responses

+

200

+ Successful operation + OAuthConsentRead +

404

+ Object with given id was not found. + NotFoundKnownExceptionInfo +

422

+ Input failed validation + InvalidInputExceptionInfo +
+
+
+
+ Up +
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. (setInstancewideDestinationOauthParams)
+
+ + +

Consumes

+ This API call consumes the following media types via the Content-Type request header: +
    +
  • application/json
  • +
+ +

Request body

+
+
SetInstancewideDestinationOauthParamsRequestBody SetInstancewideDestinationOauthParamsRequestBody (required)
+ +
Body Parameter
+ +
+ + + + + + + + +

Produces

+ This API call produces the following media types according to the Accept request header; + the media type will be conveyed by the Content-Type response header. +
    +
  • application/json
  • +
+ +

Responses

+

200

+ Successful + +

400

+ Exception occurred; see message for details. + KnownExceptionInfo +

404

+ Object with given id was not found. + NotFoundKnownExceptionInfo +
+
+
+
+ Up +
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. (setInstancewideSourceOauthParams)
+
+ + +

Consumes

+ This API call consumes the following media types via the Content-Type request header: +
    +
  • application/json
  • +
+ +

Request body

+
+
SetInstancewideSourceOauthParamsRequestBody SetInstancewideSourceOauthParamsRequestBody (required)
+ +
Body Parameter
+ +
+ + + + + + + + +

Produces

+ This API call produces the following media types according to the Accept request header; + the media type will be conveyed by the Content-Type response header. +
    +
  • application/json
  • +
+ +

Responses

+

200

+ Successful + +

400

+ Exception occurred; see message for details. + KnownExceptionInfo +

404

+ Object with given id was not found. + NotFoundKnownExceptionInfo +
+
+

Openapi

+
+
+ Up +
get /v1/openapi
+
Returns the openapi specification (getOpenApiSpec)
+
-

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • text/plain
  • -
  • application/json
  • -
- -

Responses

-

200

- Returns the log file - File -

404

- Object with given id was not found. - NotFoundKnownExceptionInfo -

422

- Input failed validation - InvalidInputExceptionInfo -
-
-

Notifications

-
-
- Up -
post /v1/notifications/try
-
Try sending a notifications (tryNotificationConfig)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
  • -
- -

Request body

-
-
Notification Notification (required)
-
Body Parameter
-

Return type

- NotificationRead + File
-

Example data

-
Content-Type: application/json
-
{
-  "message" : "message",
-  "status" : "succeeded"
-}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    -
  • application/json
  • +
  • text/plain

Responses

200

- Successful operation - NotificationRead -

404

- Object with given id was not found. - NotFoundKnownExceptionInfo -

422

- Input failed validation - InvalidInputExceptionInfo + Returns the openapi specification file + File

-

Oauth

-
+

Operation

+
Up -
post /v1/destination_oauths/complete_oauth
-
Given a destination def ID generate an access/refresh token etc. (completeDestinationOAuth)
+
post /v1/operations/check
+
Check if an operation to be created is valid (checkOperation)
@@ -4145,7 +5194,7 @@

Consumes

Request body

-
CompleteDestinationOAuthRequest CompleteDestinationOAuthRequest (required)
+
OperatorConfiguration OperatorConfiguration (required)
Body Parameter
@@ -4156,12 +5205,18 @@

Request body

Return type

+ CheckOperationRead - map[String, Object]
+

Example data

+
Content-Type: application/json
+
{
+  "message" : "message",
+  "status" : "succeeded"
+}

Produces

This API call produces the following media types according to the Accept request header; @@ -4173,20 +5228,17 @@

Produces

Responses

200

Successful operation - map[String, Object] -

404

- Object with given id was not found. - NotFoundKnownExceptionInfo + CheckOperationRead

422

Input failed validation InvalidInputExceptionInfo

-
+
Up -
post /v1/source_oauths/complete_oauth
-
Given a source def ID generate an access/refresh token etc. (completeSourceOAuth)
+
post /v1/operations/create
+
Create an operation to be applied as part of a connection pipeline (createOperation)
@@ -4198,7 +5250,7 @@

Consumes

Request body

-
CompleteSourceOauthRequest CompleteSourceOauthRequest (required)
+
OperationCreate OperationCreate (required)
Body Parameter
@@ -4209,12 +5261,30 @@

Request body

Return type

+ OperationRead - map[String, Object]
+

Example data

+
Content-Type: application/json
+
{
+  "name" : "name",
+  "operationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
+  "operatorConfiguration" : {
+    "normalization" : {
+      "option" : "basic"
+    },
+    "dbt" : {
+      "gitRepoBranch" : "gitRepoBranch",
+      "dockerImage" : "dockerImage",
+      "dbtArguments" : "dbtArguments",
+      "gitRepoUrl" : "gitRepoUrl"
+    }
+  },
+  "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
+}

Produces

This API call produces the following media types according to the Accept request header; @@ -4226,20 +5296,17 @@

Produces

Responses

200

Successful operation - map[String, Object] -

404

- Object with given id was not found. - NotFoundKnownExceptionInfo + OperationRead

422

Input failed validation InvalidInputExceptionInfo

-
+
Up -
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. (getDestinationOAuthConsent)
+
post /v1/operations/delete
+
Delete an operation (deleteOperation)
@@ -4251,7 +5318,7 @@

Consumes

Request body

-
DestinationOauthConsentRequest DestinationOauthConsentRequest (required)
+
OperationIdRequestBody OperationIdRequestBody (required)
Body Parameter
@@ -4260,19 +5327,9 @@

Request body

-

Return type

- -

Example data

-
Content-Type: application/json
-
{
-  "consentUrl" : "consentUrl"
-}

Produces

This API call produces the following media types according to the Accept request header; @@ -4282,9 +5339,9 @@

Produces

Responses

-

200

- Successful operation - OAuthConsentRead +

204

+ The resource was deleted successfully. +

404

Object with given id was not found. NotFoundKnownExceptionInfo @@ -4293,11 +5350,11 @@

422

InvalidInputExceptionInfo

-
+
Up -
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. (getSourceOAuthConsent)
+
post /v1/operations/get
+
Returns an operation (getOperation)
@@ -4309,7 +5366,7 @@

Consumes

Request body

-
SourceOauthConsentRequest SourceOauthConsentRequest (required)
+
OperationIdRequestBody OperationIdRequestBody (required)
Body Parameter
@@ -4320,7 +5377,7 @@

Request body

Return type

@@ -4329,7 +5386,20 @@

Return type

Example data

Content-Type: application/json
{
-  "consentUrl" : "consentUrl"
+  "name" : "name",
+  "operationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
+  "operatorConfiguration" : {
+    "normalization" : {
+      "option" : "basic"
+    },
+    "dbt" : {
+      "gitRepoBranch" : "gitRepoBranch",
+      "dockerImage" : "dockerImage",
+      "dbtArguments" : "dbtArguments",
+      "gitRepoUrl" : "gitRepoUrl"
+    }
+  },
+  "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
 }

Produces

@@ -4342,7 +5412,7 @@

Produces

Responses

200

Successful operation - OAuthConsentRead + OperationRead

404

Object with given id was not found. NotFoundKnownExceptionInfo @@ -4351,12 +5421,12 @@

422

InvalidInputExceptionInfo

-
+
Up -
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. (setInstancewideDestinationOauthParams)
-
+
post /v1/operations/list
+
Returns all operations for a connection. (listOperationsForConnection)
+
List operations for connection.

Consumes

@@ -4367,7 +5437,7 @@

Consumes

Request body

-
SetInstancewideDestinationOauthParamsRequestBody SetInstancewideDestinationOauthParamsRequestBody (required)
+
ConnectionIdRequestBody ConnectionIdRequestBody (required)
Body Parameter
@@ -4376,9 +5446,49 @@

Request body

+

Return type

+ +

Example data

+
Content-Type: application/json
+
{
+  "operations" : [ {
+    "name" : "name",
+    "operationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
+    "operatorConfiguration" : {
+      "normalization" : {
+        "option" : "basic"
+      },
+      "dbt" : {
+        "gitRepoBranch" : "gitRepoBranch",
+        "dockerImage" : "dockerImage",
+        "dbtArguments" : "dbtArguments",
+        "gitRepoUrl" : "gitRepoUrl"
+      }
+    },
+    "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
+  }, {
+    "name" : "name",
+    "operationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
+    "operatorConfiguration" : {
+      "normalization" : {
+        "option" : "basic"
+      },
+      "dbt" : {
+        "gitRepoBranch" : "gitRepoBranch",
+        "dockerImage" : "dockerImage",
+        "dbtArguments" : "dbtArguments",
+        "gitRepoUrl" : "gitRepoUrl"
+      }
+    },
+    "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
+  } ]
+}

Produces

This API call produces the following media types according to the Accept request header; @@ -4389,21 +5499,21 @@

Produces

Responses

200

- Successful - -

400

- Exception occurred; see message for details. - KnownExceptionInfo + Successful operation + OperationReadList

404

Object with given id was not found. NotFoundKnownExceptionInfo +

422

+ Input failed validation + InvalidInputExceptionInfo

-
+
Up -
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. (setInstancewideSourceOauthParams)
+
post /v1/operations/update
+
Update an operation (updateOperation)
@@ -4415,7 +5525,7 @@

Consumes

Request body

-
SetInstancewideSourceOauthParamsRequestBody SetInstancewideSourceOauthParamsRequestBody (required)
+
OperationUpdate OperationUpdate (required)
Body Parameter
@@ -4424,71 +5534,55 @@

Request body

- - - - -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
  • -
- -

Responses

-

200

- Successful - -

400

- Exception occurred; see message for details. - KnownExceptionInfo -

404

- Object with given id was not found. - NotFoundKnownExceptionInfo -
-
-

Openapi

-
-
- Up -
get /v1/openapi
-
Returns the openapi specification (getOpenApiSpec)
-
- - - - - - -

Return type

+ OperationRead - File
+

Example data

+
Content-Type: application/json
+
{
+  "name" : "name",
+  "operationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
+  "operatorConfiguration" : {
+    "normalization" : {
+      "option" : "basic"
+    },
+    "dbt" : {
+      "gitRepoBranch" : "gitRepoBranch",
+      "dockerImage" : "dockerImage",
+      "dbtArguments" : "dbtArguments",
+      "gitRepoUrl" : "gitRepoUrl"
+    }
+  },
+  "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
+}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    -
  • text/plain
  • +
  • application/json

Responses

200

- Returns the openapi specification file - File + Successful operation + OperationRead +

422

+ Input failed validation + InvalidInputExceptionInfo

-

Operation

-
+

Scheduler

+
Up -
post /v1/operations/check
-
Check if an operation to be created is valid (checkOperation)
+
post /v1/scheduler/destinations/check_connection
+
Run check connection for a given destination configuration (executeDestinationCheckConnection)
@@ -4500,7 +5594,7 @@

Consumes

Request body

-
OperatorConfiguration OperatorConfiguration (required)
+
DestinationCoreConfig DestinationCoreConfig (required)
Body Parameter
@@ -4511,7 +5605,7 @@

Request body

Return type

@@ -4521,6 +5615,16 @@

Example data

Content-Type: application/json
{
   "message" : "message",
+  "jobInfo" : {
+    "createdAt" : 0,
+    "configId" : "configId",
+    "endedAt" : 6,
+    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
+    "logs" : {
+      "logLines" : [ "logLines", "logLines" ]
+    },
+    "succeeded" : true
+  },
   "status" : "succeeded"
 }
@@ -4534,17 +5638,17 @@

Produces

Responses

200

Successful operation - CheckOperationRead + CheckConnectionRead

422

Input failed validation InvalidInputExceptionInfo

-
+
Up -
post /v1/operations/create
-
Create an operation to be applied as part of a connection pipeline (createOperation)
+
post /v1/scheduler/sources/check_connection
+
Run check connection for a given source configuration (executeSourceCheckConnection)
@@ -4556,7 +5660,7 @@

Consumes

Request body

-
OperationCreate OperationCreate (required)
+
SourceCoreConfig SourceCoreConfig (required)
Body Parameter
@@ -4567,7 +5671,7 @@

Request body

Return type

@@ -4576,20 +5680,18 @@

Return type

Example data

Content-Type: application/json
{
-  "name" : "name",
-  "operationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-  "operatorConfiguration" : {
-    "normalization" : {
-      "option" : "basic"
+  "message" : "message",
+  "jobInfo" : {
+    "createdAt" : 0,
+    "configId" : "configId",
+    "endedAt" : 6,
+    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
+    "logs" : {
+      "logLines" : [ "logLines", "logLines" ]
     },
-    "dbt" : {
-      "gitRepoBranch" : "gitRepoBranch",
-      "dockerImage" : "dockerImage",
-      "dbtArguments" : "dbtArguments",
-      "gitRepoUrl" : "gitRepoUrl"
-    }
+    "succeeded" : true
   },
-  "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
+  "status" : "succeeded"
 }

Produces

@@ -4602,17 +5704,17 @@

Produces

Responses

200

Successful operation - OperationRead + CheckConnectionRead

422

Input failed validation InvalidInputExceptionInfo

-
+
Up -
post /v1/operations/delete
-
Delete an operation (deleteOperation)
+
post /v1/scheduler/sources/discover_schema
+
Run discover schema for a given source a source configuration (executeSourceDiscoverSchema)
@@ -4624,7 +5726,7 @@

Consumes

Request body

-
OperationIdRequestBody OperationIdRequestBody (required)
+
SourceCoreConfig SourceCoreConfig (required)
Body Parameter
@@ -4633,9 +5735,61 @@

Request body

+

Return type

+ +

Example data

+
Content-Type: application/json
+
{
+  "catalog" : {
+    "streams" : [ {
+      "stream" : {
+        "sourceDefinedPrimaryKey" : [ [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ], [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ] ],
+        "supportedSyncModes" : [ null, null ],
+        "sourceDefinedCursor" : true,
+        "name" : "name",
+        "namespace" : "namespace",
+        "defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ]
+      },
+      "config" : {
+        "aliasName" : "aliasName",
+        "cursorField" : [ "cursorField", "cursorField" ],
+        "selected" : true,
+        "primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
+      }
+    }, {
+      "stream" : {
+        "sourceDefinedPrimaryKey" : [ [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ], [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ] ],
+        "supportedSyncModes" : [ null, null ],
+        "sourceDefinedCursor" : true,
+        "name" : "name",
+        "namespace" : "namespace",
+        "defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ]
+      },
+      "config" : {
+        "aliasName" : "aliasName",
+        "cursorField" : [ "cursorField", "cursorField" ],
+        "selected" : true,
+        "primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
+      }
+    } ]
+  },
+  "jobInfo" : {
+    "createdAt" : 0,
+    "configId" : "configId",
+    "endedAt" : 6,
+    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
+    "logs" : {
+      "logLines" : [ "logLines", "logLines" ]
+    },
+    "succeeded" : true
+  }
+}

Produces

This API call produces the following media types according to the Accept request header; @@ -4645,22 +5799,20 @@

Produces

Responses

-

204

- The resource was deleted successfully. - -

404

- Object with given id was not found. - NotFoundKnownExceptionInfo +

200

+ Successful operation + SourceDiscoverSchemaRead

422

Input failed validation InvalidInputExceptionInfo

-
+

Source

+
Up -
post /v1/operations/get
-
Returns an operation (getOperation)
+
post /v1/sources/check_connection
+
Check connection to the source (checkConnectionToSource)
@@ -4672,7 +5824,7 @@

Consumes

Request body

-
OperationIdRequestBody OperationIdRequestBody (required)
+
SourceIdRequestBody SourceIdRequestBody (required)
Body Parameter
@@ -4683,7 +5835,7 @@

Request body

Return type

@@ -4692,20 +5844,18 @@

Return type

Example data

Content-Type: application/json
{
-  "name" : "name",
-  "operationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-  "operatorConfiguration" : {
-    "normalization" : {
-      "option" : "basic"
+  "message" : "message",
+  "jobInfo" : {
+    "createdAt" : 0,
+    "configId" : "configId",
+    "endedAt" : 6,
+    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
+    "logs" : {
+      "logLines" : [ "logLines", "logLines" ]
     },
-    "dbt" : {
-      "gitRepoBranch" : "gitRepoBranch",
-      "dockerImage" : "dockerImage",
-      "dbtArguments" : "dbtArguments",
-      "gitRepoUrl" : "gitRepoUrl"
-    }
+    "succeeded" : true
   },
-  "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
+  "status" : "succeeded"
 }

Produces

@@ -4718,7 +5868,7 @@

Produces

Responses

200

Successful operation - OperationRead + CheckConnectionRead

404

Object with given id was not found. NotFoundKnownExceptionInfo @@ -4727,12 +5877,12 @@

422

InvalidInputExceptionInfo

-
+
Up -
post /v1/operations/list
-
Returns all operations for a connection. (listOperationsForConnection)
-
List operations for connection.
+
post /v1/sources/check_connection_for_update
+
Check connection for a proposed update to a source (checkConnectionToSourceForUpdate)
+

Consumes

@@ -4743,7 +5893,7 @@

Consumes

Request body

-
ConnectionIdRequestBody ConnectionIdRequestBody (required)
+
SourceUpdate SourceUpdate (required)
Body Parameter
@@ -4754,7 +5904,7 @@

Request body

Return type

@@ -4763,37 +5913,18 @@

Return type

Example data

Content-Type: application/json
{
-  "operations" : [ {
-    "name" : "name",
-    "operationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "operatorConfiguration" : {
-      "normalization" : {
-        "option" : "basic"
-      },
-      "dbt" : {
-        "gitRepoBranch" : "gitRepoBranch",
-        "dockerImage" : "dockerImage",
-        "dbtArguments" : "dbtArguments",
-        "gitRepoUrl" : "gitRepoUrl"
-      }
-    },
-    "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-  }, {
-    "name" : "name",
-    "operationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "operatorConfiguration" : {
-      "normalization" : {
-        "option" : "basic"
-      },
-      "dbt" : {
-        "gitRepoBranch" : "gitRepoBranch",
-        "dockerImage" : "dockerImage",
-        "dbtArguments" : "dbtArguments",
-        "gitRepoUrl" : "gitRepoUrl"
-      }
+  "message" : "message",
+  "jobInfo" : {
+    "createdAt" : 0,
+    "configId" : "configId",
+    "endedAt" : 6,
+    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
+    "logs" : {
+      "logLines" : [ "logLines", "logLines" ]
     },
-    "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-  } ]
+    "succeeded" : true
+  },
+  "status" : "succeeded"
 }

Produces

@@ -4806,7 +5937,7 @@

Produces

Responses

200

Successful operation - OperationReadList + CheckConnectionRead

404

Object with given id was not found. NotFoundKnownExceptionInfo @@ -4815,11 +5946,11 @@

422

InvalidInputExceptionInfo

-
+
Up -
post /v1/operations/update
-
Update an operation (updateOperation)
+
post /v1/sources/clone
+
Clone source (cloneSource)
@@ -4831,7 +5962,7 @@

Consumes

Request body

-
OperationUpdate OperationUpdate (required)
+
SourceIdRequestBody SourceIdRequestBody (required)
Body Parameter
@@ -4842,7 +5973,7 @@

Request body

Return type

@@ -4850,20 +5981,14 @@

Return type

Example data

Content-Type: application/json
-
{
-  "name" : "name",
-  "operationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-  "operatorConfiguration" : {
-    "normalization" : {
-      "option" : "basic"
-    },
-    "dbt" : {
-      "gitRepoBranch" : "gitRepoBranch",
-      "dockerImage" : "dockerImage",
-      "dbtArguments" : "dbtArguments",
-      "gitRepoUrl" : "gitRepoUrl"
-    }
+    
{
+  "sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
+  "connectionConfiguration" : {
+    "user" : "charles"
   },
+  "name" : "name",
+  "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
+  "sourceName" : "sourceName",
   "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
 }
@@ -4877,18 +6002,20 @@

Produces

Responses

200

Successful operation - OperationRead + SourceRead +

404

+ Object with given id was not found. + NotFoundKnownExceptionInfo

422

Input failed validation InvalidInputExceptionInfo

-

Scheduler

-
+
Up -
post /v1/scheduler/destinations/check_connection
-
Run check connection for a given destination configuration (executeDestinationCheckConnection)
+
post /v1/sources/create
+
Create a source (createSource)
@@ -4900,7 +6027,7 @@

Consumes

Request body

-
DestinationCoreConfig DestinationCoreConfig (required)
+
SourceCreate SourceCreate (required)
Body Parameter
@@ -4911,7 +6038,7 @@

Request body

Return type

@@ -4920,18 +6047,14 @@

Return type

Example data

Content-Type: application/json
{
-  "message" : "message",
-  "jobInfo" : {
-    "createdAt" : 0,
-    "configId" : "configId",
-    "endedAt" : 6,
-    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "logs" : {
-      "logLines" : [ "logLines", "logLines" ]
-    },
-    "succeeded" : true
+  "sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
+  "connectionConfiguration" : {
+    "user" : "charles"
   },
-  "status" : "succeeded"
+  "name" : "name",
+  "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
+  "sourceName" : "sourceName",
+  "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
 }

Produces

@@ -4944,17 +6067,17 @@

Produces

Responses

200

Successful operation - CheckConnectionRead + SourceRead

422

Input failed validation InvalidInputExceptionInfo

-
+
Up -
post /v1/scheduler/sources/check_connection
-
Run check connection for a given source configuration (executeSourceCheckConnection)
+
post /v1/sources/delete
+
Delete a source (deleteSource)
@@ -4966,7 +6089,7 @@

Consumes

Request body

-
SourceCoreConfig SourceCoreConfig (required)
+
SourceIdRequestBody SourceIdRequestBody (required)
Body Parameter
@@ -4975,30 +6098,9 @@

Request body

-

Return type

- -

Example data

-
Content-Type: application/json
-
{
-  "message" : "message",
-  "jobInfo" : {
-    "createdAt" : 0,
-    "configId" : "configId",
-    "endedAt" : 6,
-    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "logs" : {
-      "logLines" : [ "logLines", "logLines" ]
-    },
-    "succeeded" : true
-  },
-  "status" : "succeeded"
-}

Produces

This API call produces the following media types according to the Accept request header; @@ -5008,19 +6110,22 @@

Produces

Responses

-

200

- Successful operation - CheckConnectionRead +

204

+ The resource was deleted successfully. + +

404

+ Object with given id was not found. + NotFoundKnownExceptionInfo

422

Input failed validation InvalidInputExceptionInfo

-
+
Up -
post /v1/scheduler/sources/discover_schema
-
Run discover schema for a given source a source configuration (executeSourceDiscoverSchema)
+
post /v1/sources/discover_schema
+
Discover the schema catalog of the source (discoverSchemaForSource)
@@ -5032,7 +6137,7 @@

Consumes

Request body

-
SourceCoreConfig SourceCoreConfig (required)
+
SourceDiscoverSchemaRequestBody SourceDiscoverSchemaRequestBody (required)
Body Parameter
@@ -5108,73 +6213,6 @@

Responses

200

Successful operation SourceDiscoverSchemaRead -

422

- Input failed validation - InvalidInputExceptionInfo -
-
-

Source

-
-
- Up -
post /v1/sources/check_connection
-
Check connection to the source (checkConnectionToSource)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
  • -
- -

Request body

-
-
SourceIdRequestBody SourceIdRequestBody (required)
- -
Body Parameter
- -
- - - - -

Return type

- - - - -

Example data

-
Content-Type: application/json
-
{
-  "message" : "message",
-  "jobInfo" : {
-    "createdAt" : 0,
-    "configId" : "configId",
-    "endedAt" : 6,
-    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "logs" : {
-      "logLines" : [ "logLines", "logLines" ]
-    },
-    "succeeded" : true
-  },
-  "status" : "succeeded"
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
  • -
- -

Responses

-

200

- Successful operation - CheckConnectionRead

404

Object with given id was not found. NotFoundKnownExceptionInfo @@ -5183,11 +6221,11 @@

422

InvalidInputExceptionInfo

-
+
Up -
post /v1/sources/check_connection_for_update
-
Check connection for a proposed update to a source (checkConnectionToSourceForUpdate)
+
post /v1/sources/get
+
Get source (getSource)
@@ -5199,7 +6237,7 @@

Consumes

Request body

-
SourceUpdate SourceUpdate (required)
+
SourceIdRequestBody SourceIdRequestBody (required)
Body Parameter
@@ -5210,7 +6248,7 @@

Request body

Return type

@@ -5219,18 +6257,14 @@

Return type

Example data

Content-Type: application/json
{
-  "message" : "message",
-  "jobInfo" : {
-    "createdAt" : 0,
-    "configId" : "configId",
-    "endedAt" : 6,
-    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "logs" : {
-      "logLines" : [ "logLines", "logLines" ]
-    },
-    "succeeded" : true
+  "sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
+  "connectionConfiguration" : {
+    "user" : "charles"
   },
-  "status" : "succeeded"
+  "name" : "name",
+  "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
+  "sourceName" : "sourceName",
+  "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
 }

Produces

@@ -5243,7 +6277,7 @@

Produces

Responses

200

Successful operation - CheckConnectionRead + SourceRead

404

Object with given id was not found. NotFoundKnownExceptionInfo @@ -5252,12 +6286,12 @@

422

InvalidInputExceptionInfo

-
+
Up -
post /v1/sources/clone
-
Clone source (cloneSource)
-
+
post /v1/sources/list
+
List sources for workspace (listSourcesForWorkspace)
+
List sources for workspace. Does not return deleted sources.

Consumes

@@ -5268,7 +6302,7 @@

Consumes

Request body

-
SourceIdRequestBody SourceIdRequestBody (required)
+
WorkspaceIdRequestBody WorkspaceIdRequestBody (required)
Body Parameter
@@ -5279,7 +6313,7 @@

Request body

Return type

@@ -5288,14 +6322,25 @@

Return type

Example data

Content-Type: application/json
{
-  "sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-  "connectionConfiguration" : {
-    "user" : "charles"
-  },
-  "name" : "name",
-  "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-  "sourceName" : "sourceName",
-  "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
+  "sources" : [ {
+    "sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
+    "connectionConfiguration" : {
+      "user" : "charles"
+    },
+    "name" : "name",
+    "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
+    "sourceName" : "sourceName",
+    "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
+  }, {
+    "sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
+    "connectionConfiguration" : {
+      "user" : "charles"
+    },
+    "name" : "name",
+    "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
+    "sourceName" : "sourceName",
+    "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
+  } ]
 }

Produces

@@ -5308,7 +6353,7 @@

Produces

Responses

200

Successful operation - SourceRead + SourceReadList

404

Object with given id was not found. NotFoundKnownExceptionInfo @@ -5317,11 +6362,11 @@

422

InvalidInputExceptionInfo

-
+
Up -
post /v1/sources/create
-
Create a source (createSource)
+
post /v1/sources/search
+
Search sources (searchSources)
@@ -5333,7 +6378,7 @@

Consumes

Request body

-
SourceCreate SourceCreate (required)
+
SourceSearch SourceSearch (required)
Body Parameter
@@ -5344,7 +6389,7 @@

Request body

Return type

@@ -5353,14 +6398,25 @@

Return type

Example data

Content-Type: application/json
{
-  "sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-  "connectionConfiguration" : {
-    "user" : "charles"
-  },
-  "name" : "name",
-  "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-  "sourceName" : "sourceName",
-  "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
+  "sources" : [ {
+    "sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
+    "connectionConfiguration" : {
+      "user" : "charles"
+    },
+    "name" : "name",
+    "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
+    "sourceName" : "sourceName",
+    "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
+  }, {
+    "sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
+    "connectionConfiguration" : {
+      "user" : "charles"
+    },
+    "name" : "name",
+    "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
+    "sourceName" : "sourceName",
+    "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
+  } ]
 }

Produces

@@ -5373,17 +6429,17 @@

Produces

Responses

200

Successful operation - SourceRead + SourceReadList

422

Input failed validation InvalidInputExceptionInfo

-
+
Up -
post /v1/sources/delete
-
Delete a source (deleteSource)
+
post /v1/sources/update
+
Update a source (updateSource)
@@ -5395,7 +6451,7 @@

Consumes

Request body

-
SourceIdRequestBody SourceIdRequestBody (required)
+
SourceUpdate SourceUpdate (required)
Body Parameter
@@ -5404,9 +6460,26 @@

Request body

+

Return type

+
+ SourceRead + +
+

Example data

+
Content-Type: application/json
+
{
+  "sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
+  "connectionConfiguration" : {
+    "user" : "charles"
+  },
+  "name" : "name",
+  "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
+  "sourceName" : "sourceName",
+  "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
+}

Produces

This API call produces the following media types according to the Accept request header; @@ -5416,9 +6489,9 @@

Produces

Responses

-

204

- The resource was deleted successfully. - +

200

+ Successful operation + SourceRead

404

Object with given id was not found. NotFoundKnownExceptionInfo @@ -5427,11 +6500,12 @@

422

InvalidInputExceptionInfo

-
+

SourceDefinition

+
Up -
post /v1/sources/discover_schema
-
Discover the schema catalog of the source (discoverSchemaForSource)
+
post /v1/source_definitions/create_custom
+
Creates a custom sourceDefinition for the given workspace (createCustomSourceDefinition)
@@ -5443,7 +6517,7 @@

Consumes

Request body

-
SourceDiscoverSchemaRequestBody SourceDiscoverSchemaRequestBody (required)
+
CustomSourceDefinitionCreate CustomSourceDefinitionCreate (optional)
Body Parameter
@@ -5454,7 +6528,7 @@

Request body

Return type

@@ -5463,49 +6537,36 @@

Return type

Example data

Content-Type: application/json
{
-  "catalog" : {
-    "streams" : [ {
-      "stream" : {
-        "sourceDefinedPrimaryKey" : [ [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ], [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ] ],
-        "supportedSyncModes" : [ null, null ],
-        "sourceDefinedCursor" : true,
-        "name" : "name",
-        "namespace" : "namespace",
-        "defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ]
-      },
-      "config" : {
-        "aliasName" : "aliasName",
-        "cursorField" : [ "cursorField", "cursorField" ],
-        "selected" : true,
-        "primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
+  "resourceRequirements" : {
+    "default" : {
+      "cpu_limit" : "cpu_limit",
+      "memory_request" : "memory_request",
+      "memory_limit" : "memory_limit",
+      "cpu_request" : "cpu_request"
+    },
+    "jobSpecific" : [ {
+      "resourceRequirements" : {
+        "cpu_limit" : "cpu_limit",
+        "memory_request" : "memory_request",
+        "memory_limit" : "memory_limit",
+        "cpu_request" : "cpu_request"
       }
     }, {
-      "stream" : {
-        "sourceDefinedPrimaryKey" : [ [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ], [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ] ],
-        "supportedSyncModes" : [ null, null ],
-        "sourceDefinedCursor" : true,
-        "name" : "name",
-        "namespace" : "namespace",
-        "defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ]
-      },
-      "config" : {
-        "aliasName" : "aliasName",
-        "cursorField" : [ "cursorField", "cursorField" ],
-        "selected" : true,
-        "primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
+      "resourceRequirements" : {
+        "cpu_limit" : "cpu_limit",
+        "memory_request" : "memory_request",
+        "memory_limit" : "memory_limit",
+        "cpu_request" : "cpu_request"
       }
     } ]
   },
-  "jobInfo" : {
-    "createdAt" : 0,
-    "configId" : "configId",
-    "endedAt" : 6,
-    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "logs" : {
-      "logLines" : [ "logLines", "logLines" ]
-    },
-    "succeeded" : true
-  }
+  "documentationUrl" : "https://openapi-generator.tech",
+  "dockerImageTag" : "dockerImageTag",
+  "releaseDate" : "2000-01-23",
+  "dockerRepository" : "dockerRepository",
+  "name" : "name",
+  "icon" : "icon",
+  "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
 }

Produces

@@ -5518,20 +6579,17 @@

Produces

Responses

200

Successful operation - SourceDiscoverSchemaRead -

404

- Object with given id was not found. - NotFoundKnownExceptionInfo + SourceDefinitionRead

422

Input failed validation InvalidInputExceptionInfo

-
+
Up -
post /v1/sources/get
-
Get source (getSource)
+
post /v1/source_definitions/create
+
Creates a sourceDefinition (createSourceDefinition)
@@ -5543,7 +6601,7 @@

Consumes

Request body

-
SourceIdRequestBody SourceIdRequestBody (required)
+
SourceDefinitionCreate SourceDefinitionCreate (optional)
Body Parameter
@@ -5554,7 +6612,7 @@

Request body

Return type

@@ -5563,14 +6621,36 @@

Return type

Example data

Content-Type: application/json
{
-  "sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-  "connectionConfiguration" : {
-    "user" : "charles"
+  "resourceRequirements" : {
+    "default" : {
+      "cpu_limit" : "cpu_limit",
+      "memory_request" : "memory_request",
+      "memory_limit" : "memory_limit",
+      "cpu_request" : "cpu_request"
+    },
+    "jobSpecific" : [ {
+      "resourceRequirements" : {
+        "cpu_limit" : "cpu_limit",
+        "memory_request" : "memory_request",
+        "memory_limit" : "memory_limit",
+        "cpu_request" : "cpu_request"
+      }
+    }, {
+      "resourceRequirements" : {
+        "cpu_limit" : "cpu_limit",
+        "memory_request" : "memory_request",
+        "memory_limit" : "memory_limit",
+        "cpu_request" : "cpu_request"
+      }
+    } ]
   },
+  "documentationUrl" : "https://openapi-generator.tech",
+  "dockerImageTag" : "dockerImageTag",
+  "releaseDate" : "2000-01-23",
+  "dockerRepository" : "dockerRepository",
   "name" : "name",
-  "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-  "sourceName" : "sourceName",
-  "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
+  "icon" : "icon",
+  "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
 }

Produces

@@ -5583,21 +6663,18 @@

Produces

Responses

200

Successful operation - SourceRead -

404

- Object with given id was not found. - NotFoundKnownExceptionInfo + SourceDefinitionRead

422

Input failed validation InvalidInputExceptionInfo

-
+
Up -
post /v1/sources/list
-
List sources for workspace (listSourcesForWorkspace)
-
List sources for workspace. Does not return deleted sources.
+
post /v1/source_definitions/delete_custom
+
Delete a custom source definition for the given workspace (deleteCustomSourceDefinition)
+

Consumes

@@ -5608,7 +6685,7 @@

Consumes

Request body

-
WorkspaceIdRequestBody WorkspaceIdRequestBody (required)
+
SourceDefinitionIdWithWorkspaceId SourceDefinitionIdWithWorkspaceId (required)
Body Parameter
@@ -5617,37 +6694,9 @@

Request body

-

Return type

- -

Example data

-
Content-Type: application/json
-
{
-  "sources" : [ {
-    "sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "connectionConfiguration" : {
-      "user" : "charles"
-    },
-    "name" : "name",
-    "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "sourceName" : "sourceName",
-    "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-  }, {
-    "sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "connectionConfiguration" : {
-      "user" : "charles"
-    },
-    "name" : "name",
-    "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "sourceName" : "sourceName",
-    "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-  } ]
-}

Produces

This API call produces the following media types according to the Accept request header; @@ -5657,9 +6706,9 @@

Produces

Responses

-

200

- Successful operation - SourceReadList +

204

+ The resource was deleted successfully. +

404

Object with given id was not found. NotFoundKnownExceptionInfo @@ -5668,11 +6717,11 @@

422

InvalidInputExceptionInfo

-
+
Up -
post /v1/sources/search
-
Search sources (searchSources)
+
post /v1/source_definitions/delete
+
Delete a source definition (deleteSourceDefinition)
@@ -5684,7 +6733,7 @@

Consumes

Request body

-
SourceSearch SourceSearch (required)
+
SourceDefinitionIdRequestBody SourceDefinitionIdRequestBody (required)
Body Parameter
@@ -5693,37 +6742,9 @@

Request body

-

Return type

- -

Example data

-
Content-Type: application/json
-
{
-  "sources" : [ {
-    "sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "connectionConfiguration" : {
-      "user" : "charles"
-    },
-    "name" : "name",
-    "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "sourceName" : "sourceName",
-    "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-  }, {
-    "sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "connectionConfiguration" : {
-      "user" : "charles"
-    },
-    "name" : "name",
-    "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "sourceName" : "sourceName",
-    "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-  } ]
-}

Produces

This API call produces the following media types according to the Accept request header; @@ -5733,19 +6754,22 @@

Produces

Responses

-

200

- Successful operation - SourceReadList +

204

+ The resource was deleted successfully. + +

404

+ Object with given id was not found. + NotFoundKnownExceptionInfo

422

Input failed validation InvalidInputExceptionInfo

-
+
Up -
post /v1/sources/update
-
Update a source (updateSource)
+
post /v1/source_definitions/get
+
Get source (getSourceDefinition)
@@ -5757,7 +6781,7 @@

Consumes

Request body

-
SourceUpdate SourceUpdate (required)
+
SourceDefinitionIdRequestBody SourceDefinitionIdRequestBody (required)
Body Parameter
@@ -5768,7 +6792,7 @@

Request body

Return type

@@ -5777,14 +6801,36 @@

Return type

Example data

Content-Type: application/json
{
-  "sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-  "connectionConfiguration" : {
-    "user" : "charles"
+  "resourceRequirements" : {
+    "default" : {
+      "cpu_limit" : "cpu_limit",
+      "memory_request" : "memory_request",
+      "memory_limit" : "memory_limit",
+      "cpu_request" : "cpu_request"
+    },
+    "jobSpecific" : [ {
+      "resourceRequirements" : {
+        "cpu_limit" : "cpu_limit",
+        "memory_request" : "memory_request",
+        "memory_limit" : "memory_limit",
+        "cpu_request" : "cpu_request"
+      }
+    }, {
+      "resourceRequirements" : {
+        "cpu_limit" : "cpu_limit",
+        "memory_request" : "memory_request",
+        "memory_limit" : "memory_limit",
+        "cpu_request" : "cpu_request"
+      }
+    } ]
   },
+  "documentationUrl" : "https://openapi-generator.tech",
+  "dockerImageTag" : "dockerImageTag",
+  "releaseDate" : "2000-01-23",
+  "dockerRepository" : "dockerRepository",
   "name" : "name",
-  "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-  "sourceName" : "sourceName",
-  "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
+  "icon" : "icon",
+  "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
 }

Produces

@@ -5797,7 +6843,7 @@

Produces

Responses

200

Successful operation - SourceRead + SourceDefinitionRead

404

Object with given id was not found. NotFoundKnownExceptionInfo @@ -5806,12 +6852,11 @@

422

InvalidInputExceptionInfo

-

SourceDefinition

-
+
Up -
post /v1/source_definitions/create
-
Creates a sourceDefinition (createSourceDefinition)
+
post /v1/source_definitions/get_for_workspace
+
Get a sourceDefinition that is configured for the given workspace (getSourceDefinitionForWorkspace)
@@ -5823,7 +6868,7 @@

Consumes

Request body

-
SourceDefinitionCreate SourceDefinitionCreate (optional)
+
SourceDefinitionIdWithWorkspaceId SourceDefinitionIdWithWorkspaceId (required)
Body Parameter
@@ -5886,16 +6931,19 @@

Responses

200

Successful operation SourceDefinitionRead +

404

+ Object with given id was not found. + NotFoundKnownExceptionInfo

422

Input failed validation InvalidInputExceptionInfo

-
+
Up -
post /v1/source_definitions/delete
-
Delete a source definition (deleteSourceDefinition)
+
post /v1/source_definitions/grant_definition
+
grant a private, non-custom sourceDefinition to a given workspace (grantSourceDefinitionToWorkspace)
@@ -5907,7 +6955,7 @@

Consumes

Request body

-
SourceDefinitionIdRequestBody SourceDefinitionIdRequestBody (required)
+
SourceDefinitionIdWithWorkspaceId SourceDefinitionIdWithWorkspaceId (required)
Body Parameter
@@ -5916,9 +6964,51 @@

Request body

+

Return type

+ +

Example data

+
Content-Type: application/json
+
{
+  "sourceDefinition" : {
+    "resourceRequirements" : {
+      "default" : {
+        "cpu_limit" : "cpu_limit",
+        "memory_request" : "memory_request",
+        "memory_limit" : "memory_limit",
+        "cpu_request" : "cpu_request"
+      },
+      "jobSpecific" : [ {
+        "resourceRequirements" : {
+          "cpu_limit" : "cpu_limit",
+          "memory_request" : "memory_request",
+          "memory_limit" : "memory_limit",
+          "cpu_request" : "cpu_request"
+        }
+      }, {
+        "resourceRequirements" : {
+          "cpu_limit" : "cpu_limit",
+          "memory_request" : "memory_request",
+          "memory_limit" : "memory_limit",
+          "cpu_request" : "cpu_request"
+        }
+      } ]
+    },
+    "documentationUrl" : "https://openapi-generator.tech",
+    "dockerImageTag" : "dockerImageTag",
+    "releaseDate" : "2000-01-23",
+    "dockerRepository" : "dockerRepository",
+    "name" : "name",
+    "icon" : "icon",
+    "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
+  },
+  "granted" : true
+}

Produces

This API call produces the following media types according to the Accept request header; @@ -5928,9 +7018,9 @@

Produces

Responses

-

204

- The resource was deleted successfully. - +

200

+ Successful operation + PrivateSourceDefinitionRead

404

Object with given id was not found. NotFoundKnownExceptionInfo @@ -5939,11 +7029,113 @@

422

InvalidInputExceptionInfo

-
+
Up -
post /v1/source_definitions/get
-
Get source (getSourceDefinition)
+
post /v1/source_definitions/list_latest
+
List the latest sourceDefinitions Airbyte supports (listLatestSourceDefinitions)
+
Guaranteed to retrieve the latest information on supported sources.
+ + + + + + + +

Return type

+ + + + +

Example data

+
Content-Type: application/json
+
{
+  "sourceDefinitions" : [ {
+    "resourceRequirements" : {
+      "default" : {
+        "cpu_limit" : "cpu_limit",
+        "memory_request" : "memory_request",
+        "memory_limit" : "memory_limit",
+        "cpu_request" : "cpu_request"
+      },
+      "jobSpecific" : [ {
+        "resourceRequirements" : {
+          "cpu_limit" : "cpu_limit",
+          "memory_request" : "memory_request",
+          "memory_limit" : "memory_limit",
+          "cpu_request" : "cpu_request"
+        }
+      }, {
+        "resourceRequirements" : {
+          "cpu_limit" : "cpu_limit",
+          "memory_request" : "memory_request",
+          "memory_limit" : "memory_limit",
+          "cpu_request" : "cpu_request"
+        }
+      } ]
+    },
+    "documentationUrl" : "https://openapi-generator.tech",
+    "dockerImageTag" : "dockerImageTag",
+    "releaseDate" : "2000-01-23",
+    "dockerRepository" : "dockerRepository",
+    "name" : "name",
+    "icon" : "icon",
+    "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
+  }, {
+    "resourceRequirements" : {
+      "default" : {
+        "cpu_limit" : "cpu_limit",
+        "memory_request" : "memory_request",
+        "memory_limit" : "memory_limit",
+        "cpu_request" : "cpu_request"
+      },
+      "jobSpecific" : [ {
+        "resourceRequirements" : {
+          "cpu_limit" : "cpu_limit",
+          "memory_request" : "memory_request",
+          "memory_limit" : "memory_limit",
+          "cpu_request" : "cpu_request"
+        }
+      }, {
+        "resourceRequirements" : {
+          "cpu_limit" : "cpu_limit",
+          "memory_request" : "memory_request",
+          "memory_limit" : "memory_limit",
+          "cpu_request" : "cpu_request"
+        }
+      } ]
+    },
+    "documentationUrl" : "https://openapi-generator.tech",
+    "dockerImageTag" : "dockerImageTag",
+    "releaseDate" : "2000-01-23",
+    "dockerRepository" : "dockerRepository",
+    "name" : "name",
+    "icon" : "icon",
+    "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
+  } ]
+}
+ +

Produces

+ This API call produces the following media types according to the Accept request header; + the media type will be conveyed by the Content-Type response header. +
    +
  • application/json
  • +
+ +

Responses

+

200

+ Successful operation + SourceDefinitionReadList +
+
+
+
+ Up +
post /v1/source_definitions/list_private
+
List all private, non-custom sourceDefinitions, and for each indicate whether the given workspace has a grant for using the definition. Used by admins to view and modify a given workspace's grants. (listPrivateSourceDefinitions)
@@ -5955,7 +7147,7 @@

Consumes

Request body

-
SourceDefinitionIdRequestBody SourceDefinitionIdRequestBody (required)
+
WorkspaceIdRequestBody WorkspaceIdRequestBody (optional)
Body Parameter
@@ -5966,7 +7158,7 @@

Request body

Return type

@@ -5975,36 +7167,75 @@

Return type

Example data

Content-Type: application/json
{
-  "resourceRequirements" : {
-    "default" : {
-      "cpu_limit" : "cpu_limit",
-      "memory_request" : "memory_request",
-      "memory_limit" : "memory_limit",
-      "cpu_request" : "cpu_request"
+  "sourceDefinitions" : [ {
+    "sourceDefinition" : {
+      "resourceRequirements" : {
+        "default" : {
+          "cpu_limit" : "cpu_limit",
+          "memory_request" : "memory_request",
+          "memory_limit" : "memory_limit",
+          "cpu_request" : "cpu_request"
+        },
+        "jobSpecific" : [ {
+          "resourceRequirements" : {
+            "cpu_limit" : "cpu_limit",
+            "memory_request" : "memory_request",
+            "memory_limit" : "memory_limit",
+            "cpu_request" : "cpu_request"
+          }
+        }, {
+          "resourceRequirements" : {
+            "cpu_limit" : "cpu_limit",
+            "memory_request" : "memory_request",
+            "memory_limit" : "memory_limit",
+            "cpu_request" : "cpu_request"
+          }
+        } ]
+      },
+      "documentationUrl" : "https://openapi-generator.tech",
+      "dockerImageTag" : "dockerImageTag",
+      "releaseDate" : "2000-01-23",
+      "dockerRepository" : "dockerRepository",
+      "name" : "name",
+      "icon" : "icon",
+      "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
+    },
+    "granted" : true
+  }, {
+    "sourceDefinition" : {
+      "resourceRequirements" : {
+        "default" : {
+          "cpu_limit" : "cpu_limit",
+          "memory_request" : "memory_request",
+          "memory_limit" : "memory_limit",
+          "cpu_request" : "cpu_request"
+        },
+        "jobSpecific" : [ {
+          "resourceRequirements" : {
+            "cpu_limit" : "cpu_limit",
+            "memory_request" : "memory_request",
+            "memory_limit" : "memory_limit",
+            "cpu_request" : "cpu_request"
+          }
+        }, {
+          "resourceRequirements" : {
+            "cpu_limit" : "cpu_limit",
+            "memory_request" : "memory_request",
+            "memory_limit" : "memory_limit",
+            "cpu_request" : "cpu_request"
+          }
+        } ]
+      },
+      "documentationUrl" : "https://openapi-generator.tech",
+      "dockerImageTag" : "dockerImageTag",
+      "releaseDate" : "2000-01-23",
+      "dockerRepository" : "dockerRepository",
+      "name" : "name",
+      "icon" : "icon",
+      "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
     },
-    "jobSpecific" : [ {
-      "resourceRequirements" : {
-        "cpu_limit" : "cpu_limit",
-        "memory_request" : "memory_request",
-        "memory_limit" : "memory_limit",
-        "cpu_request" : "cpu_request"
-      }
-    }, {
-      "resourceRequirements" : {
-        "cpu_limit" : "cpu_limit",
-        "memory_request" : "memory_request",
-        "memory_limit" : "memory_limit",
-        "cpu_request" : "cpu_request"
-      }
-    } ]
-  },
-  "documentationUrl" : "https://openapi-generator.tech",
-  "dockerImageTag" : "dockerImageTag",
-  "releaseDate" : "2000-01-23",
-  "dockerRepository" : "dockerRepository",
-  "name" : "name",
-  "icon" : "icon",
-  "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
+    "granted" : true
+  } ]
 }

Produces

@@ -6017,21 +7248,15 @@

Produces

Responses

200

Successful operation - SourceDefinitionRead -

404

- Object with given id was not found. - NotFoundKnownExceptionInfo -

422

- Input failed validation - InvalidInputExceptionInfo + PrivateSourceDefinitionReadList

-
+
Up -
post /v1/source_definitions/list_latest
-
List the latest sourceDefinitions Airbyte supports (listLatestSourceDefinitions)
-
Guaranteed to retrieve the latest information on supported sources.
+
post /v1/source_definitions/list
+
List all the sourceDefinitions the current Airbyte deployment is configured to use (listSourceDefinitions)
+
@@ -6128,15 +7353,27 @@

200

SourceDefinitionReadList

-
+
Up -
post /v1/source_definitions/list
-
List all the sourceDefinitions the current Airbyte deployment is configured to use (listSourceDefinitions)
+
post /v1/source_definitions/list_for_workspace
+
List all the sourceDefinitions the given workspace is configured to use (listSourceDefinitionsForWorkspace)
+

Consumes

+ This API call consumes the following media types via the Content-Type request header: +
    +
  • application/json
  • +
+ +

Request body

+
+
WorkspaceIdRequestBody WorkspaceIdRequestBody (optional)
+ +
Body Parameter
+
@@ -6230,6 +7467,141 @@

200

SourceDefinitionReadList

+
+
+ Up +
post /v1/source_definitions/revoke_definition
+
revoke a grant to a private, non-custom sourceDefinition from a given workspace (revokeSourceDefinitionFromWorkspace)
+
+ + +

Consumes

+ This API call consumes the following media types via the Content-Type request header: +
    +
  • application/json
  • +
+ +

Request body

+
+
SourceDefinitionIdWithWorkspaceId SourceDefinitionIdWithWorkspaceId (required)
+ +
Body Parameter
+ +
+ + + + + + + + +

Produces

+ This API call produces the following media types according to the Accept request header; + the media type will be conveyed by the Content-Type response header. +
    +
  • application/json
  • +
+ +

Responses

+

204

+ The resource was deleted successfully. + +

404

+ Object with given id was not found. + NotFoundKnownExceptionInfo +

422

+ Input failed validation + InvalidInputExceptionInfo +
+
+
+
+ Up +
post /v1/source_definitions/update_custom
+
Update a custom sourceDefinition for the given workspace (updateCustomSourceDefinition)
+
+ + +

Consumes

+ This API call consumes the following media types via the Content-Type request header: +
    +
  • application/json
  • +
+ +

Request body

+
+
CustomSourceDefinitionUpdate CustomSourceDefinitionUpdate (optional)
+ +
Body Parameter
+ +
+ + + + +

Return type

+ + + + +

Example data

+
Content-Type: application/json
+
{
+  "resourceRequirements" : {
+    "default" : {
+      "cpu_limit" : "cpu_limit",
+      "memory_request" : "memory_request",
+      "memory_limit" : "memory_limit",
+      "cpu_request" : "cpu_request"
+    },
+    "jobSpecific" : [ {
+      "resourceRequirements" : {
+        "cpu_limit" : "cpu_limit",
+        "memory_request" : "memory_request",
+        "memory_limit" : "memory_limit",
+        "cpu_request" : "cpu_request"
+      }
+    }, {
+      "resourceRequirements" : {
+        "cpu_limit" : "cpu_limit",
+        "memory_request" : "memory_request",
+        "memory_limit" : "memory_limit",
+        "cpu_request" : "cpu_request"
+      }
+    } ]
+  },
+  "documentationUrl" : "https://openapi-generator.tech",
+  "dockerImageTag" : "dockerImageTag",
+  "releaseDate" : "2000-01-23",
+  "dockerRepository" : "dockerRepository",
+  "name" : "name",
+  "icon" : "icon",
+  "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
+}
+ +

Produces

+ This API call produces the following media types according to the Accept request header; + the media type will be conveyed by the Content-Type response header. +
    +
  • application/json
  • +
+ +

Responses

+

200

+ Successful operation + SourceDefinitionRead +

404

+ Object with given id was not found. + NotFoundKnownExceptionInfo +

422

+ Input failed validation + InvalidInputExceptionInfo +
+
+
+

CustomDestinationDefinitionCreate - Up

+
+
+
workspaceId
UUID format: uuid
+
destinationDefinition
+
+
+
+

CustomDestinationDefinitionUpdate - Up

+
+
+
workspaceId
UUID format: uuid
+
destinationDefinition
+
+
+
+

CustomSourceDefinitionCreate - Up

+
+
+
workspaceId
UUID format: uuid
+
sourceDefinition
+
+
+
+

CustomSourceDefinitionUpdate - Up

+
+
+
workspaceId
UUID format: uuid
+
sourceDefinition
+
+
+
+

DestinationDefinitionIdWithWorkspaceId - Up

+
+
+
destinationDefinitionId
UUID format: uuid
+
workspaceId
UUID format: uuid
+
+
+
+

PrivateDestinationDefinitionRead - Up

+
+
+
destinationDefinition
+
granted
+
+
+ +
+

PrivateSourceDefinitionRead - Up

+
+
+
sourceDefinition
+
granted
+
+
+
+
+

SourceDefinitionIdWithWorkspaceId - Up

+
+
+
sourceDefinitionId
UUID format: uuid
+
workspaceId
UUID format: uuid
+
+