Skip to content

Commit

Permalink
update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
aballiet committed Nov 17, 2023
1 parent 6f36487 commit a094e90
Show file tree
Hide file tree
Showing 7 changed files with 68 additions and 50 deletions.
36 changes: 36 additions & 0 deletions docs/data-sources/airbyte_source.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "airbyte_source Data Source - aballiet-terraform-provider-airbyte-oss"
subcategory: ""
description: |-
Source DataSource
---

# airbyte_source (Data Source)

Source DataSource

## Example Usage

```terraform
data "airbyte_source" "my_source" {
source_id = "f1402c7e-2666-4964-b1e5-4ee038120ec2"
}
```

<!-- schema generated by tfplugindocs -->
## Schema

### Required

- `source_id` (String)

### Read-Only

- `icon` (String)
- `name` (String)
- `source_definition_id` (String)
- `source_name` (String)
- `workspace_id` (String)


12 changes: 4 additions & 8 deletions docs/data-sources/airbyte_source_schema.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,10 @@ SourceSchema DataSource

```terraform
data "airbyte_source_schema" "my_sourceschema" {
connection_id = "f1402c7e-2666-4964-b1e5-4ee038120ec2"
connection_id = "2ac978db-e310-4dc6-a194-f112ed73d68a"
disable_cache = true
notify_schema_change = true
source_id = "c978dbe3-10dc-4621-94f1-12ed73d68ab9"
notify_schema_change = false
source_id = "280eecd9-6c08-4a64-ae27-6dd0ab8d096c"
}
```

Expand Down Expand Up @@ -89,17 +89,13 @@ Read-Only:
Read-Only:

- `default_cursor_field` (List of String) Path to the field that will be used to determine if a record is new or modified since the last sync. If not provided by the source, the end user will have to specify the comparable themselves.
- `json_schema` (Attributes) Stream schema using Json Schema specs. (see [below for nested schema](#nestedatt--catalog--streams--stream--json_schema))
- `json_schema` (Map of String) Stream schema using Json Schema specs.
- `name` (String) Stream's name.
- `namespace` (String) Optional Source-defined namespace. Airbyte streams from the same sources should have the same namespace. Currently only used by JDBC destinations to determine what schema to write to.
- `source_defined_cursor` (Boolean) If the source defines the cursor field, then any other cursor field inputs will be ignored. If it does not, either the user_provided one is used, or the default one is used as a backup.
- `source_defined_primary_key` (List of List of String) If the source defines the primary key, paths to the fields that will be used as a primary key. If not provided by the source, the end user will have to specify the primary key themselves.
- `supported_sync_modes` (List of String)

<a id="nestedatt--catalog--streams--stream--json_schema"></a>
### Nested Schema for `catalog.streams.stream.supported_sync_modes`





Expand Down
40 changes: 13 additions & 27 deletions docs/resources/airbyte_connection.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,23 +32,19 @@ resource "airbyte_connection" "my_connection" {
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
time_unit = "minutes"
units = 9
}
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"
source_catalog_id = "aa5e6b8d-d995-4b85-b38d-b9804e4cb5e1"
source_id = "451ef85f-dd64-4863-9632-1f097ee8d406"
status = "inactive"
sync_catalog = {
streams = [
Expand All @@ -58,7 +54,7 @@ resource "airbyte_connection" "my_connection" {
cursor_field = [
"...",
]
destination_sync_mode = "append_dedup"
destination_sync_mode = "overwrite"
field_selection_enabled = true
primary_key = [
[
Expand All @@ -73,17 +69,20 @@ resource "airbyte_connection" "my_connection" {
]
},
]
suggested = false
suggested = true
sync_mode = "incremental"
}
stream = {
default_cursor_field = [
"...",
]
json_schema = {}
name = "Ms. June Bins"
json_schema = {
"Sausages" = "{ \"see\": \"documentation\" }"
"East" = "{ \"see\": \"documentation\" }"
}
name = "Mildred Lueilwitz"
namespace = "...my_namespace..."
source_defined_cursor = true
source_defined_cursor = false
source_defined_primary_key = [
[
"...",
Expand Down Expand Up @@ -123,7 +122,6 @@ Used when namespaceDefinition is 'customformat'. If blank then behaves like name
- `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"]
determine how the schedule data should be interpreted
Expand All @@ -147,15 +145,6 @@ Optional:
- `memory_request` (String)


<a id="nestedatt--schedule"></a>
### Nested Schema for `schedule`

Required:

- `time_unit` (String) must be one of ["minutes", "hours", "days", "weeks", "months"]
- `units` (Number)


<a id="nestedatt--schedule_data"></a>
### Nested Schema for `schedule_data`

Expand Down Expand Up @@ -235,13 +224,10 @@ Required:
Optional:

- `default_cursor_field` (List of String) Path to the field that will be used to determine if a record is new or modified since the last sync. If not provided by the source, the end user will have to specify the comparable themselves.
- `json_schema` (Attributes) Stream schema using Json Schema specs. (see [below for nested schema](#nestedatt--sync_catalog--streams--stream--json_schema))
- `json_schema` (Map of String) Stream schema using Json Schema specs.
- `namespace` (String) Optional Source-defined namespace. Airbyte streams from the same sources should have the same namespace. Currently only used by JDBC destinations to determine what schema to write to.
- `source_defined_cursor` (Boolean) If the source defines the cursor field, then any other cursor field inputs will be ignored. If it does not, either the user_provided one is used, or the default one is used as a backup.
- `source_defined_primary_key` (List of List of String) If the source defines the primary key, paths to the fields that will be used as a primary key. If not provided by the source, the end user will have to specify the primary key themselves.
- `supported_sync_modes` (List of String)

<a id="nestedatt--sync_catalog--streams--stream--json_schema"></a>
### Nested Schema for `sync_catalog.streams.stream.supported_sync_modes`


6 changes: 3 additions & 3 deletions docs/resources/airbyte_source.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,10 @@ Source Resource
```terraform
resource "airbyte_source" "my_source" {
connection_configuration = { "user" : "charles" }
name = "Austin Stracke"
name = "Ervin Renner DVM"
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"
source_definition_id = "95525dbf-b016-4861-8013-3587515722b6"
workspace_id = "25efa1bb-fa8d-4645-b719-d133279f15ad"
}
```

Expand Down
10 changes: 5 additions & 5 deletions docs/resources/airbyte_source_definition.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,13 @@ SourceDefinition Resource

```terraform
resource "airbyte_source_definition" "my_sourcedefinition" {
scope_id = "ad8bb3fe-33fa-4c92-96cf-878498930f77"
scope_id = "8bb3fe33-fac9-4256-8f87-8498930f77ed"
scope_type = "organization"
source_definition = {
name = "Rex Becker"
name = "Holly Hane"
docker_repository = "...my_docker_repository..."
docker_image_tag = "...my_docker_image_tag..."
documentation_url = "http://yearly-hive.name"
documentation_url = "http://moist-escalator.name"
icon = "...my_icon..."
resource_requirements = {
default = {
Expand All @@ -31,7 +31,7 @@ resource "airbyte_source_definition" "my_sourcedefinition" {
}
job_specific = [
{
job_type = "discover_schema"
job_type = "replicate"
resource_requirements = {
cpu_request = "...my_cpu_request..."
cpu_limit = "...my_cpu_limit..."
Expand All @@ -42,7 +42,7 @@ resource "airbyte_source_definition" "my_sourcedefinition" {
]
}
}
workspace_id = "8fc35354-57d2-4442-a8ff-977c6f814b5f"
workspace_id = "c3535457-d244-4268-bf97-7c6f814b5f1d"
}
```

Expand Down
8 changes: 4 additions & 4 deletions docs/resources/airbyte_source_definition_manifest.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,11 @@ resource "airbyte_source_definition_manifest" "my_sourcedefinitionmanifest" {
description = "...my_description..."
manifest = {}
spec = {}
version = 1
version = 8
}
set_as_active_manifest = false
source_definition_id = "c406d3e6-067c-40fa-a27e-0571d07b12f6"
workspace_id = "07aea75f-355b-445b-8e45-de0c2038bc3c"
set_as_active_manifest = true
source_definition_id = "06d3e606-7c0f-4aa2-be05-71d07b12f607"
workspace_id = "aea75f35-5b45-4bce-85de-0c2038bc3c12"
}
```

Expand Down
6 changes: 3 additions & 3 deletions docs/resources/airbyte_workspace.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,10 @@ Workspace Resource
```terraform
resource "airbyte_workspace" "my_workspace" {
anonymous_data_collection = false
default_geography = "auto"
default_geography = "us"
display_setup_wizard = false
email = "Cecelia_White16@yahoo.com"
name = "Miss Tonya Hamill Jr."
email = "Ole0@hotmail.com"
name = "Jill Carroll Jr."
news = false
notifications = [
{
Expand Down

0 comments on commit a094e90

Please sign in to comment.