airbyte-source-github 1.7.1.dev202404071124__py3-none-any.whl → 1.7.3__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {airbyte_source_github-1.7.1.dev202404071124.dist-info → airbyte_source_github-1.7.3.dist-info}/METADATA +26 -12
- airbyte_source_github-1.7.3.dist-info/RECORD +62 -0
- source_github/schemas/assignees.json +19 -0
- source_github/schemas/branches.json +17 -0
- source_github/schemas/collaborators.json +26 -0
- source_github/schemas/comments.json +29 -0
- source_github/schemas/commit_comments.json +15 -0
- source_github/schemas/commits.json +35 -0
- source_github/schemas/contributor_activity.json +32 -8
- source_github/schemas/deployments.json +19 -0
- source_github/schemas/events.json +17 -0
- source_github/schemas/issue_events.json +69 -4
- source_github/schemas/issue_labels.json +8 -0
- source_github/schemas/issue_milestones.json +17 -0
- source_github/schemas/issue_reactions.json +7 -0
- source_github/schemas/issue_timeline_events.json +197 -56
- source_github/schemas/issues.json +84 -0
- source_github/schemas/organizations.json +62 -0
- source_github/schemas/project_cards.json +14 -0
- source_github/schemas/project_columns.json +10 -0
- source_github/schemas/projects.json +14 -0
- source_github/schemas/projects_v2.json +23 -0
- source_github/schemas/pull_request_comment_reactions.json +7 -0
- source_github/schemas/pull_request_commits.json +33 -0
- source_github/schemas/pull_request_stats.json +24 -3
- source_github/schemas/pull_requests.json +60 -0
- source_github/schemas/releases.json +38 -0
- source_github/schemas/repositories.json +98 -0
- source_github/schemas/review_comments.json +34 -0
- source_github/schemas/reviews.json +18 -0
- source_github/schemas/stargazers.json +4 -0
- source_github/schemas/tags.json +8 -0
- source_github/schemas/team_members.json +20 -0
- source_github/schemas/team_memberships.json +6 -0
- source_github/schemas/teams.json +14 -0
- source_github/schemas/users.json +19 -0
- source_github/schemas/workflow_jobs.json +30 -0
- source_github/schemas/workflow_runs.json +136 -0
- source_github/schemas/workflows.json +11 -0
- source_github/spec.json +1 -1
- airbyte_source_github-1.7.1.dev202404071124.dist-info/RECORD +0 -62
- {airbyte_source_github-1.7.1.dev202404071124.dist-info → airbyte_source_github-1.7.3.dist-info}/WHEEL +0 -0
- {airbyte_source_github-1.7.1.dev202404071124.dist-info → airbyte_source_github-1.7.3.dist-info}/entry_points.txt +0 -0
@@ -1,6 +1,6 @@
|
|
1
1
|
Metadata-Version: 2.1
|
2
2
|
Name: airbyte-source-github
|
3
|
-
Version: 1.7.
|
3
|
+
Version: 1.7.3
|
4
4
|
Summary: Source implementation for GitHub.
|
5
5
|
Home-page: https://airbyte.com
|
6
6
|
License: MIT
|
@@ -12,7 +12,7 @@ Classifier: Programming Language :: Python :: 3
|
|
12
12
|
Classifier: Programming Language :: Python :: 3.9
|
13
13
|
Classifier: Programming Language :: Python :: 3.10
|
14
14
|
Classifier: Programming Language :: Python :: 3.11
|
15
|
-
Requires-Dist: airbyte-cdk (==0.
|
15
|
+
Requires-Dist: airbyte-cdk (==0.80.0)
|
16
16
|
Requires-Dist: sgqlc (==16.3)
|
17
17
|
Project-URL: Documentation, https://docs.airbyte.com/integrations/sources/github
|
18
18
|
Project-URL: Repository, https://github.com/airbytehq/airbyte
|
@@ -20,32 +20,33 @@ Description-Content-Type: text/markdown
|
|
20
20
|
|
21
21
|
# Github source connector
|
22
22
|
|
23
|
-
|
24
23
|
This is the repository for the Github source connector, written in Python.
|
25
24
|
For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.com/integrations/sources/github).
|
26
25
|
|
27
26
|
## Local development
|
28
27
|
|
29
28
|
### Prerequisites
|
30
|
-
* Python (~=3.9)
|
31
|
-
* Poetry (~=1.7) - installation instructions [here](https://python-poetry.org/docs/#installation)
|
32
29
|
|
30
|
+
- Python (~=3.9)
|
31
|
+
- Poetry (~=1.7) - installation instructions [here](https://python-poetry.org/docs/#installation)
|
33
32
|
|
34
33
|
### Installing the connector
|
34
|
+
|
35
35
|
From this connector directory, run:
|
36
|
+
|
36
37
|
```bash
|
37
38
|
poetry install --with dev
|
38
39
|
```
|
39
40
|
|
40
|
-
|
41
41
|
### Create credentials
|
42
|
+
|
42
43
|
**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.com/integrations/sources/github)
|
43
44
|
to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `source_github/spec.yaml` file.
|
44
45
|
Note that any directory named `secrets` is gitignored across the entire Airbyte repo, so there is no danger of accidentally checking in sensitive information.
|
45
46
|
See `sample_files/sample_config.json` for a sample config file.
|
46
47
|
|
47
|
-
|
48
48
|
### Locally running the connector
|
49
|
+
|
49
50
|
```
|
50
51
|
poetry run source-github spec
|
51
52
|
poetry run source-github check --config secrets/config.json
|
@@ -54,23 +55,28 @@ poetry run source-github read --config secrets/config.json --catalog sample_file
|
|
54
55
|
```
|
55
56
|
|
56
57
|
### Running unit tests
|
58
|
+
|
57
59
|
To run unit tests locally, from the connector directory run:
|
60
|
+
|
58
61
|
```
|
59
62
|
poetry run pytest unit_tests
|
60
63
|
```
|
61
64
|
|
62
65
|
### Building the docker image
|
66
|
+
|
63
67
|
1. Install [`airbyte-ci`](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md)
|
64
68
|
2. Run the following command to build the docker image:
|
69
|
+
|
65
70
|
```bash
|
66
71
|
airbyte-ci connectors --name=source-github build
|
67
72
|
```
|
68
73
|
|
69
74
|
An image will be available on your host with the tag `airbyte/source-github:dev`.
|
70
75
|
|
71
|
-
|
72
76
|
### Running as a docker container
|
77
|
+
|
73
78
|
Then run any of the connector commands as follows:
|
79
|
+
|
74
80
|
```
|
75
81
|
docker run --rm airbyte/source-github:dev spec
|
76
82
|
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-github:dev check --config /secrets/config.json
|
@@ -79,18 +85,23 @@ docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integrat
|
|
79
85
|
```
|
80
86
|
|
81
87
|
### Running our CI test suite
|
88
|
+
|
82
89
|
You can run our full test suite locally using [`airbyte-ci`](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md):
|
90
|
+
|
83
91
|
```bash
|
84
92
|
airbyte-ci connectors --name=source-github test
|
85
93
|
```
|
86
94
|
|
87
95
|
### Customizing acceptance Tests
|
96
|
+
|
88
97
|
Customize `acceptance-test-config.yml` file to configure acceptance tests. See [Connector Acceptance Tests](https://docs.airbyte.com/connector-development/testing-connectors/connector-acceptance-tests-reference) for more information.
|
89
98
|
If your connector requires to create or destroy resources for use during acceptance tests create fixtures for it and place them inside integration_tests/acceptance.py.
|
90
99
|
|
91
100
|
### Dependency Management
|
92
|
-
|
101
|
+
|
102
|
+
All of your dependencies should be managed via Poetry.
|
93
103
|
To add a new dependency, run:
|
104
|
+
|
94
105
|
```bash
|
95
106
|
poetry add <package-name>
|
96
107
|
```
|
@@ -98,14 +109,17 @@ poetry add <package-name>
|
|
98
109
|
Please commit the changes to `pyproject.toml` and `poetry.lock` files.
|
99
110
|
|
100
111
|
## Publishing a new version of the connector
|
112
|
+
|
101
113
|
You've checked out the repo, implemented a million dollar feature, and you're ready to share your changes with the world. Now what?
|
114
|
+
|
102
115
|
1. Make sure your changes are passing our test suite: `airbyte-ci connectors --name=source-github test`
|
103
|
-
2. Bump the connector version (please follow [semantic versioning for connectors](https://docs.airbyte.com/contributing-to-airbyte/resources/pull-requests-handbook/#semantic-versioning-for-connectors)):
|
104
|
-
|
105
|
-
|
116
|
+
2. Bump the connector version (please follow [semantic versioning for connectors](https://docs.airbyte.com/contributing-to-airbyte/resources/pull-requests-handbook/#semantic-versioning-for-connectors)):
|
117
|
+
- bump the `dockerImageTag` value in in `metadata.yaml`
|
118
|
+
- bump the `version` value in `pyproject.toml`
|
106
119
|
3. Make sure the `metadata.yaml` content is up to date.
|
107
120
|
4. Make sure the connector documentation and its changelog is up to date (`docs/integrations/sources/github.md`).
|
108
121
|
5. Create a Pull Request: use [our PR naming conventions](https://docs.airbyte.com/contributing-to-airbyte/resources/pull-requests-handbook/#pull-request-title-convention).
|
109
122
|
6. Pat yourself on the back for being an awesome contributor.
|
110
123
|
7. Someone from Airbyte will take a look at your PR and iterate with you to merge it into master.
|
111
124
|
8. Once your PR is merged, the new version of the connector will be automatically published to Docker Hub and our connector registry.
|
125
|
+
|
@@ -0,0 +1,62 @@
|
|
1
|
+
source_github/__init__.py,sha256=punPc3v0mXEYOun7cbkfM5KUhgjv72B9DgDhI4VtzcQ,1134
|
2
|
+
source_github/config_migrations.py,sha256=Dq-x0yoQNLpcO6ZwRJDfd3Mhuk4SSQDjEVfhOpto_Xc,3849
|
3
|
+
source_github/constants.py,sha256=Hj3Q4y7OoU-Iff4m9gEC2CjwmWJYXhNbHVNjg8EBLmQ,238
|
4
|
+
source_github/github_schema.py,sha256=JHFeNATAjLjB2RvdPJks1JMrCotipLBAOnpikp30oUI,1600314
|
5
|
+
source_github/graphql.py,sha256=csp3C9Mgf5MIzShbRlb1DWffZ1qRnZzmXwmfHpfUP5U,11625
|
6
|
+
source_github/run.py,sha256=onA-rP2aVhWHvDquKZdR1381CU66rnzqJ7EFMS5dd4Q,407
|
7
|
+
source_github/schemas/assignees.json,sha256=_WmGIwYmTmEi9WWkvXdFF3CLsMzG2usoIjaqw-tb4NA,2335
|
8
|
+
source_github/schemas/branches.json,sha256=3CIkdEi2XVFoVZrpO_U04mMI7-jSb9i-CT3wbIEgPik,2734
|
9
|
+
source_github/schemas/collaborators.json,sha256=ZeRsZvj9lUr43hnjX0l84rl2TTeKKbFKk-tmzBYdOmo,3505
|
10
|
+
source_github/schemas/comments.json,sha256=jxux5Y9LjawAkESc6QpS3hdqRwZ2_yJ2H-F2mTpDv7M,4193
|
11
|
+
source_github/schemas/commit_comment_reactions.json,sha256=OxGmHXvft7upViZReEOmhT1jLJcQv2O0sH9WLMY8rBo,87
|
12
|
+
source_github/schemas/commit_comments.json,sha256=QQaGL0v4PKb0y6F_l_r79Ay-hbLRFXvYAsil_aNTcas,2164
|
13
|
+
source_github/schemas/commits.json,sha256=d6ikqHLTBhd-loXqu6g1RBatwQnet1eo0OcTvfyLO9Y,5122
|
14
|
+
source_github/schemas/contributor_activity.json,sha256=ZF6n5nuy2KpmZh8nvaFQUnQUzU0I6r9X_NI6LXnic18,3957
|
15
|
+
source_github/schemas/deployments.json,sha256=yEqc9i3U7ScsNib7DGG0TY4se9K1jUHVr8SD2N5sSTg,2893
|
16
|
+
source_github/schemas/events.json,sha256=Ifzd9GsmBhprL3G8NuZjl0IE7-tpN7lLI4SqoPxi1TY,2299
|
17
|
+
source_github/schemas/issue_comment_reactions.json,sha256=OxGmHXvft7upViZReEOmhT1jLJcQv2O0sH9WLMY8rBo,87
|
18
|
+
source_github/schemas/issue_events.json,sha256=kchZ6UeDjC4n9VRWJPusJPPkGwqNV-mUxIlsO13KsAE,13840
|
19
|
+
source_github/schemas/issue_labels.json,sha256=7WXewMf_bFIma_06HrScclGr3jrs4QT3dPnN7Ku-sBE,1200
|
20
|
+
source_github/schemas/issue_milestones.json,sha256=ZN-uwYUi2zhXnOCdsOxYFOq3BXgRuuFovw2azXKxdO0,2309
|
21
|
+
source_github/schemas/issue_reactions.json,sha256=8KAAPEUMZw3l6ncpSxAY3EtApvJYV0yAbwzK8ny8ass,998
|
22
|
+
source_github/schemas/issue_timeline_events.json,sha256=LrckI6mfwnbTIJs7u45k2nr3xGuiSJAYfpdW-A4PwHY,30392
|
23
|
+
source_github/schemas/issues.json,sha256=_TXJLoEMf8yCK9y6tMHXcoe4pxLIc75u0kH_48C6s9c,11962
|
24
|
+
source_github/schemas/organizations.json,sha256=YEnZy3qto0g00ixlIKn9LRhy_tVRDJq_d0uCMXkH3H8,9349
|
25
|
+
source_github/schemas/project_cards.json,sha256=okmLFWBYLwH1rN0-_AjlixS9o6xmi2RZqSsY1amuWFk,2016
|
26
|
+
source_github/schemas/project_columns.json,sha256=kll_DqRUlEFPhZxHn6jjWU9aCMUh4ccE_tU4xFRyBg8,1489
|
27
|
+
source_github/schemas/projects.json,sha256=f8JQLYhNfWaB3gAv3lfrHykhKKJXkBB3XlaWoDSxU8s,1848
|
28
|
+
source_github/schemas/projects_v2.json,sha256=lH6kYCA7vkcaIIz5xNhQuMBdjlNf-4Ezdpz1YeM39lk,3162
|
29
|
+
source_github/schemas/pull_request_comment_reactions.json,sha256=shrzajYnEHg_UlUdn56tPjyT3xPGvw3Q3RHECVgWDjc,1038
|
30
|
+
source_github/schemas/pull_request_commits.json,sha256=WICcuxUsExJQe1qlXvXVN-VvkqbjWxR_E__WKO-Ta7E,4800
|
31
|
+
source_github/schemas/pull_request_stats.json,sha256=harNH5ha6su-2OhxszHOqDKJ34OZzUsL_4nBnaOD16o,3497
|
32
|
+
source_github/schemas/pull_requests.json,sha256=Yp9Sq3jgpfBn0YFbcZC_sy06rlJ-AMkCbHNq90KXT_Y,12196
|
33
|
+
source_github/schemas/releases.json,sha256=MnoP0oSioKLmXvo6JyuqCoesIOFhtcRli7j6umlkn8k,5140
|
34
|
+
source_github/schemas/repositories.json,sha256=WpC5ZjoycnHUP5DNz8ImEXROYAel8DGRkBN10W1mQ2w,13319
|
35
|
+
source_github/schemas/review_comments.json,sha256=HVH3OE-x_wYVvg0Qxn6rzXOwAGEk0y3De8_VLCgE3mA,4905
|
36
|
+
source_github/schemas/reviews.json,sha256=OPqo9Dz6slRGojamq8pBMKKRZgz96kDRkYiUJjJQH_E,2731
|
37
|
+
source_github/schemas/shared/events/comment.json,sha256=w8xBeZh1t2RDn920iEuIkkny3sPH5GgGD-GKytlCrVk,7387
|
38
|
+
source_github/schemas/shared/events/commented.json,sha256=_orCbQap7x_WwFI7mOhNWl7fo8l6yu-wrgJSVhD3jBA,4197
|
39
|
+
source_github/schemas/shared/events/committed.json,sha256=3JBZKGgZ3zAjrOwfTDNexmmQKDvlx_TWQTBcxtBSAPY,1443
|
40
|
+
source_github/schemas/shared/events/cross_referenced.json,sha256=GWJAp9xIB_Sbg_K8T3la2EcWk3h9vJ6A6WsMjPLn3dw,36914
|
41
|
+
source_github/schemas/shared/events/reviewed.json,sha256=DSsE2RDjoqWtn9ZZKj0w5DPSB5WM5jV6TdxhCsSyI6w,2764
|
42
|
+
source_github/schemas/shared/reaction.json,sha256=CqZDoD0tp1dqv_kCYD7RCxGABcZzrHmv7Dx4I9zcJTU,449
|
43
|
+
source_github/schemas/shared/reactions.json,sha256=8vo2QDUoqX8U88LJasRw6XtBxWeWqKxMeolXac3sOOQ,616
|
44
|
+
source_github/schemas/shared/user.json,sha256=IkeVSNG_2qsRMV2TorrzCIKxZjNXYjG6WVyXcKQ14es,1135
|
45
|
+
source_github/schemas/shared/user_graphql.json,sha256=gdTR-fzvWK8403eJYDlOt-7uWqtDvYQDlafOAiiw0PM,453
|
46
|
+
source_github/schemas/stargazers.json,sha256=ksTLyWxv9p1Zz-h1CsdyJIGil3_9xwzuRMAOpAjzJqw,630
|
47
|
+
source_github/schemas/tags.json,sha256=J8tpxknUpw5OGFkKoQ1D2nGHCM6VVNo-3xIxkA73u3M,1133
|
48
|
+
source_github/schemas/team_members.json,sha256=aHVL7ie-lhIXDZiBySXhCJg1pdjUyfkoRnGC4mH3MRg,2518
|
49
|
+
source_github/schemas/team_memberships.json,sha256=ECr0ICzCwcUVp-btBicm0EemVxiOPgTtdB3hlruNsNQ,911
|
50
|
+
source_github/schemas/teams.json,sha256=_GQOy0IOO9d8BcpnvqIxQLjtPJusfU7fC7IUJmSi6R4,1796
|
51
|
+
source_github/schemas/users.json,sha256=by1CEx3MW740S5F54KZfUDc2N1_UZ98Bb3fWlgCtgxc,2530
|
52
|
+
source_github/schemas/workflow_jobs.json,sha256=Kk3N3FcCYBqOdR7FYvz2nAAFtLZBuVfR8Lxg-ORD39U,3934
|
53
|
+
source_github/schemas/workflow_runs.json,sha256=XDmIsjtzka-ItEonImD3ZATZjxRNkbFo5-MPTtZDARA,19453
|
54
|
+
source_github/schemas/workflows.json,sha256=gSNw8WZaVKbX4AL97PbjZHzvxcOltXqv9Ao1RNQOFXM,1470
|
55
|
+
source_github/source.py,sha256=jOGHJLL6ys4NRAjGs-Lw1RJxK25NxA5XS8n-uH2Gico,13879
|
56
|
+
source_github/spec.json,sha256=eOOBUWU0X2cRPM8ik07R0v_Y_rss1PfcutD60DJpNb4,7073
|
57
|
+
source_github/streams.py,sha256=vcP2P0vCvShaa3z8M9dnmbY6awKR8vAIw3XgR8PlZtk,77006
|
58
|
+
source_github/utils.py,sha256=DfAHFjsF8hzDXeSCR6qtfs7W_av6o2BkkEVhtHpWbis,5462
|
59
|
+
airbyte_source_github-1.7.3.dist-info/METADATA,sha256=AxJHALSYSLNqCQfzyytx3NMPERZs59qNfLKOwHWE01E,5240
|
60
|
+
airbyte_source_github-1.7.3.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
|
61
|
+
airbyte_source_github-1.7.3.dist-info/entry_points.txt,sha256=gYhqVrTAZvMwuYByg0b_-o115yUFLLcfNxMrLZmiW9k,55
|
62
|
+
airbyte_source_github-1.7.3.dist-info/RECORD,,
|
@@ -3,60 +3,79 @@
|
|
3
3
|
"type": "object",
|
4
4
|
"properties": {
|
5
5
|
"repository": {
|
6
|
+
"description": "Repository where the assignee is assigned",
|
6
7
|
"type": "string"
|
7
8
|
},
|
8
9
|
"login": {
|
10
|
+
"description": "Username of the assignee",
|
9
11
|
"type": ["null", "string"]
|
10
12
|
},
|
11
13
|
"id": {
|
14
|
+
"description": "Unique identifier of the assignee",
|
12
15
|
"type": ["null", "integer"]
|
13
16
|
},
|
14
17
|
"node_id": {
|
18
|
+
"description": "Node ID of the assignee",
|
15
19
|
"type": ["null", "string"]
|
16
20
|
},
|
17
21
|
"avatar_url": {
|
22
|
+
"description": "URL of the assignee's avatar image",
|
18
23
|
"type": ["null", "string"]
|
19
24
|
},
|
20
25
|
"gravatar_id": {
|
26
|
+
"description": "Gravatar ID of the assignee",
|
21
27
|
"type": ["null", "string"]
|
22
28
|
},
|
23
29
|
"url": {
|
30
|
+
"description": "URL of the assignee's account",
|
24
31
|
"type": ["null", "string"]
|
25
32
|
},
|
26
33
|
"html_url": {
|
34
|
+
"description": "URL of the assignee's GitHub profile",
|
27
35
|
"type": ["null", "string"]
|
28
36
|
},
|
29
37
|
"followers_url": {
|
38
|
+
"description": "URL of the assignee's followers",
|
30
39
|
"type": ["null", "string"]
|
31
40
|
},
|
32
41
|
"following_url": {
|
42
|
+
"description": "URL of the assignee's following",
|
33
43
|
"type": ["null", "string"]
|
34
44
|
},
|
35
45
|
"gists_url": {
|
46
|
+
"description": "URL of the assignee's gists",
|
36
47
|
"type": ["null", "string"]
|
37
48
|
},
|
38
49
|
"starred_url": {
|
50
|
+
"description": "URL of the assignee's starred items",
|
39
51
|
"type": ["null", "string"]
|
40
52
|
},
|
41
53
|
"subscriptions_url": {
|
54
|
+
"description": "URL of the assignee's subscriptions",
|
42
55
|
"type": ["null", "string"]
|
43
56
|
},
|
44
57
|
"organizations_url": {
|
58
|
+
"description": "URL of the assignee's organizations",
|
45
59
|
"type": ["null", "string"]
|
46
60
|
},
|
47
61
|
"repos_url": {
|
62
|
+
"description": "URL of the assignee's repositories",
|
48
63
|
"type": ["null", "string"]
|
49
64
|
},
|
50
65
|
"events_url": {
|
66
|
+
"description": "URL of the assignee's events",
|
51
67
|
"type": ["null", "string"]
|
52
68
|
},
|
53
69
|
"received_events_url": {
|
70
|
+
"description": "URL of the assignee's received events",
|
54
71
|
"type": ["null", "string"]
|
55
72
|
},
|
56
73
|
"type": {
|
74
|
+
"description": "Type of the assignee's account",
|
57
75
|
"type": ["null", "string"]
|
58
76
|
},
|
59
77
|
"site_admin": {
|
78
|
+
"description": "Boolean indicating if the assignee is a site administrator",
|
60
79
|
"type": ["null", "boolean"]
|
61
80
|
}
|
62
81
|
}
|
@@ -3,52 +3,68 @@
|
|
3
3
|
"type": "object",
|
4
4
|
"properties": {
|
5
5
|
"repository": {
|
6
|
+
"description": "Details about the repository associated with the branch.",
|
6
7
|
"type": "string"
|
7
8
|
},
|
8
9
|
"name": {
|
10
|
+
"description": "The name of the branch.",
|
9
11
|
"type": ["null", "string"]
|
10
12
|
},
|
11
13
|
"commit": {
|
14
|
+
"description": "Details about the commit associated with the branch.",
|
12
15
|
"type": ["null", "object"],
|
13
16
|
"properties": {
|
14
17
|
"sha": {
|
18
|
+
"description": "The unique identifier of the commit.",
|
15
19
|
"type": ["null", "string"]
|
16
20
|
},
|
17
21
|
"url": {
|
22
|
+
"description": "The URL to view details of the commit.",
|
18
23
|
"type": ["null", "string"]
|
19
24
|
}
|
20
25
|
}
|
21
26
|
},
|
22
27
|
"protected": {
|
28
|
+
"description": "Indicates if the branch is protected.",
|
23
29
|
"type": ["null", "boolean"]
|
24
30
|
},
|
25
31
|
"protection": {
|
32
|
+
"description": "Details about the protection settings of the branch.",
|
26
33
|
"type": ["null", "object"],
|
27
34
|
"properties": {
|
28
35
|
"enabled": {
|
36
|
+
"description": "Indicates if protection is enabled for the branch.",
|
29
37
|
"type": ["null", "boolean"]
|
30
38
|
},
|
31
39
|
"required_status_checks": {
|
40
|
+
"description": "Settings for required status checks on the branch.",
|
32
41
|
"type": ["null", "object"],
|
33
42
|
"properties": {
|
34
43
|
"enforcement_level": {
|
44
|
+
"description": "Level of enforcement for required status checks.",
|
35
45
|
"type": ["null", "string"]
|
36
46
|
},
|
37
47
|
"contexts": {
|
48
|
+
"description": "List of contexts required for status checks to pass.",
|
38
49
|
"type": ["null", "array"],
|
39
50
|
"items": {
|
51
|
+
"description": "Name of a context.",
|
40
52
|
"type": ["null", "string"]
|
41
53
|
}
|
42
54
|
},
|
43
55
|
"checks": {
|
56
|
+
"description": "List of status checks that are required.",
|
44
57
|
"type": ["null", "array"],
|
45
58
|
"items": {
|
59
|
+
"description": "Details about a specific status check.",
|
46
60
|
"type": "object",
|
47
61
|
"properties": {
|
48
62
|
"context": {
|
63
|
+
"description": "Context information of the status check.",
|
49
64
|
"type": ["null", "string"]
|
50
65
|
},
|
51
66
|
"app_id": {
|
67
|
+
"description": "ID of the application associated with the status check.",
|
52
68
|
"type": ["null", "integer"]
|
53
69
|
}
|
54
70
|
}
|
@@ -59,6 +75,7 @@
|
|
59
75
|
}
|
60
76
|
},
|
61
77
|
"protection_url": {
|
78
|
+
"description": "URL to manage protection settings for the branch.",
|
62
79
|
"type": ["null", "string"]
|
63
80
|
}
|
64
81
|
}
|
@@ -3,81 +3,107 @@
|
|
3
3
|
"type": "object",
|
4
4
|
"properties": {
|
5
5
|
"repository": {
|
6
|
+
"description": "Repository information related to the collaborator",
|
6
7
|
"type": "string"
|
7
8
|
},
|
8
9
|
"login": {
|
10
|
+
"description": "Username of the collaborator",
|
9
11
|
"type": ["null", "string"]
|
10
12
|
},
|
11
13
|
"id": {
|
14
|
+
"description": "Unique identifier of the collaborator",
|
12
15
|
"type": ["null", "integer"]
|
13
16
|
},
|
14
17
|
"node_id": {
|
18
|
+
"description": "Node ID of the collaborator",
|
15
19
|
"type": ["null", "string"]
|
16
20
|
},
|
17
21
|
"avatar_url": {
|
22
|
+
"description": "URL of the collaborator's avatar image",
|
18
23
|
"type": ["null", "string"]
|
19
24
|
},
|
20
25
|
"gravatar_id": {
|
26
|
+
"description": "Gravatar ID of the collaborator",
|
21
27
|
"type": ["null", "string"]
|
22
28
|
},
|
23
29
|
"url": {
|
30
|
+
"description": "URL of the collaborator's GitHub API endpoint",
|
24
31
|
"type": ["null", "string"]
|
25
32
|
},
|
26
33
|
"html_url": {
|
34
|
+
"description": "HTML URL of the collaborator's profile",
|
27
35
|
"type": ["null", "string"]
|
28
36
|
},
|
29
37
|
"followers_url": {
|
38
|
+
"description": "URL of the followers of the collaborator",
|
30
39
|
"type": ["null", "string"]
|
31
40
|
},
|
32
41
|
"following_url": {
|
42
|
+
"description": "URL of the users followed by the collaborator",
|
33
43
|
"type": ["null", "string"]
|
34
44
|
},
|
35
45
|
"gists_url": {
|
46
|
+
"description": "URL of gists created by the collaborator",
|
36
47
|
"type": ["null", "string"]
|
37
48
|
},
|
38
49
|
"starred_url": {
|
50
|
+
"description": "URL of the repositories starred by the collaborator",
|
39
51
|
"type": ["null", "string"]
|
40
52
|
},
|
41
53
|
"subscriptions_url": {
|
54
|
+
"description": "URL of the repositories subscribed to by the collaborator",
|
42
55
|
"type": ["null", "string"]
|
43
56
|
},
|
44
57
|
"organizations_url": {
|
58
|
+
"description": "URL of organizations the collaborator is associated with",
|
45
59
|
"type": ["null", "string"]
|
46
60
|
},
|
47
61
|
"repos_url": {
|
62
|
+
"description": "URL of the repositories of the collaborator",
|
48
63
|
"type": ["null", "string"]
|
49
64
|
},
|
50
65
|
"events_url": {
|
66
|
+
"description": "URL of the events related to the collaborator",
|
51
67
|
"type": ["null", "string"]
|
52
68
|
},
|
53
69
|
"received_events_url": {
|
70
|
+
"description": "URL of events received by the collaborator",
|
54
71
|
"type": ["null", "string"]
|
55
72
|
},
|
56
73
|
"type": {
|
74
|
+
"description": "Type of the collaborator (e.g., User)",
|
57
75
|
"type": ["null", "string"]
|
58
76
|
},
|
59
77
|
"site_admin": {
|
78
|
+
"description": "Indicates if the collaborator is a site administrator",
|
60
79
|
"type": ["null", "boolean"]
|
61
80
|
},
|
62
81
|
"role_name": {
|
82
|
+
"description": "Name of the collaborator's role",
|
63
83
|
"type": ["null", "string"]
|
64
84
|
},
|
65
85
|
"permissions": {
|
86
|
+
"description": "The permissions assigned to the collaborators",
|
66
87
|
"type": ["null", "object"],
|
67
88
|
"properties": {
|
68
89
|
"admin": {
|
90
|
+
"description": "Indicates if the collaborator has admin access",
|
69
91
|
"type": ["null", "boolean"]
|
70
92
|
},
|
71
93
|
"maintain": {
|
94
|
+
"description": "Indicates if the collaborator has maintain access",
|
72
95
|
"type": ["null", "boolean"]
|
73
96
|
},
|
74
97
|
"push": {
|
98
|
+
"description": "Indicates if the collaborator has push access",
|
75
99
|
"type": ["null", "boolean"]
|
76
100
|
},
|
77
101
|
"pull": {
|
102
|
+
"description": "Indicates if the collaborator has pull access",
|
78
103
|
"type": ["null", "boolean"]
|
79
104
|
},
|
80
105
|
"triage": {
|
106
|
+
"description": "Indicates if the collaborator has triage access",
|
81
107
|
"type": ["null", "boolean"]
|
82
108
|
}
|
83
109
|
}
|
@@ -3,96 +3,125 @@
|
|
3
3
|
"type": "object",
|
4
4
|
"properties": {
|
5
5
|
"repository": {
|
6
|
+
"description": "Details about the repository to which the comment belongs",
|
6
7
|
"type": "string"
|
7
8
|
},
|
8
9
|
"id": {
|
10
|
+
"description": "The unique identifier of the comment",
|
9
11
|
"type": ["null", "integer"]
|
10
12
|
},
|
11
13
|
"node_id": {
|
14
|
+
"description": "The unique identifier of the node",
|
12
15
|
"type": ["null", "string"]
|
13
16
|
},
|
14
17
|
"user": {
|
18
|
+
"description": "Details about the user who created the comment",
|
15
19
|
"$ref": "user.json"
|
16
20
|
},
|
17
21
|
"url": {
|
22
|
+
"description": "The URL of the comment",
|
18
23
|
"type": ["null", "string"]
|
19
24
|
},
|
20
25
|
"html_url": {
|
26
|
+
"description": "The URL of the comment on GitHub",
|
21
27
|
"type": ["null", "string"]
|
22
28
|
},
|
23
29
|
"body": {
|
30
|
+
"description": "The content of the comment",
|
24
31
|
"type": ["null", "string"]
|
25
32
|
},
|
26
33
|
"user_id": {
|
34
|
+
"description": "The unique identifier of the user",
|
27
35
|
"type": ["null", "integer"]
|
28
36
|
},
|
29
37
|
"created_at": {
|
38
|
+
"description": "The date and time the comment was created",
|
30
39
|
"type": "string",
|
31
40
|
"format": "date-time"
|
32
41
|
},
|
33
42
|
"updated_at": {
|
43
|
+
"description": "The date and time the comment was last updated",
|
34
44
|
"type": "string",
|
35
45
|
"format": "date-time"
|
36
46
|
},
|
37
47
|
"issue_url": {
|
48
|
+
"description": "The URL of the issue to which the comment belongs",
|
38
49
|
"type": ["null", "string"]
|
39
50
|
},
|
40
51
|
"author_association": {
|
52
|
+
"description": "The association of the comment author to the repository (e.g., owner, member, collaborator, contributor, etc.)",
|
41
53
|
"type": ["null", "string"]
|
42
54
|
},
|
43
55
|
"reactions": {
|
56
|
+
"description": "Reactions (e.g., like, heart, etc.) received on the comment",
|
44
57
|
"$ref": "reactions.json"
|
45
58
|
},
|
46
59
|
"performed_via_github_app": {
|
60
|
+
"description": "Details about the GitHub App that performed the action",
|
47
61
|
"type": ["null", "object"],
|
48
62
|
"properties": {
|
49
63
|
"id": {
|
64
|
+
"description": "The unique identifier of the GitHub App",
|
50
65
|
"type": ["null", "integer"]
|
51
66
|
},
|
52
67
|
"slug": {
|
68
|
+
"description": "The slug associated with the GitHub App",
|
53
69
|
"type": ["null", "string"]
|
54
70
|
},
|
55
71
|
"node_id": {
|
72
|
+
"description": "The unique identifier of the node for the GitHub App",
|
56
73
|
"type": ["null", "string"]
|
57
74
|
},
|
58
75
|
"owner": {
|
76
|
+
"description": "Details about the owner of the GitHub App",
|
59
77
|
"$ref": "user.json"
|
60
78
|
},
|
61
79
|
"name": {
|
80
|
+
"description": "The name of the GitHub App",
|
62
81
|
"type": ["null", "string"]
|
63
82
|
},
|
64
83
|
"description": {
|
84
|
+
"description": "A description of the GitHub App",
|
65
85
|
"type": ["null", "string"]
|
66
86
|
},
|
67
87
|
"external_url": {
|
88
|
+
"description": "The external URL of the GitHub App",
|
68
89
|
"type": ["null", "string"]
|
69
90
|
},
|
70
91
|
"html_url": {
|
92
|
+
"description": "The HTML URL of the GitHub App",
|
71
93
|
"type": ["null", "string"]
|
72
94
|
},
|
73
95
|
"created_at": {
|
96
|
+
"description": "The date and time the GitHub App was created",
|
74
97
|
"type": "string",
|
75
98
|
"format": "date-time"
|
76
99
|
},
|
77
100
|
"updated_at": {
|
101
|
+
"description": "The date and time the GitHub App was last updated",
|
78
102
|
"type": "string",
|
79
103
|
"format": "date-time"
|
80
104
|
},
|
81
105
|
"permissions": {
|
106
|
+
"description": "Permissions granted to the GitHub App",
|
82
107
|
"type": "object",
|
83
108
|
"properties": {
|
84
109
|
"issues": {
|
110
|
+
"description": "Permission for accessing issues",
|
85
111
|
"type": ["null", "string"]
|
86
112
|
},
|
87
113
|
"metadata": {
|
114
|
+
"description": "Permission for accessing metadata",
|
88
115
|
"type": ["null", "string"]
|
89
116
|
},
|
90
117
|
"pull_requests": {
|
118
|
+
"description": "Permission for accessing pull requests",
|
91
119
|
"type": ["null", "string"]
|
92
120
|
}
|
93
121
|
}
|
94
122
|
},
|
95
123
|
"events": {
|
124
|
+
"description": "Events associated with the GitHub App",
|
96
125
|
"type": "array",
|
97
126
|
"items": {
|
98
127
|
"type": ["null", "string"]
|
@@ -3,50 +3,65 @@
|
|
3
3
|
"type": "object",
|
4
4
|
"properties": {
|
5
5
|
"repository": {
|
6
|
+
"description": "Details of the repository to which the comment belongs",
|
6
7
|
"type": "string"
|
7
8
|
},
|
8
9
|
"html_url": {
|
10
|
+
"description": "The URL to view the comment on GitHub's web interface",
|
9
11
|
"type": ["null", "string"]
|
10
12
|
},
|
11
13
|
"url": {
|
14
|
+
"description": "The API URL to fetch the details of the comment",
|
12
15
|
"type": ["null", "string"]
|
13
16
|
},
|
14
17
|
"id": {
|
18
|
+
"description": "The unique identifier of the comment",
|
15
19
|
"type": ["null", "integer"]
|
16
20
|
},
|
17
21
|
"node_id": {
|
22
|
+
"description": "The globally unique identifier for the comment",
|
18
23
|
"type": ["null", "string"]
|
19
24
|
},
|
20
25
|
"body": {
|
26
|
+
"description": "The content of the comment",
|
21
27
|
"type": ["null", "string"]
|
22
28
|
},
|
23
29
|
"path": {
|
30
|
+
"description": "The file path to which the comment is associated",
|
24
31
|
"type": ["null", "string"]
|
25
32
|
},
|
26
33
|
"position": {
|
34
|
+
"description": "The position in the file at which the comment is located",
|
27
35
|
"type": ["null", "integer"]
|
28
36
|
},
|
29
37
|
"line": {
|
38
|
+
"description": "The line number in the file at which the comment is located",
|
30
39
|
"type": ["null", "integer"]
|
31
40
|
},
|
32
41
|
"commit_id": {
|
42
|
+
"description": "The identifier of the commit to which the comment is associated",
|
33
43
|
"type": ["null", "string"]
|
34
44
|
},
|
35
45
|
"user": {
|
46
|
+
"description": "Details of the user who made the comment",
|
36
47
|
"$ref": "user.json"
|
37
48
|
},
|
38
49
|
"created_at": {
|
50
|
+
"description": "The date and time when the comment was created",
|
39
51
|
"type": "string",
|
40
52
|
"format": "date-time"
|
41
53
|
},
|
42
54
|
"updated_at": {
|
55
|
+
"description": "The date and time when the comment was last updated",
|
43
56
|
"type": "string",
|
44
57
|
"format": "date-time"
|
45
58
|
},
|
46
59
|
"author_association": {
|
60
|
+
"description": "The association of the user who made the comment with the repository (e.g., owner, collaborator, member, contributor)",
|
47
61
|
"type": ["null", "string"]
|
48
62
|
},
|
49
63
|
"reactions": {
|
64
|
+
"description": "Reactions (e.g., thumbs up, hooray) associated with the comment",
|
50
65
|
"$ref": "reactions.json"
|
51
66
|
}
|
52
67
|
}
|