Source ClickUp: Optional Include Closed Tasks (#23951)

* acceptance test fix ignored_fields team dict

* added option to include or exclude closed tasks

* added change log

* delete doc file and use correct one

* update manifest version

* auto-bump connector version

---------

Co-authored-by: marcosmarxm <marcosmarxm@gmail.com>
Co-authored-by: Marcos Marx <marcosmarxm@users.noreply.github.com>
Co-authored-by: Octavia Squidington III <octavia-squidington-iii@users.noreply.github.com>

airbyte-config/init/src/main/resources/seed/source_definitions.yaml

@@ -292,7 +292,7 @@
 - name: ClickUp
   sourceDefinitionId: 311a7a27-3fb5-4f7e-8265-5e4afe258b66
   dockerRepository: airbyte/source-clickup-api
-  dockerImageTag: 0.1.0
+  dockerImageTag: 0.1.1
   documentationUrl: https://docs.airbyte.com/integrations/sources/click-up
   icon: clickup.svg
   sourceType: api

airbyte-config/init/src/main/resources/seed/source_specs.yaml

@@ -2491,7 +2491,7 @@
     supportsNormalization: false
     supportsDBT: false
     supported_destination_sync_modes: []
-- dockerImage: "airbyte/source-clickup-api:0.1.0"
+- dockerImage: "airbyte/source-clickup-api:0.1.1"
   spec:
     documentationUrl: "https://docsurl.com"
     connectionSpecification:
@@ -2528,6 +2528,13 @@
           description: "The ID of your list in your folder. Retrieve it from the `/folder/{folder_id}/list`\
             \ of the ClickUp API. See <a href=\"https://clickup.com/api/clickupreference/operation/GetLists/\"\
             >here</a>."
+        include_closed_tasks:
+          title: "Include Closed Tasks"
+          type: "boolean"
+          default: false
+          description: "Include or exclude closed tasks. By default, they are excluded.\
+            \ See <a https://clickup.com/api/clickupreference/operation/GetTasks/#!in=query&path=include_closed&t=request\"\
+            >here</a>."
     supportsNormalization: false
     supportsDBT: false
     supported_destination_sync_modes: []

airbyte-integrations/connectors/source-clickup-api/Dockerfile

@@ -34,5 +34,5 @@ COPY source_clickup_api ./source_clickup_api
 ENV AIRBYTE_ENTRYPOINT "python /airbyte/integration_code/main.py"
 ENTRYPOINT ["python", "/airbyte/integration_code/main.py"]
 
-LABEL io.airbyte.version=0.1.0
+LABEL io.airbyte.version=0.1.1
 LABEL io.airbyte.name=airbyte/source-clickup-api

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

@@ -17,7 +17,11 @@ acceptance_tests:
     - config_path: secrets/config.json
       configured_catalog_path: integration_tests/configured_catalog.json
       ignored_fields:
-        "team": ["members", "last_active"]
+        team:
+          - name: members
+            bypass_reason: ignore changing value in full_refresh of acceptance-tests
+          - name: last_active
+            bypass_reason: ignore changing value in full_refresh of acceptance-tests
   spec:
     tests:
     - spec_path: source_clickup_api/spec.yaml

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

@@ -109,6 +109,8 @@ streams:
       requester:
         $ref: "#/definitions/requester"
         path: "list/{{ config['list_id'] }}/task"
+        request_parameters:
+          include_closed: "{{ config['include_closed_tasks']|lower }}"
       record_selector:
         $ref: "#/definitions/arraySelector"
       paginator:

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

@@ -34,3 +34,10 @@ connectionSpecification:
       description: >-
         The ID of your list in your folder. Retrieve it from the `/folder/{folder_id}/list` of the ClickUp API. See <a
         href="https://clickup.com/api/clickupreference/operation/GetLists/">here</a>.
+    include_closed_tasks:
+      title: Include Closed Tasks
+      type: boolean
+      default: false
+      description: >-
+        Include or exclude closed tasks. By default, they are excluded. See <a
+        https://clickup.com/api/clickupreference/operation/GetTasks/#!in=query&path=include_closed&t=request">here</a>.

connectors.md

@@ -37,7 +37,7 @@
 | **Chargify** | <img alt="Chargify icon" src="https://raw.githubusercontent.com/airbytehq/airbyte/master/airbyte-config/init/src/main/resources/icons/chargify.svg" height="30" height="30"/> | Source | airbyte/source-chargify:0.1.0 | alpha | [link](https://docs.airbyte.com/integrations/sources/chargify) | [code](https://github.com/airbytehq/airbyte/tree/master/airbyte-integrations/connectors/source-chargify) | <small>`9b2d3607-7222-4709-9fa2-c2abdebbdd88`</small> |
 | **Chartmogul** | <img alt="Chartmogul icon" src="https://raw.githubusercontent.com/airbytehq/airbyte/master/airbyte-config/init/src/main/resources/icons/chartmogul.svg" height="30" height="30"/> | Source | airbyte/source-chartmogul:0.2.1 | beta | [link](https://docs.airbyte.com/integrations/sources/chartmogul) | [code](https://github.com/airbytehq/airbyte/tree/master/airbyte-integrations/connectors/source-chartmogul) | <small>`b6604cbd-1b12-4c08-8767-e140d0fb0877`</small> |
 | **ClickHouse** | <img alt="ClickHouse icon" src="https://raw.githubusercontent.com/airbytehq/airbyte/master/airbyte-config/init/src/main/resources/icons/clickhouse.svg" height="30" height="30"/> | Source | airbyte/source-clickhouse:0.1.16 | alpha | [link](https://docs.airbyte.com/integrations/sources/clickhouse) | [code](https://github.com/airbytehq/airbyte/tree/master/airbyte-integrations/connectors/source-clickhouse) | <small>`bad83517-5e54-4a3d-9b53-63e85fbd4d7c`</small> |
-| **ClickUp** | <img alt="ClickUp icon" src="https://raw.githubusercontent.com/airbytehq/airbyte/master/airbyte-config/init/src/main/resources/icons/clickup.svg" height="30" height="30"/> | Source | airbyte/source-clickup-api:0.1.0 | alpha | [link](https://docs.airbyte.com/integrations/sources/click-up) | [code](https://github.com/airbytehq/airbyte/tree/master/airbyte-integrations/connectors/source-clickup-api) | <small>`311a7a27-3fb5-4f7e-8265-5e4afe258b66`</small> |
+| **ClickUp** | <img alt="ClickUp icon" src="https://raw.githubusercontent.com/airbytehq/airbyte/master/airbyte-config/init/src/main/resources/icons/clickup.svg" height="30" height="30"/> | Source | airbyte/source-clickup-api:0.1.1 | alpha | [link](https://docs.airbyte.com/integrations/sources/click-up) | [code](https://github.com/airbytehq/airbyte/tree/master/airbyte-integrations/connectors/source-clickup-api) | <small>`311a7a27-3fb5-4f7e-8265-5e4afe258b66`</small> |
 | **Clockify** | <img alt="Clockify icon" src="https://raw.githubusercontent.com/airbytehq/airbyte/master/airbyte-config/init/src/main/resources/icons/clockify.svg" height="30" height="30"/> | Source | airbyte/source-clockify:0.1.0 | alpha | [link](https://docs.airbyte.com/integrations/sources/clockify) | [code](https://github.com/airbytehq/airbyte/tree/master/airbyte-integrations/connectors/source-clockify) | <small>`e71aae8a-5143-11ed-bdc3-0242ac120002`</small> |
 | **Close.com** | <img alt="Close.com icon" src="https://raw.githubusercontent.com/airbytehq/airbyte/master/airbyte-config/init/src/main/resources/icons/close.svg" height="30" height="30"/> | Source | airbyte/source-close-com:0.2.1 | beta | [link](https://docs.airbyte.com/integrations/sources/close-com) | [code](https://github.com/airbytehq/airbyte/tree/master/airbyte-integrations/connectors/source-close-com) | <small>`dfffecb7-9a13-43e9-acdc-b92af7997ca9`</small> |
 | **Cockroachdb** | <img alt="Cockroachdb icon" src="https://raw.githubusercontent.com/airbytehq/airbyte/master/airbyte-config/init/src/main/resources/icons/cockroachdb.svg" height="30" height="30"/> | Source | airbyte/source-cockroachdb:0.1.21 | alpha | [link](https://docs.airbyte.com/integrations/sources/cockroachdb) | [code](https://github.com/airbytehq/airbyte/tree/master/airbyte-integrations/connectors/source-cockroachdb) | <small>`9fa5862c-da7c-11eb-8d19-0242ac130003`</small> |

docs/integrations/sources/clickup-api.md

@@ -1,9 +1,60 @@
-# ClickUP API
+# ClickUp API
 
-The Airbyte Source for [ClickUP API](https://clickup.com/api/)
+## Sync overview
+
+This source can sync data from [ClickUp API](https://clickup.com/api/). Currently, this connector only supports full refresh syncs. That is, every time a sync is run, all the records are fetched from the source.
+
+
+### Output schema
+
+This source is capable of syncing the following streams:
+
+* [`user`](https://clickup.com/api/clickupreference/operation/GetAuthorizedUser/)
+* [`teams`](https://clickup.com/api/clickupreference/operation/GetAuthorizedTeams/)
+* [`spaces`](https://clickup.com/api/clickupreference/operation/GetSpaces/)
+* [`folders`](https://clickup.com/api/clickupreference/operation/GetFolders/)
+* [`lists`](https://clickup.com/api/clickupreference/operation/GetLists/)
+* [`tasks`](https://clickup.com/api/clickupreference/operation/GetTasks)
+
+
+### Features
+
+| Feature           | Supported? \(Yes/No\) | Notes                                                   |
+|:------------------|:----------------------|:--------------------------------------------------------|
+| Full Refresh Sync | Yes                   |                                                         |
+| Incremental Sync  | No                    |                                                         |
+
+### Performance considerations
+
+The ClickUp API enforces request rate limits per token. The rate limits are depending on your workplace plan. See [here](https://clickup.com/api/developer-portal/rate-limits/).
+
+## Getting started
+
+### Requirements
+
+1. Generate an API key from [ClickUp](https://clickup.com/). See [here](https://clickup.com/api/developer-portal/authentication/#generate-your-personal-api-token).
+
+### Setup guide
+
+The following fields are required fields for the connector to work:
+
+* `api_token`: Your ClickUp API Token.
+
+Here are some optional fields for different streams:
+
+* `team_id`: Your team ID in your ClickUp workspace. It is required for `space` stream.
+
+* `space_id`: Your space ID in your ClickUp workspace. It is required for `folder` stream.
+
+* `folder_id`: Your folder ID in your ClickUp space. It is required for `list` stream.
+
+* `list_id`: Your list ID in your folder of space. It is required for `task` stream.
+
+* `Include Closed Tasks`: Toggle to include or exclude closed tasks. By default, they are excluded.
 
 ## Changelog
 
-| Version | Date       | Pull Request                                             | Subject                |
-| :------ | :--------- | :------------------------------------------------------- | :--------------------- |
-| 0.1.0   | 2022-11-13 | [17770](https://github.com/airbytehq/airbyte/pull/17770) | 🎉 New Source: ClickUp |
+| Version | Date       | Pull Request                                                 | Subject                           |
+|:--------|:-----------|:-------------------------------------------------------------|:----------------------------------|
+| 0.1.1   | 2023-02-10 | [23951](https://github.com/airbytehq/airbyte/pull/23951)     | Add optional include Closed Tasks |
+| 0.1.0   | 2022-11-07 | [17770](https://github.com/airbytehq/airbyte/pull/17770)     | New source                        |