1
0
mirror of synced 2026-01-29 04:02:20 -05:00
Files
airbyte/airbyte-integrations/connectors/source-clickup-api/source_clickup_api/spec.yaml
Josix 07af2ff4bf 🎉 New Source: ClickUp (#17770)
* feat(connectors): add source clickup api template

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

* docs(clickup-connectors): add clickup source doc

* feat: add tasks stream and list stream to ClickUp API

* feat: add space stream and folder stream to clikcup api

* feat: update acceptance-test-config.yml w/ version in 0.2.12

459856b73c/airbyte-integrations/bases/source-acceptance-test (migrating-acceptance-test-configyml-to-latest-configuration-format)

* docs: add descripiton for optional configs fields

* fix: fix list.json schema

* fix: add ignore_fields to ignore changing value in full_refresh of acceptance-tests

* add clickup to source def

* auto-bump connector version

Co-authored-by: marcosmarxm <marcosmarxm@gmail.com>
Co-authored-by: Octavia Squidington III <octavia-squidington-iii@users.noreply.github.com>
Co-authored-by: Marcos Marx <marcosmarxm@users.noreply.github.com>
2022-11-13 17:41:23 -03:00

37 lines
1.7 KiB
YAML

documentationUrl: https://docsurl.com
connectionSpecification:
$schema: http://json-schema.org/draft-07/schema#
title: ClickUp Api Spec
type: object
required:
- 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.':
api_token:
type: string
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
team_id:
type: string
description: >-
The ID of your team in ClickUp. Retrieve it from the `/team` of the ClickUp API. See <a
href="https://clickup.com/api/clickupreference/operation/GetAuthorizedTeams/">here</a>.
space_id:
type: string
description: >-
The ID of your space in your workspace. Retrieve it from the `/team/{team_id}/space` of the ClickUp API. See <a
href="https://clickup.com/api/clickupreference/operation/GetSpaces/">here</a>.
folder_id:
type: string
description: >-
The ID of your folder in your space. Retrieve it from the `/space/{space_id}/folder` of the ClickUp API. See <a
href="https://clickup.com/api/clickupreference/operation/GetFolders/">here</a>.
list_id:
type: string
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>.