🎉 Source Tiktok Marketing - updated specs description (#12435)

* updated seed files * updated change history * updated docs * updated connector version * auto-bump connector version * updated source specs Co-authored-by: Octavia Squidington III <[email protected]>
airbytehq · May 2, 2022 · 915573e · 915573e
1 parent 764b7d9
commit 915573e
Show file tree

Hide file tree

Showing 6 changed files with 29 additions and 33 deletions.
diff --git a/airbyte-config/init/src/main/resources/seed/source_definitions.yaml b/airbyte-config/init/src/main/resources/seed/source_definitions.yaml
@@ -799,7 +799,7 @@
 - name: TikTok Marketing
   sourceDefinitionId: 4bfac00d-ce15-44ff-95b9-9e3c3e8fbd35
   dockerRepository: airbyte/source-tiktok-marketing
-  dockerImageTag: 0.1.7
+  dockerImageTag: 0.1.8
   documentationUrl: https://docs.airbyte.io/integrations/sources/tiktok-marketing
   icon: tiktok.svg
   sourceType: api

diff --git a/airbyte-config/init/src/main/resources/seed/source_specs.yaml b/airbyte-config/init/src/main/resources/seed/source_specs.yaml
@@ -8666,7 +8666,7 @@
     supportsNormalization: false
     supportsDBT: false
     supported_destination_sync_modes: []
-- dockerImage: "airbyte/source-tiktok-marketing:0.1.7"
+- dockerImage: "airbyte/source-tiktok-marketing:0.1.8"
   spec:
     documentationUrl: "https://docs.airbyte.io/integrations/sources/tiktok-marketing"
     changelogUrl: "https://docs.airbyte.io/integrations/sources/tiktok-marketing"
@@ -8700,7 +8700,7 @@
                 type: "string"
               access_token:
                 title: "Access Token"
-                description: "Long-term Authorized Access Token."
+                description: "The long-term authorized access token."
                 airbyte_secret: true
                 type: "string"
             required:
@@ -8726,7 +8726,7 @@
                 type: "string"
               access_token:
                 title: "Access Token"
-                description: "The Long-term Authorized Access Token."
+                description: "The long-term authorized access token."
                 airbyte_secret: true
                 type: "string"
             required:
@@ -8743,12 +8743,12 @@
                 type: "string"
               advertiser_id:
                 title: "Advertiser ID"
-                description: "The Advertiser ID  which generated for the developer's\
+                description: "The Advertiser ID which generated for the developer's\
                   \ Sandbox application."
                 type: "string"
               access_token:
                 title: "Access Token"
-                description: "The Long-term Authorized Access Token."
+                description: "The long-term authorized access token."
                 airbyte_secret: true
                 type: "string"
             required:
@@ -8757,17 +8757,16 @@
         start_date:
           title: "Start Date *"
           description: "The Start Date in format: YYYY-MM-DD. Any data before this\
-            \ date will not be replicated. If this parameter is not set, all data\
-            \ will be replicated."
+            \ date will not be replicated.If this parameter is not set, all data will\
+            \ be replicated."
           default: "2016-09-01"
           pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
           order: 1
           type: "string"
         report_granularity:
           title: "Report Granularity *"
-          description: "Which time granularity should be grouped by; for LIFETIME\
-            \ there will be no grouping. This option is used for reports' streams\
-            \ only."
+          description: "Grouping of your reports based on time. Lifetime will have\
+            \ no grouping. This option is used for reports' streams only."
           default: "DAY"
           enum:
           - "LIFETIME"

diff --git a/airbyte-integrations/connectors/source-tiktok-marketing/Dockerfile b/airbyte-integrations/connectors/source-tiktok-marketing/Dockerfile
@@ -32,5 +32,5 @@ COPY source_tiktok_marketing ./source_tiktok_marketing
 ENV AIRBYTE_ENTRYPOINT "python /airbyte/integration_code/main.py"
 ENTRYPOINT ["python", "/airbyte/integration_code/main.py"]
 
-LABEL io.airbyte.version=0.1.7
+LABEL io.airbyte.version=0.1.8
 LABEL io.airbyte.name=airbyte/source-tiktok-marketing
diff --git a/airbyte-integrations/connectors/source-tiktok-marketing/integration_tests/spec.json b/airbyte-integrations/connectors/source-tiktok-marketing/integration_tests/spec.json
@@ -10,8 +10,7 @@
         "default": {},
         "order": 0,
         "type": "object",
-        "oneOf": [
-          {
+        "oneOf": [{
             "title": "OAuth2.0",
             "type": "object",
             "properties": {
@@ -35,14 +34,13 @@
               },
               "access_token": {
                 "title": "Access Token",
-                "description": "Long-term Authorized Access Token.",
+                "description": "The long-term authorized access token.",
                 "airbyte_secret": true,
                 "type": "string"
               }
             },
             "required": ["app_id", "secret", "access_token"]
-          },
-          {
+          }, {
             "title": "Production Access Token",
             "type": "object",
             "properties": {
@@ -65,14 +63,13 @@
               },
               "access_token": {
                 "title": "Access Token",
-                "description": "The Long-term Authorized Access Token.",
+                "description": "The long-term authorized access token.",
                 "airbyte_secret": true,
                 "type": "string"
               }
             },
             "required": ["app_id", "secret", "access_token"]
-          },
-          {
+          }, {
             "title": "Sandbox Access Token",
             "type": "object",
             "properties": {
@@ -84,12 +81,12 @@
               },
               "advertiser_id": {
                 "title": "Advertiser ID",
-                "description": "The Advertiser ID  which generated for the developer's Sandbox application.",
+                "description": "The Advertiser ID which generated for the developer's Sandbox application.",
                 "type": "string"
               },
               "access_token": {
                 "title": "Access Token",
-                "description": "The Long-term Authorized Access Token.",
+                "description": "The long-term authorized access token.",
                 "airbyte_secret": true,
                 "type": "string"
               }
@@ -100,15 +97,15 @@
       },
       "start_date": {
         "title": "Start Date *",
-        "description": "The Start Date in format: YYYY-MM-DD. Any data before this date will not be replicated. If this parameter is not set, all data will be replicated.",
+        "description": "The Start Date in format: YYYY-MM-DD. Any data before this date will not be replicated.If this parameter is not set, all data will be replicated.",
         "default": "2016-09-01",
         "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$",
         "order": 1,
         "type": "string"
       },
       "report_granularity": {
         "title": "Report Granularity *",
-        "description": "Which time granularity should be grouped by; for LIFETIME there will be no grouping. This option is used for reports' streams only.",
+        "description": "Grouping of your reports based on time. Lifetime will have no grouping. This option is used for reports' streams only.",
         "default": "DAY",
         "enum": ["LIFETIME", "DAY", "HOUR"],
         "order": 2,

diff --git a/airbyte-integrations/connectors/source-tiktok-marketing/source_tiktok_marketing/spec.py b/airbyte-integrations/connectors/source-tiktok-marketing/source_tiktok_marketing/spec.py
@@ -23,7 +23,7 @@ class Config:
 
     secret: str = Field(title="Secret", description="The private key of the developer's application.", airbyte_secret=True)
 
-    access_token: str = Field(title="Access Token", description="Long-term Authorized Access Token.", airbyte_secret=True)
+    access_token: str = Field(title="Access Token", description="The long-term authorized access token.", airbyte_secret=True)
 
 
 class SandboxEnvSpec(BaseModel):
@@ -34,10 +34,10 @@ class Config:
 
     # it is string because UI has the bug https://github.com/airbytehq/airbyte/issues/6875
     advertiser_id: str = Field(
-        title="Advertiser ID", description="The Advertiser ID  which generated for the developer's Sandbox application."
+        title="Advertiser ID", description="The Advertiser ID which generated for the developer's Sandbox application."
     )
 
-    access_token: str = Field(title="Access Token", description="The Long-term Authorized Access Token.", airbyte_secret=True)
+    access_token: str = Field(title="Access Token", description="The long-term authorized access token.", airbyte_secret=True)
 
 
 class ProductionEnvSpec(BaseModel):
@@ -50,7 +50,7 @@ class Config:
     app_id: str = Field(description="The App ID applied by the developer.", title="App ID")
     secret: str = Field(title="Secret", description="The private key of the developer application.", airbyte_secret=True)
 
-    access_token: str = Field(title="Access Token", description="The Long-term Authorized Access Token.", airbyte_secret=True)
+    access_token: str = Field(title="Access Token", description="The long-term authorized access token.", airbyte_secret=True)
 
 
 class SourceTiktokMarketingSpec(BaseModel):
@@ -65,15 +65,14 @@ class Config:
         title="Start Date *",
         default=DEFAULT_START_DATE,
         pattern="^[0-9]{4}-[0-9]{2}-[0-9]{2}$",
-        description="The Start Date in format: YYYY-MM-DD. Any data before this date will not be replicated. "
+        description="The Start Date in format: YYYY-MM-DD. Any data before this date will not be replicated."
         "If this parameter is not set, all data will be replicated.",
         order=1,
     )
 
     report_granularity: str = Field(
         title="Report Granularity *",
-        description="Which time granularity should be grouped by; for LIFETIME there will be no grouping. "
-        "This option is used for reports' streams only.",
+        description="Grouping of your reports based on time. Lifetime will have no grouping. This option is used for reports' streams only.",
         default=ReportGranularity.default().value,
         enum=[g.value for g in ReportGranularity],
         order=2,

diff --git a/docs/integrations/sources/tiktok-marketing.md b/docs/integrations/sources/tiktok-marketing.md
@@ -3,6 +3,8 @@
 This page guides you through the process of setting up the TikTok Marketing source connector.
 
 ## Prerequisites
+* Start date
+* Report Granularity (LIFETIME, DAY, HOUR)
 
 For Production environment:
 * Access token 
@@ -13,8 +15,6 @@ For Sandbox environment:
 * Access token 
 * Advertiser ID
 
-* Start date
-* Report Granularity (LIFETIME, DAY, HOUR)
 
 ## Step 1: Set up TikTok
 
@@ -521,6 +521,7 @@ The connector is restricted by [requests limitation](https://ads.tiktok.com/mark
 
 | Version | Date       | Pull Request                                             | Subject                                                                                       |
 |:--------|:-----------|:---------------------------------------------------------|:----------------------------------------------------------------------------------------------|
+| 0.1.8   | 2022-04-28 | [12435](https://github.com/airbytehq/airbyte/pull/12435) | updated spec descriptions                                                                     |
 | 0.1.7   | 2022-04-27 | [12380](https://github.com/airbytehq/airbyte/pull/12380) | fixed spec descriptions and documentation                                                     |
 | 0.1.6   | 2022-04-19 | [11378](https://github.com/airbytehq/airbyte/pull/11378) | updated logic for stream initializations, fixed errors in schemas, updated SAT and unit tests |
 | 0.1.5   | 2022-02-17 | [10398](https://github.com/airbytehq/airbyte/pull/10398) | Add Audience reports                                                                          |