source-circleci contribution from btkcodedev (#46249)
Co-authored-by: Octavia Squidington III <octavia-squidington-iii@users.noreply.github.com>
This commit is contained in:
49
docs/integrations/sources/circleci.md
Normal file
49
docs/integrations/sources/circleci.md
Normal file
@@ -0,0 +1,49 @@
|
||||
# Circleci
|
||||
This directory contains the manifest-only connector for [`source-circleci`](https://app.circleci.com/).
|
||||
|
||||
## Documentation reference:
|
||||
- Visit `https://circleci.com/docs/api/v1/index.html` for V1 API documentation
|
||||
- Visit `https://circleci.com/docs/api/v2/index.html` for V2 API documentation
|
||||
|
||||
## Authentication setup
|
||||
`CircleCI` uses api key authentication, Visit `https://app.circleci.com/settings/user/tokens` for getting your api keys.
|
||||
|
||||
## Configuration
|
||||
|
||||
| Input | Type | Description | Default Value |
|
||||
|-------|------|-------------|---------------|
|
||||
| `api_key` | `string` | API Key. | |
|
||||
| `org_id` | `string` | Organization ID. The org ID found in `https://app.circleci.com/settings/organization/circleci/xxxxx/overview` | |
|
||||
| `start_date` | `string` | Start date. | |
|
||||
| `project_id` | `string` | Project ID found in the project settings. | |
|
||||
| `job_id` | `string` | Job ID for fetching information found in URL. | |
|
||||
| `workflow_id` | `string` | Workflow ID of a project pipeline. | |
|
||||
| `workflow_name` | `string` | Workflow name for fetching information. | |
|
||||
| `job_number` | `string` | Job Number of the workflow. | `2` |
|
||||
|
||||
## Streams
|
||||
| Stream Name | Primary Key | Pagination | Supports Full Sync | Supports Incremental |
|
||||
|-------------|-------------|------------|---------------------|----------------------|
|
||||
| context | id | DefaultPaginator | ✅ | ✅ |
|
||||
| self_ids | id | DefaultPaginator | ✅ | ❌ |
|
||||
| self_collaborations | id | DefaultPaginator | ✅ | ❌ |
|
||||
| me | analytics_id | DefaultPaginator | ✅ | ✅ |
|
||||
| projects | vcs_url | DefaultPaginator | ✅ | ❌ |
|
||||
| pipelines | id | DefaultPaginator | ✅ | ✅ |
|
||||
| specific_project | id | DefaultPaginator | ✅ | ❌ |
|
||||
| jobs | number | DefaultPaginator | ✅ | ❌ |
|
||||
| workflow | id | DefaultPaginator | ✅ | ✅ |
|
||||
| insights_metrics | project_id | DefaultPaginator | ✅ | ❌ |
|
||||
| insights_branches | id | DefaultPaginator | ✅ | ❌ |
|
||||
| workflow_jobs | id | DefaultPaginator | ✅ | ✅ |
|
||||
|
||||
## Changelog
|
||||
|
||||
<details>
|
||||
<summary>Expand to review</summary>
|
||||
|
||||
| Version | Date |PR| Subject |
|
||||
|------------------|------------|---|----------------|
|
||||
| 0.0.1 | 2024-09-29 |[46249](https://github.com/airbytehq/airbyte/pull/46249)| Initial release by [@btkcodedev](https://github.com/btkcodedev) via Connector Builder|
|
||||
|
||||
</details>
|
||||
Reference in New Issue
Block a user