Merge pull request #2 from aballiet/release-v-1-0-5

update doc
aballiet · Nov 16, 2023 · d5c627c · d5c627c
2 parents 710c26b + fb5350d
commit d5c627c
Show file tree

Hide file tree

Showing 6 changed files with 510 additions and 106 deletions.
diff --git a/docs/index.md b/docs/index.md
@@ -58,16 +58,13 @@ terraform {
   required_providers {
     airbyte = {
       source  = "aballiet/airbyte"
-      version = "1.0.3"
+      version = "1.0.5"
     }
   }
 }
 
 provider "airbyte" {
   # Configuration options
-  server_url  = "http://localhost:8000"
-  username = "YOUR_USER_NAME"
-  password = "YOUR_PASSWORD"
 }
 ```
 

diff --git a/docs/resources/airbyte_connection.md b/docs/resources/airbyte_connection.md
@@ -14,11 +14,89 @@ Connection Resource
 
 ```terraform
 resource "airbyte_connection" "my_connection" {
-    destination_id = "89bd9d8d-69a6-474e-8f46-7cc8796ed151"
-            namespace_format = "${SOURCE_NAMESPACE}"
-            source_id = "a05dfc2d-df7c-4c78-8a1b-a928fc816742"
-            status = "deprecated"
+  destination_id                  = "2d0b4937-840e-4535-aba0-03060ced80fc"
+  geography                       = "auto"
+  name                            = "Sheldon Balistreri"
+  namespace_definition            = "source"
+  namespace_format                = SOURCE_NAMESPACE
+  non_breaking_changes_preference = "ignore"
+  notify_schema_changes           = false
+  notify_schema_changes_by_email  = true
+  operation_ids = [
+    "fbb5835b-a03c-430b-b29d-f734fbd43f94",
+  ]
+  prefix = "...my_prefix..."
+  resource_requirements = {
+    cpu_limit      = "...my_cpu_limit..."
+    cpu_request    = "...my_cpu_request..."
+    memory_limit   = "...my_memory_limit..."
+    memory_request = "...my_memory_request..."
+  }
+  schedule = {
+    time_unit = "minutes"
+    units     = 9
+  }
+  schedule_data = {
+    basic_schedule = {
+      time_unit = "weeks"
+      units     = 7
+    }
+    cron = {
+      cron_expression = "...my_cron_expression..."
+      cron_time_zone  = "...my_cron_time_zone..."
+    }
+  }
+  schedule_type     = "cron"
+  source_catalog_id = "5e6b8dd9-95b8-45b3-8db9-804e4cb5e145"
+  source_id         = "1ef85fdd-6486-4396-b21f-097ee8d4067a"
+  status            = "inactive"
+  sync_catalog = {
+    streams = [
+      {
+        config = {
+          alias_name = "...my_alias_name..."
+          cursor_field = [
+            "...",
+          ]
+          destination_sync_mode   = "append_dedup"
+          field_selection_enabled = true
+          primary_key = [
+            [
+              "...",
+            ],
+          ]
+          selected = false
+          selected_fields = [
+            {
+              field_path = [
+                "...",
+              ]
+            },
+          ]
+          suggested = false
+          sync_mode = "incremental"
         }
+        stream = {
+          default_cursor_field = [
+            "...",
+          ]
+          json_schema           = {}
+          name                  = "Ms. June Bins"
+          namespace             = "...my_namespace..."
+          source_defined_cursor = true
+          source_defined_primary_key = [
+            [
+              "...",
+            ],
+          ]
+          supported_sync_modes = [
+            "incremental",
+          ]
+        }
+      },
+    ]
+  }
+}
 ```
 
 <!-- schema generated by tfplugindocs -->
@@ -28,25 +106,26 @@ resource "airbyte_connection" "my_connection" {
 
 - `destination_id` (String)
 - `source_id` (String)
-- `status` (String) must be one of [active, inactive, deprecated]
+- `status` (String) must be one of ["active", "inactive", "deprecated"]
 Active means that data is flowing through the connection. Inactive means it is not. Deprecated means the connection is off and cannot be re-activated. the schema field describes the elements of the schema that will be synced.
 
 ### Optional
 
-- `geography` (String) must be one of [auto, us, eu]
+- `geography` (String) must be one of ["auto", "us", "eu"]
 - `name` (String) Optional name of the connection
-- `namespace_definition` (String) must be one of [source, destination, customformat]
+- `namespace_definition` (String) must be one of ["source", "destination", "customformat"]
 Method used for computing final namespace in destination
-- `namespace_format` (String) Used when namespaceDefinition is 'customformat'. If blank then behaves like namespaceDefinition = 'destination'. If "${SOURCE_NAMESPACE}" then behaves like namespaceDefinition = 'source'.
-- `non_breaking_changes_preference` (String) must be one of [ignore, disable, propagate_columns, propagate_fully]
+- `namespace_format` (String) Default: null
+Used when namespaceDefinition is 'customformat'. If blank then behaves like namespaceDefinition = 'destination'. If "${SOURCE_NAMESPACE}" then behaves like namespaceDefinition = 'source'.
+- `non_breaking_changes_preference` (String) must be one of ["ignore", "disable", "propagate_columns", "propagate_fully"]
 - `notify_schema_changes` (Boolean)
 - `notify_schema_changes_by_email` (Boolean)
 - `operation_ids` (List of String)
 - `prefix` (String) Prefix that will be prepended to the name of each stream when it is written to the destination.
 - `resource_requirements` (Attributes) optional resource requirements to run workers (blank for unbounded allocations) (see [below for nested schema](#nestedatt--resource_requirements))
 - `schedule` (Attributes) if null, then no schedule is set. (see [below for nested schema](#nestedatt--schedule))
 - `schedule_data` (Attributes) schedule for when the the connection should run, per the schedule type (see [below for nested schema](#nestedatt--schedule_data))
-- `schedule_type` (String) must be one of [manual, basic, cron]
+- `schedule_type` (String) must be one of ["manual", "basic", "cron"]
 determine how the schedule data should be interpreted
 - `source_catalog_id` (String)
 - `sync_catalog` (Attributes) describes the available schema (catalog). (see [below for nested schema](#nestedatt--sync_catalog))
@@ -73,7 +152,7 @@ Optional:
 
 Required:
 
-- `time_unit` (String) must be one of [minutes, hours, days, weeks, months]
+- `time_unit` (String) must be one of ["minutes", "hours", "days", "weeks", "months"]
 - `units` (Number)
 
 
@@ -90,7 +169,7 @@ Optional:
 
 Required:
 
-- `time_unit` (String) must be one of [minutes, hours, days, weeks, months]
+- `time_unit` (String) must be one of ["minutes", "hours", "days", "weeks", "months"]
 - `units` (Number)
 
 
@@ -124,8 +203,8 @@ Optional:
 
 Required:
 
-- `destination_sync_mode` (String) must be one of [append, overwrite, append_dedup]
-- `sync_mode` (String) must be one of [full_refresh, incremental]
+- `destination_sync_mode` (String) must be one of ["append", "overwrite", "append_dedup"]
+- `sync_mode` (String) must be one of ["full_refresh", "incremental"]
 
 Optional:
 

diff --git a/docs/resources/airbyte_source.md b/docs/resources/airbyte_source.md
@@ -14,12 +14,12 @@ Source Resource
 
 ```terraform
 resource "airbyte_source" "my_source" {
-    connection_configuration = "{ \"see\": \"documentation\" }"
-            name = "Cory Emmerich"
-            source_definition_id = "05929396-fea7-4596-ab10-faaa2352c595"
-            source_id = "5907aff1-a3a2-4fa9-8677-39251aa52c3f"
-            workspace_id = "5ad019da-1ffe-478f-897b-0074f15471b5"
-        }
+  connection_configuration = { "user" : "charles" }
+  name                     = "Austin Stracke"
+  secret_id                = "airbyte_oauth_workspace_0509f049-d671-48cb-8105-0a23d47e6db6_secret_e0d38206-034e-4d75-9d21-da5a99b02826_v1"
+  source_definition_id     = "2f95525d-bfb0-4168-a100-133587515722"
+  workspace_id             = "b625efa1-bbfa-48d6-85f7-19d133279f15"
+}
 ```
 
 <!-- schema generated by tfplugindocs -->
@@ -31,23 +31,16 @@ resource "airbyte_source" "my_source" {
 The values required to configure the source. The schema for this must match the schema return by source_definition_specifications/get for the source.
 - `name` (String)
 - `source_definition_id` (String)
-- `source_id` (String)
 - `workspace_id` (String)
 
-### Read-Only
-
-- `exception_class_name` (String)
-- `exception_stack` (List of String)
-- `message` (String)
-- `validation_errors` (Attributes List) (see [below for nested schema](#nestedatt--validation_errors))
+### Optional
 
-<a id="nestedatt--validation_errors"></a>
-### Nested Schema for `validation_errors`
+- `secret_id` (String)
 
-Read-Only:
+### Read-Only
 
-- `invalid_value` (String)
-- `message` (String)
-- `property_path` (String)
+- `icon` (String)
+- `source_id` (String)
+- `source_name` (String)
 
 
diff --git a/docs/resources/airbyte_source_definition.md b/docs/resources/airbyte_source_definition.md
@@ -14,54 +14,68 @@ SourceDefinition Resource
 
 ```terraform
 resource "airbyte_source_definition" "my_sourcedefinition" {
-    docker_image_tag = "...my_dockerImageTag..."
-            source_definition = {
-        docker_image_tag = "...my_dockerImageTag..."
-        docker_repository = "...my_dockerRepository..."
-        documentation_url = "https://immediate-tow-truck.com"
-        icon = "...my_icon..."
-        name = "Alison Mann"
-        resource_requirements = {
-            default = {
-                cpu_limit = "...my_cpu_limit..."
-                cpu_request = "...my_cpu_request..."
-                memory_limit = "...my_memory_limit..."
-                memory_request = "...my_memory_request..."
-            }
-            job_specific = [
-                {
-                    job_type = "check_connection"
-                    resource_requirements =  = {
-                        cpu_limit = "...my_cpu_limit..."
-                        cpu_request = "...my_cpu_request..."
-                        memory_limit = "...my_memory_limit..."
-                        memory_request = "...my_memory_request..."
-                    }
-                },
-            ]
-        }
+  scope_id   = "ad8bb3fe-33fa-4c92-96cf-878498930f77"
+  scope_type = "organization"
+  source_definition = {
+    name              = "Rex Becker"
+    docker_repository = "...my_docker_repository..."
+    docker_image_tag  = "...my_docker_image_tag..."
+    documentation_url = "http://yearly-hive.name"
+    icon              = "...my_icon..."
+    resource_requirements = {
+      default = {
+        cpu_request    = "...my_cpu_request..."
+        cpu_limit      = "...my_cpu_limit..."
+        memory_request = "...my_memory_request..."
+        memory_limit   = "...my_memory_limit..."
+      }
+      job_specific = [
+        {
+          job_type = "discover_schema"
+          resource_requirements = {
+            cpu_request    = "...my_cpu_request..."
+            cpu_limit      = "...my_cpu_limit..."
+            memory_request = "...my_memory_request..."
+            memory_limit   = "...my_memory_limit..."
+          }
+        },
+      ]
     }
-            source_definition_id = "88e1e91e-450a-4d2a-bd44-269802d502a9"
-            workspace_id = "4bb4f63c-969e-49a3-afa7-7dfb14cd66ae"
-        }
+  }
+  workspace_id = "8fc35354-57d2-4442-a8ff-977c6f814b5f"
+}
 ```
 
 <!-- schema generated by tfplugindocs -->
 ## Schema
 
 ### Required
 
-- `docker_image_tag` (String)
 - `source_definition` (Attributes) (see [below for nested schema](#nestedatt--source_definition))
-- `source_definition_id` (String)
+
+### Optional
+
+- `scope_id` (String)
+- `scope_type` (String) must be one of ["workspace", "organization"]
 - `workspace_id` (String)
 
 ### Read-Only
 
-- `exception_class_name` (String)
-- `exception_stack` (List of String)
-- `message` (String)
-- `validation_errors` (Attributes List) (see [below for nested schema](#nestedatt--validation_errors))
+- `custom` (Boolean) Default: false
+Whether the connector is custom or not
+- `docker_image_tag` (String)
+- `docker_repository` (String)
+- `documentation_url` (String)
+- `icon` (String)
+- `max_seconds_between_messages` (Number) Number of seconds allowed between 2 airbyte protocol messages. The source will timeout if this delay is reach
+- `name` (String)
+- `protocol_version` (String) The Airbyte Protocol version supported by the connector
+- `release_date` (String) The date when this connector was first released, in yyyy-mm-dd format.
+- `release_stage` (String) must be one of ["alpha", "beta", "generally_available", "custom"]
+- `resource_requirements` (Attributes) actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level. (see [below for nested schema](#nestedatt--resource_requirements))
+- `source_definition_id` (String)
+- `source_type` (String) must be one of ["api", "file", "database", "custom"]
+- `support_level` (String) must be one of ["community", "certified", "none"]
 
 <a id="nestedatt--source_definition"></a>
 ### Nested Schema for `source_definition`
@@ -102,7 +116,7 @@ Optional:
 
 Required:
 
-- `job_type` (String) must be one of [get_spec, check_connection, discover_schema, sync, reset_connection, connection_updater, replicate]
+- `job_type` (String) must be one of ["get_spec", "check_connection", "discover_schema", "sync", "reset_connection", "connection_updater", "replicate"]
 enum that describes the different types of jobs that the platform runs.
 - `resource_requirements` (Attributes) optional resource requirements to run workers (blank for unbounded allocations) (see [below for nested schema](#nestedatt--source_definition--resource_requirements--job_specific--resource_requirements))
 
@@ -120,13 +134,42 @@ Optional:
 
 
 
-<a id="nestedatt--validation_errors"></a>
-### Nested Schema for `validation_errors`
+<a id="nestedatt--resource_requirements"></a>
+### Nested Schema for `resource_requirements`
+
+Read-Only:
+
+- `default` (Attributes) optional resource requirements to run workers (blank for unbounded allocations) (see [below for nested schema](#nestedatt--resource_requirements--default))
+- `job_specific` (Attributes List) (see [below for nested schema](#nestedatt--resource_requirements--job_specific))
+
+<a id="nestedatt--resource_requirements--default"></a>
+### Nested Schema for `resource_requirements.default`
+
+Read-Only:
+
+- `cpu_limit` (String)
+- `cpu_request` (String)
+- `memory_limit` (String)
+- `memory_request` (String)
+
+
+<a id="nestedatt--resource_requirements--job_specific"></a>
+### Nested Schema for `resource_requirements.job_specific`
+
+Read-Only:
+
+- `job_type` (String) must be one of ["get_spec", "check_connection", "discover_schema", "sync", "reset_connection", "connection_updater", "replicate"]
+enum that describes the different types of jobs that the platform runs.
+- `resource_requirements` (Attributes) optional resource requirements to run workers (blank for unbounded allocations) (see [below for nested schema](#nestedatt--resource_requirements--job_specific--resource_requirements))
+
+<a id="nestedatt--resource_requirements--job_specific--resource_requirements"></a>
+### Nested Schema for `resource_requirements.job_specific.resource_requirements`
 
 Read-Only:
 
-- `invalid_value` (String)
-- `message` (String)
-- `property_path` (String)
+- `cpu_limit` (String)
+- `cpu_request` (String)
+- `memory_limit` (String)
+- `memory_request` (String)