feat(connectors/clickup-api): add /user and /team endpoint configs

Author: josix

airbyte-integrations/connectors/source-clickup-api/acceptance-test-config.yml

@@ -21,10 +21,10 @@ tests:
   #        extra_fields: no
   #        exact_order: no
   #        extra_records: yes
-  incremental: # TODO if your connector does not implement incremental sync, remove this block
-    - config_path: "secrets/config.json"
-      configured_catalog_path: "integration_tests/configured_catalog.json"
-      future_state_path: "integration_tests/abnormal_state.json"
+  # incremental: # TODO if your connector does not implement incremental sync, remove this block
+  #   - config_path: "secrets/config.json"
+  #     configured_catalog_path: "integration_tests/configured_catalog.json"
+  #     future_state_path: "integration_tests/abnormal_state.json"
   full_refresh:
     - config_path: "secrets/config.json"
       configured_catalog_path: "integration_tests/configured_catalog.json"

airbyte-integrations/connectors/source-clickup-api/integration_tests/catalog.json

@@ -2,7 +2,7 @@
   "streams": [
     {
       "stream": {
-        "name": "customers",
+        "name": "user",
         "json_schema": {},
         "supported_sync_modes": ["full_refresh"]
       },
@@ -11,12 +11,12 @@
     },
     {
       "stream": {
-        "name": "employees",
+        "name": "team",
         "json_schema": {},
-        "supported_sync_modes": ["full_refresh", "incremental"]
+        "supported_sync_modes": ["full_refresh"]
       },
-      "sync_mode": "incremental",
-      "destination_sync_mode": "append"
+      "sync_mode": "full_refresh",
+      "destination_sync_mode": "overwrite"
     }
   ]
 }

airbyte-integrations/connectors/source-clickup-api/integration_tests/configured_catalog.json

@@ -1,3 +1,3 @@
 {
-  "todo-wrong-field": "this should be an incomplete config file, used in standard tests"
+  "api_token": "this should be an incomplete config file, used in standard tests"
 }

airbyte-integrations/connectors/source-clickup-api/integration_tests/invalid_config.json

@@ -1,3 +1 @@
-{
-  "fix-me": "TODO"
-}
+{ "api_token": "abcdefgh" }

airbyte-integrations/connectors/source-clickup-api/integration_tests/sample_config.json

@@ -14,12 +14,13 @@ definitions:
     name: "{{ options['name'] }}"
     http_method: "GET"
     authenticator:
-      type: BearerAuthenticator
-      api_token: "{{ config['api_key'] }}"
+      type: ApiKeyAuthenticator
+      header: "Authorization"
+      api_token: "{{ config['api_token'] }}"
   retriever:
     type: SimpleRetriever
     $options:
-      url_base: TODO "your_api_base_url"
+      url_base: "https://api.clickup.com/api/v2"
     name: "{{ options['name'] }}"
     primary_key: "{{ options['primary_key'] }}"
     record_selector:
@@ -30,15 +31,24 @@ definitions:
 streams:
   - type: DeclarativeStream
     $options:
-      name: "customers"
-    primary_key: "id"
+      name: "user"
     schema_loader:
       $ref: "*ref(definitions.schema_loader)"
     retriever:
       $ref: "*ref(definitions.retriever)"
       requester:
         $ref: "*ref(definitions.requester)"
-        path: TODO "your_endpoint_path"
+        path: "/user"
+  - type: DeclarativeStream
+    $options:
+      name: "team"
+    schema_loader:
+      $ref: "*ref(definitions.schema_loader)"
+    retriever:
+      $ref: "*ref(definitions.retriever)"
+      requester:
+        $ref: "*ref(definitions.requester)"
+        path: "/team"
 check:
   type: CheckStream
-  stream_names: ["customers"]
+  stream_names: ["user", "team"]

airbyte-integrations/connectors/source-clickup-api/source_clickup_api/clickup_api.yaml

@@ -0,0 +1,46 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "teams": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": ["null", "string"]
+          },
+          "name": {
+            "type": ["null", "string"]
+          },
+          "color": {
+            "type": ["null", "string"]
+          },
+          "avatar": {
+            "type": ["null", "string"]
+          },
+          "members": {
+            "type": "array",
+            "items": {
+              "type": "object",
+              "properties": {
+                "id": {
+                  "type": ["null", "integer"]
+                },
+                "username": {
+                  "type": ["null", "string"]
+                },
+                "color": {
+                  "type": ["null", "string"]
+                },
+                "profilePicture": {
+                  "type": ["null", "string"]
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+}

airbyte-integrations/connectors/source-clickup-api/source_clickup_api/schemas/TODO.md

@@ -0,0 +1,23 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "user": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": ["null", "integer"]
+        },
+        "username": {
+          "type": ["null", "string"]
+        },
+        "color": {
+          "type": ["null", "string"]
+        },
+        "profilePicture": {
+          "type": ["null", "string"]
+        }
+      }
+    }
+  }
+}

airbyte-integrations/connectors/source-clickup-api/source_clickup_api/schemas/customers.json

@@ -4,10 +4,13 @@ connectionSpecification:
   title: ClickUp Api Spec
   type: object
   required:
-    - TODO
+    - api_token
   additionalProperties: true
   properties:
     # 'TODO: This schema defines the configuration required for the source. This usually involves metadata such as database and/or authentication information.':
-    TODO:
+    api_token:
       type: string
-      description: describe me
+      description: >-
+        Every ClickUp API call required authentication. This field is your personal API token. See <a
+        href="https://clickup.com/api/developer-portal/authentication/#personal-token">here</a>.
+      airbyte_secret: true