docs: sync agent connector docs from airbyte-agent-connectors repo (#70933)

Co-authored-by: ian-at-airbyte <187576150+ian-at-airbyte@users.noreply.github.com>
2025-12-23 21:03:15 -05:00 · 2025-12-16 02:44:31 +00:00
parent baae39e359
commit 499a92d065
3 changed files with 206 additions and 70 deletions
--- a/docs/ai-agents/connectors/github/CHANGELOG.md
+++ b/docs/ai-agents/connectors/github/CHANGELOG.md
@@ -1,4 +1,19 @@
-# Changelog
+# Github changelog
+
+## [0.18.21] - 2025-12-16
+- Updated connector definition (YAML version 0.1.5)
+- Source commit: 57f08f60
+- SDK version: 0.1.0
+
+## [0.18.20] - 2025-12-16
+- Updated connector definition (YAML version 0.1.4)
+- Source commit: 6dfa2d12
+- SDK version: 0.1.0
+
+## [0.18.19] - 2025-12-16
+- Updated connector definition (YAML version 0.1.3)
+- Source commit: 420c6ad3
+- SDK version: 0.1.0

 ## [0.18.18] - 2025-12-15
 - Updated connector definition (YAML version 0.1.2)
--- a/docs/ai-agents/connectors/github/README.md
+++ b/docs/ai-agents/connectors/github/README.md
@@ -1,4 +1,4 @@
-# Airbyte Github AI Connector
+# Github agent connector

 GitHub is a platform for version control and collaborative software development
 using Git. This connector provides access to repositories, branches, commits, issues,
@@ -6,7 +6,7 @@ pull requests, reviews, comments, releases, organizations, teams, and users for
 development workflow analysis and project management insights.


-## Example Questions
+## Example questions

 - Show me all open issues in my repositories this month
 - List the top 5 repositories I've starred recently
@@ -19,7 +19,7 @@ development workflow analysis and project management insights.
 - List all milestones for our current development sprint
 - Show me insights about pull request review patterns in our team

-## Unsupported Questions
+## Unsupported questions

 - Create a new issue in the project repository
 - Update the status of this pull request
@@ -46,7 +46,9 @@ connector = GithubConnector(
 result = connector.repositories.get()
 ```

-## Documentation
+## Full documentation
+
+This connector supports the following entities and actions.

 | Entity | Actions |
 |--------|---------|
@@ -69,16 +71,16 @@ result = connector.repositories.get()
 | Stargazers | [List](./REFERENCE.md#stargazers-list) |
 | Viewer | [Get](./REFERENCE.md#viewer-get) |
 | Viewer Repositories | [List](./REFERENCE.md#viewer-repositories-list) |
+| Projects | [List](./REFERENCE.md#projects-list), [Get](./REFERENCE.md#projects-get) |
+| Project Items | [List](./REFERENCE.md#project-items-list) |


-For detailed documentation on available actions and parameters, see [REFERENCE.md](./REFERENCE.md).
+For detailed documentation on available actions and parameters, see this connector's [full reference documentation](./REFERENCE.md).

-For the service's official API docs, see [Github API Reference](https://docs.github.com/en/rest).
+For the service's official API docs, see the [Github API reference](https://docs.github.com/en/rest).

-## Version Information
+## Version information

-**Package Version:** 0.18.18
-
-**Connector Version:** 0.1.2
-
-**Generated with connector-sdk:** c4c39c2797ecd929407c9417c728d425f77b37ed
+- **Package version:** 0.18.21
+- **Connector version:** 0.1.5
+- **Generated with Connector SDK commit SHA:** 57f08f6035b744556fa96334a7b764759896287c
--- a/docs/ai-agents/connectors/github/REFERENCE.md
+++ b/docs/ai-agents/connectors/github/REFERENCE.md
@@ -1,6 +1,10 @@
-# Github
+# Github full reference

-## Supported Entities and Actions
+This is the full reference documentation for the Github agent connector.
+
+## Supported entities and actions
+
+The Github connector supports the following entities and actions.

 | Entity | Actions |
 |--------|---------|
@@ -23,6 +27,8 @@
 | Stargazers | [List](#stargazers-list) |
 | Viewer | [Get](#viewer-get) |
 | Viewer Repositories | [List](#viewer-repositories-list) |
+| Projects | [List](#projects-list), [Get](#projects-get) |
+| Project Items | [List](#project-items-list) |

 ### Repositories

@@ -56,7 +62,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
 ```


-**Params**
+**Parameters**

 | Parameter Name | Type | Required | Description |
 |----------------|------|----------|-------------|
@@ -95,7 +101,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
 ```


-**Params**
+**Parameters**

 | Parameter Name | Type | Required | Description |
 |----------------|------|----------|-------------|
@@ -137,15 +143,11 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
 ```


-**Params**
+**Parameters**

 | Parameter Name | Type | Required | Description |
 |----------------|------|----------|-------------|
-| `query` | `string` | Yes | GitHub repository search query. Examples:
- "language:python stars:>1000"
- "topic:machine-learning"
- "org:facebook is:public"
- |
+| `query` | `string` | Yes | GitHub repository search query using GitHub's search syntax |
 | `limit` | `integer` | No | Number of results to return |
 | `after` | `string` | No | Cursor for pagination (from previous response's endCursor) |
 | `fields` | `array<string>` | No | Optional array of field names to select.
@@ -183,7 +185,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
 ```


-**Params**
+**Parameters**

 | Parameter Name | Type | Required | Description |
 |----------------|------|----------|-------------|
@@ -225,7 +227,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
 ```


-**Params**
+**Parameters**

 | Parameter Name | Type | Required | Description |
 |----------------|------|----------|-------------|
@@ -268,7 +270,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
 ```


-**Params**
+**Parameters**

 | Parameter Name | Type | Required | Description |
 |----------------|------|----------|-------------|
@@ -310,7 +312,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
 ```


-**Params**
+**Parameters**

 | Parameter Name | Type | Required | Description |
 |----------------|------|----------|-------------|
@@ -353,7 +355,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
 ```


-**Params**
+**Parameters**

 | Parameter Name | Type | Required | Description |
 |----------------|------|----------|-------------|
@@ -395,7 +397,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
 ```


-**Params**
+**Parameters**

 | Parameter Name | Type | Required | Description |
 |----------------|------|----------|-------------|
@@ -438,7 +440,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
 ```


-**Params**
+**Parameters**

 | Parameter Name | Type | Required | Description |
 |----------------|------|----------|-------------|
@@ -480,7 +482,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
 ```


-**Params**
+**Parameters**

 | Parameter Name | Type | Required | Description |
 |----------------|------|----------|-------------|
@@ -524,7 +526,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
 ```


-**Params**
+**Parameters**

 | Parameter Name | Type | Required | Description |
 |----------------|------|----------|-------------|
@@ -562,14 +564,11 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
 ```


-**Params**
+**Parameters**

 | Parameter Name | Type | Required | Description |
 |----------------|------|----------|-------------|
-| `query` | `string` | Yes | GitHub issue search query. Examples:
- "repo:owner/name is:issue is:open"
- "repo:owner/name is:issue label:bug"
- |
+| `query` | `string` | Yes | GitHub issue search query using GitHub's search syntax |
 | `per_page` | `integer` | No | The number of results per page |
 | `after` | `string` | No | Cursor for pagination |
 | `fields` | `array<string>` | No | Optional array of field names to select |
@@ -607,7 +606,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
 ```


-**Params**
+**Parameters**

 | Parameter Name | Type | Required | Description |
 |----------------|------|----------|-------------|
@@ -651,7 +650,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
 ```


-**Params**
+**Parameters**

 | Parameter Name | Type | Required | Description |
 |----------------|------|----------|-------------|
@@ -689,14 +688,11 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
 ```


-**Params**
+**Parameters**

 | Parameter Name | Type | Required | Description |
 |----------------|------|----------|-------------|
-| `query` | `string` | Yes | GitHub PR search query. Examples:
- "repo:owner/name type:pr is:open"
- "repo:owner/name type:pr author:username"
- |
+| `query` | `string` | Yes | GitHub pull request search query using GitHub's search syntax |
 | `per_page` | `integer` | No | The number of results per page |
 | `after` | `string` | No | Cursor for pagination |
 | `fields` | `array<string>` | No | Optional array of field names to select |
@@ -736,7 +732,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
 ```


-**Params**
+**Parameters**

 | Parameter Name | Type | Required | Description |
 |----------------|------|----------|-------------|
@@ -782,7 +778,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
 ```


-**Params**
+**Parameters**

 | Parameter Name | Type | Required | Description |
 |----------------|------|----------|-------------|
@@ -827,7 +823,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
 ```


-**Params**
+**Parameters**

 | Parameter Name | Type | Required | Description |
 |----------------|------|----------|-------------|
@@ -869,7 +865,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
 ```


-**Params**
+**Parameters**

 | Parameter Name | Type | Required | Description |
 |----------------|------|----------|-------------|
@@ -914,7 +910,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
 ```


-**Params**
+**Parameters**

 | Parameter Name | Type | Required | Description |
 |----------------|------|----------|-------------|
@@ -954,7 +950,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
 ```


-**Params**
+**Parameters**

 | Parameter Name | Type | Required | Description |
 |----------------|------|----------|-------------|
@@ -997,7 +993,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
 ```


-**Params**
+**Parameters**

 | Parameter Name | Type | Required | Description |
 |----------------|------|----------|-------------|
@@ -1039,7 +1035,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
 ```


-**Params**
+**Parameters**

 | Parameter Name | Type | Required | Description |
 |----------------|------|----------|-------------|
@@ -1083,7 +1079,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
 ```


-**Params**
+**Parameters**

 | Parameter Name | Type | Required | Description |
 |----------------|------|----------|-------------|
@@ -1123,7 +1119,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
 ```


-**Params**
+**Parameters**

 | Parameter Name | Type | Required | Description |
 |----------------|------|----------|-------------|
@@ -1159,7 +1155,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
 ```


-**Params**
+**Parameters**

 | Parameter Name | Type | Required | Description |
 |----------------|------|----------|-------------|
@@ -1199,7 +1195,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
 ```


-**Params**
+**Parameters**

 | Parameter Name | Type | Required | Description |
 |----------------|------|----------|-------------|
@@ -1235,7 +1231,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
 ```


-**Params**
+**Parameters**

 | Parameter Name | Type | Required | Description |
 |----------------|------|----------|-------------|
@@ -1273,14 +1269,11 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
 ```


-**Params**
+**Parameters**

 | Parameter Name | Type | Required | Description |
 |----------------|------|----------|-------------|
-| `query` | `string` | Yes | GitHub user search query. Examples:
- "location:san francisco"
- "followers:>1000"
- |
+| `query` | `string` | Yes | GitHub user search query using GitHub's search syntax |
 | `limit` | `integer` | No | Number of results to return |
 | `after` | `string` | No | Cursor for pagination |
 | `fields` | `array<string>` | No | Optional array of field names to select |
@@ -1316,7 +1309,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
 ```


-**Params**
+**Parameters**

 | Parameter Name | Type | Required | Description |
 |----------------|------|----------|-------------|
@@ -1356,7 +1349,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
 ```


-**Params**
+**Parameters**

 | Parameter Name | Type | Required | Description |
 |----------------|------|----------|-------------|
@@ -1397,7 +1390,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
 ```


-**Params**
+**Parameters**

 | Parameter Name | Type | Required | Description |
 |----------------|------|----------|-------------|
@@ -1440,7 +1433,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
 ```


-**Params**
+**Parameters**

 | Parameter Name | Type | Required | Description |
 |----------------|------|----------|-------------|
@@ -1482,7 +1475,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
 ```


-**Params**
+**Parameters**

 | Parameter Name | Type | Required | Description |
 |----------------|------|----------|-------------|
@@ -1521,7 +1514,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
 ```


-**Params**
+**Parameters**

 | Parameter Name | Type | Required | Description |
 |----------------|------|----------|-------------|
@@ -1556,7 +1549,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
 ```


-**Params**
+**Parameters**

 | Parameter Name | Type | Required | Description |
 |----------------|------|----------|-------------|
@@ -1565,11 +1558,137 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
 | `fields` | `array<string>` | No | Optional array of field names to select |


+### Projects
+
+#### Projects List
+
+Returns a list of GitHub Projects V2 for the specified organization.
+Projects V2 are the new project boards that replaced classic projects.
+
+
+**Python SDK**
+
+```python
+github.projects.list(
+    org="<str>"
+)
+```
+
+**API**
+
+```bash
+curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connector_instance_id}/execute' \
+--header 'Content-Type: application/json' \
+--header 'Authorization: Bearer {your_auth_token}' \
+--data '{
+    "entity": "projects",
+    "action": "list",
+    "params": {
+        "org": "<str>"
+    }
+}'
+```
+
+
+**Parameters**
+
+| Parameter Name | Type | Required | Description |
+|----------------|------|----------|-------------|
+| `org` | `string` | Yes | The organization login/username |
+| `per_page` | `integer` | No | The number of results per page |
+| `after` | `string` | No | Cursor for pagination (from previous response's endCursor) |
+| `fields` | `array<string>` | No | Optional array of field names to select |
+
+
+#### Projects Get
+
+Gets information about a specific GitHub Project V2 by number
+
+**Python SDK**
+
+```python
+github.projects.get(
+    org="<str>",
+    project_number=0
+)
+```
+
+**API**
+
+```bash
+curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connector_instance_id}/execute' \
+--header 'Content-Type: application/json' \
+--header 'Authorization: Bearer {your_auth_token}' \
+--data '{
+    "entity": "projects",
+    "action": "get",
+    "params": {
+        "org": "<str>",
+        "project_number": 0
+    }
+}'
+```
+
+
+**Parameters**
+
+| Parameter Name | Type | Required | Description |
+|----------------|------|----------|-------------|
+| `org` | `string` | Yes | The organization login/username |
+| `project_number` | `integer` | Yes | The project number |
+| `fields` | `array<string>` | No | Optional array of field names to select |
+
+
+### Project Items
+
+#### Project Items List
+
+Returns a list of items (issues, pull requests, draft issues) in a GitHub Project V2.
+Each item includes its field values like Status, Priority, etc.
+
+
+**Python SDK**
+
+```python
+github.project_items.list(
+    org="<str>",
+    project_number=0
+)
+```
+
+**API**
+
+```bash
+curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connector_instance_id}/execute' \
+--header 'Content-Type: application/json' \
+--header 'Authorization: Bearer {your_auth_token}' \
+--data '{
+    "entity": "project_items",
+    "action": "list",
+    "params": {
+        "org": "<str>",
+        "project_number": 0
+    }
+}'
+```
+
+
+**Parameters**
+
+| Parameter Name | Type | Required | Description |
+|----------------|------|----------|-------------|
+| `org` | `string` | Yes | The organization login/username |
+| `project_number` | `integer` | Yes | The project number |
+| `per_page` | `integer` | No | The number of results per page |
+| `after` | `string` | No | Cursor for pagination (from previous response's endCursor) |
+| `fields` | `array<string>` | No | Optional array of field names to select |
+
+


 ## Authentication

-The Github connector supports the following authentication methods:
+The Github connector supports the following authentication methods.


 ### GitHub OAuth 2.0