Skip to content

Commit 774092c

Browse files
authored
Merge pull request #551 from github/openapi-update-5c30311382bd8dda7c48e77e4814977dbdfaae6a74bdc8a9c7d97f6cc0637029
Update OpenAPI Descriptions
2 parents e36cdf7 + 60729dd commit 774092c

40 files changed

+7080
-184
lines changed

descriptions/api.github.com/api.github.com.json

Lines changed: 167 additions & 6 deletions
Large diffs are not rendered by default.

descriptions/api.github.com/api.github.com.yaml

Lines changed: 140 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ info:
1010
termsOfService: https://docs.github.com/articles/github-terms-of-service
1111
contact:
1212
name: Support
13-
url: https://support.github.com/contact?tags=rest-api
13+
url: https://support.github.com/contact?tags=dotcom-rest-api
1414
tags:
1515
- name: actions
1616
description: Endpoints to manage GitHub Actions using the REST API.
@@ -8082,14 +8082,28 @@ paths:
80828082
type: string
80838083
lock_repositories:
80848084
type: boolean
8085+
example: true
80858086
description: Indicates whether repositories should be locked (to
80868087
prevent manipulation) while migrating data.
80878088
default: false
80888089
exclude_attachments:
80898090
type: boolean
8091+
example: true
80908092
description: Indicates whether attachments should be excluded from
80918093
the migration (to reduce migration archive file size).
80928094
default: false
8095+
exclude_releases:
8096+
type: boolean
8097+
example: true
8098+
description: Indicates whether releases should be excluded from
8099+
the migration (to reduce migration archive file size).
8100+
default: false
8101+
exclude_owner_projects:
8102+
type: boolean
8103+
example: true
8104+
description: Indicates whether projects owned by the organization
8105+
or users should be excluded. from the migration.
8106+
default: false
80938107
exclude:
80948108
type: array
80958109
items:
@@ -12730,6 +12744,11 @@ paths:
1273012744
description: "`true` to archive this repository. **Note**: You cannot
1273112745
unarchive repositories through the API."
1273212746
default: false
12747+
allow_forking:
12748+
type: boolean
12749+
description: Either `true` to allow private forks, or `false` to
12750+
prevent private forks.
12751+
default: false
1273312752
example:
1273412753
name: Hello-World
1273512754
description: This is your first repository
@@ -13857,9 +13876,13 @@ paths:
1385713876
"/repos/{owner}/{repo}/actions/runs/{run_id}/rerun":
1385813877
post:
1385913878
summary: Re-run a workflow
13860-
description: Re-runs your workflow run using its `id`. You must authenticate
13861-
using an access token with the `repo` scope to use this endpoint. GitHub Apps
13862-
must have the `actions:write` permission to use this endpoint.
13879+
description: |-
13880+
**Deprecation Notice:** This endpoint is deprecated.
13881+
We recommend migrating your existing code to use the new [retry workflow](https://docs.github.com/rest/reference/actions#retry-a-workflow) endpoint.
13882+
13883+
Re-runs your workflow run using its `id`. You must authenticate using
13884+
an access token with the `repo` scope to use this endpoint. GitHub Apps must have
13885+
the `actions:write` permission to use this endpoint.
1386313886
tags:
1386413887
- actions
1386513888
operationId: actions/re-run-workflow
@@ -13885,6 +13908,37 @@ paths:
1388513908
previews: []
1388613909
category: actions
1388713910
subcategory: workflow-runs
13911+
"/repos/{owner}/{repo}/actions/runs/{run_id}/retry":
13912+
post:
13913+
summary: Retry a workflow
13914+
description: Retry your workflow run using its `id`. You must authenticate using
13915+
an access token with the `repo` scope to use this endpoint. GitHub Apps must
13916+
have the `actions:write` permission to use this endpoint.
13917+
tags:
13918+
- actions
13919+
operationId: actions/retry-workflow
13920+
externalDocs:
13921+
description: API method documentation
13922+
url: https://docs.github.com/rest/reference/actions#retry-a-workflow
13923+
parameters:
13924+
- "$ref": "#/components/parameters/owner"
13925+
- "$ref": "#/components/parameters/repo"
13926+
- "$ref": "#/components/parameters/run-id"
13927+
responses:
13928+
'201':
13929+
description: Response
13930+
content:
13931+
application/json:
13932+
schema:
13933+
type: object
13934+
properties: {}
13935+
additionalProperties: false
13936+
x-github:
13937+
githubCloudOnly: false
13938+
enabledForGitHubApps: false
13939+
previews: []
13940+
category: actions
13941+
subcategory: workflow-runs
1388813942
"/repos/{owner}/{repo}/actions/runs/{run_id}/timing":
1388913943
get:
1389013944
summary: Get workflow run usage
@@ -20771,7 +20825,7 @@ paths:
2077120825
description: |-
2077220826
Create a fork for the authenticated user.
2077320827

20774-
**Note**: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Support](https://support.github.com/contact?tags=rest-api).
20828+
**Note**: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api).
2077520829
tags:
2077620830
- repos
2077720831
operationId: repos/create-fork
@@ -22288,7 +22342,7 @@ paths:
2228822342
If there are problems, you will see one of these in the `status` field:
2228922343

2229022344
* `auth_failed` - the import requires authentication in order to connect to the original repository. To update authentication for the import, please see the [Update an import](https://docs.github.com/rest/reference/migrations#update-an-import) section.
22291-
* `error` - the import encountered an error. The import progress response will include the `failed_step` and an error message. Contact [GitHub Support](https://support.github.com/contact?tags=rest-api) for more information.
22345+
* `error` - the import encountered an error. The import progress response will include the `failed_step` and an error message. Contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api) for more information.
2229222346
* `detection_needs_auth` - the importer requires authentication for the originating repository to continue detection. To update authentication for the import, please see the [Update an import](https://docs.github.com/rest/reference/migrations#update-an-import) section.
2229322347
* `detection_found_nothing` - the importer didn't recognize any source control at the URL. To resolve, [Cancel the import](https://docs.github.com/rest/reference/migrations#cancel-an-import) and [retry](https://docs.github.com/rest/reference/migrations#start-an-import) with the correct URL.
2229422348
* `detection_found_multiple` - the importer found several projects or repositories at the provided URL. When this is the case, the Import Progress response will also include a `project_choices` field with the possible project choices as values. To update project choice, please see the [Update an import](https://docs.github.com/rest/reference/migrations#update-an-import) section.
@@ -28543,9 +28597,10 @@ paths:
2854328597
asset filenames that have special characters, non-alphanumeric characters,
2854428598
and leading or trailing periods. The \"[List assets for a release](https://docs.github.com/rest/reference/repos#list-assets-for-a-release)\"\nendpoint
2854528599
lists the renamed filenames. For more information and help, contact [GitHub
28546-
Support](https://support.github.com/contact?tags=rest-api).\n* If you upload
28547-
an asset with the same filename as another uploaded asset, you'll receive
28548-
an error and must delete the old file before you can re-upload the new asset."
28600+
Support](https://support.github.com/contact?tags=dotcom-rest-api).\n* If
28601+
you upload an asset with the same filename as another uploaded asset, you'll
28602+
receive an error and must delete the old file before you can re-upload the
28603+
new asset."
2854928604
tags:
2855028605
- repos
2855128606
operationId: repos/upload-release-asset
@@ -35478,6 +35533,17 @@ paths:
3547835533
example: true
3547935534
readOnly: false
3548035535
type: boolean
35536+
exclude_releases:
35537+
description: Do not include releases in the migration
35538+
example: true
35539+
readOnly: false
35540+
type: boolean
35541+
exclude_owner_projects:
35542+
description: Indicates whether projects owned by the organization
35543+
or users should be excluded.
35544+
example: true
35545+
readOnly: false
35546+
type: boolean
3548135547
exclude:
3548235548
description: Exclude attributes from the API response to improve
3548335549
performance
@@ -39598,6 +39664,9 @@ components:
3959839664
default: true
3959939665
type: boolean
3960039666
example: true
39667+
allow_forking:
39668+
description: Whether to allow forking this repo
39669+
type: boolean
3960139670
subscribers_count:
3960239671
type: integer
3960339672
network_count:
@@ -42024,6 +42093,10 @@ components:
4202442093
type: string
4202542094
SHA256_DSA:
4202642095
type: string
42096+
SHA256_ECDSA:
42097+
type: string
42098+
SHA256_ED25519:
42099+
type: string
4202742100
hooks:
4202842101
type: array
4202942102
items:
@@ -42615,6 +42688,9 @@ components:
4261542688
default: true
4261642689
type: boolean
4261742690
example: true
42691+
allow_forking:
42692+
description: Whether to allow forking this repo
42693+
type: boolean
4261842694
subscribers_count:
4261942695
type: integer
4262042696
network_count:
@@ -42973,6 +43049,8 @@ components:
4297343049
watchers:
4297443050
type: integer
4297543051
example: 0
43052+
allow_forking:
43053+
type: boolean
4297643054
required:
4297743055
- archive_url
4297843056
- assignees_url
@@ -43848,8 +43926,16 @@ components:
4384843926
lock_repositories:
4384943927
type: boolean
4385043928
example: true
43929+
exclude_metadata:
43930+
type: boolean
43931+
exclude_git_data:
43932+
type: boolean
4385143933
exclude_attachments:
4385243934
type: boolean
43935+
exclude_releases:
43936+
type: boolean
43937+
exclude_owner_projects:
43938+
type: boolean
4385343939
repositories:
4385443940
type: array
4385543941
items:
@@ -43881,7 +43967,11 @@ components:
4388143967
- guid
4388243968
- state
4388343969
- lock_repositories
43970+
- exclude_metadata
43971+
- exclude_git_data
4388443972
- exclude_attachments
43973+
- exclude_releases
43974+
- exclude_owner_projects
4388543975
- repositories
4388643976
- url
4388743977
- created_at
@@ -44156,6 +44246,8 @@ components:
4415644246
watchers:
4415744247
type: integer
4415844248
example: 0
44249+
allow_forking:
44250+
type: boolean
4415944251
required:
4416044252
- archive_url
4416144253
- assignees_url
@@ -45231,6 +45323,11 @@ components:
4523145323
default: true
4523245324
type: boolean
4523345325
example: true
45326+
allow_forking:
45327+
description: Whether to allow forking this repo
45328+
default: false
45329+
type: boolean
45330+
example: false
4523445331
subscribers_count:
4523545332
type: integer
4523645333
network_count:
@@ -45786,6 +45883,9 @@ components:
4578645883
allow_merge_commit:
4578745884
type: boolean
4578845885
example: true
45886+
allow_forking:
45887+
type: boolean
45888+
example: true
4578945889
subscribers_count:
4579045890
type: integer
4579145891
example: 42
@@ -48969,6 +49069,14 @@ components:
4896949069
example: file1.txt
4897049070
status:
4897149071
type: string
49072+
enum:
49073+
- added
49074+
- removed
49075+
- modified
49076+
- renamed
49077+
- copied
49078+
- changed
49079+
- unchanged
4897249080
example: added
4897349081
additions:
4897449082
type: integer
@@ -52955,6 +53063,8 @@ components:
5295553063
updated_at:
5295653064
type: string
5295753065
format: date-time
53066+
allow_forking:
53067+
type: boolean
5295853068
required:
5295953069
- archive_url
5296053070
- assignees_url
@@ -53381,6 +53491,8 @@ components:
5338153491
updated_at:
5338253492
type: string
5338353493
format: date-time
53494+
allow_forking:
53495+
type: boolean
5338453496
required:
5338553497
- archive_url
5338653498
- assignees_url
@@ -55309,6 +55421,8 @@ components:
5530955421
type: boolean
5531055422
delete_branch_on_merge:
5531155423
type: boolean
55424+
allow_forking:
55425+
type: boolean
5531255426
required:
5531355427
- archive_url
5531455428
- assignees_url
@@ -57821,6 +57935,8 @@ components:
5782157935
ssh_key_fingerprints:
5782257936
SHA256_RSA: nThbg6kXUpJWGl7E1IGOCspRomTxdCARLviKw6E5SY8
5782357937
SHA256_DSA: br9IjFspm1vxR3iA35FWE+4VTyz1hYVLIE2t1/CeyWQ
57938+
SHA256_ECDSA: p2QAMXNIC1TJYWeIOttrVc98/R1BUFWu3/LiyKgUfQM
57939+
SHA256_ED25519: "+DiY3wvvV6TuJJhbpZisF/zLDA0zPMSvHdkr4UvCOqU"
5782457940
hooks:
5782557941
- 192.30.252.0/22
5782657942
web:
@@ -58961,6 +59077,8 @@ components:
5896159077
state: pending
5896259078
lock_repositories: true
5896359079
exclude_attachments: false
59080+
exclude_releases: false
59081+
exclude_owner_projects: false
5896459082
repositories:
5896559083
- id: 1296269
5896659084
node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5
@@ -59110,6 +59228,8 @@ components:
5911059228
state: pending
5911159229
lock_repositories: true
5911259230
exclude_attachments: false
59231+
exclude_releases: false
59232+
exclude_owner_projects: false
5911359233
repositories:
5911459234
- id: 1296269
5911559235
node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5
@@ -59258,6 +59378,8 @@ components:
5925859378
state: exported
5925959379
lock_repositories: true
5926059380
exclude_attachments: false
59381+
exclude_releases: false
59382+
exclude_owner_projects: false
5926159383
repositories:
5926259384
- id: 1296269
5926359385
node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5
@@ -62498,6 +62620,7 @@ components:
6249862620
allow_auto_merge: false
6249962621
delete_branch_on_merge: true
6250062622
allow_merge_commit: true
62623+
allow_forking: true
6250162624
subscribers_count: 42
6250262625
network_count: 0
6250362626
organization:
@@ -69152,6 +69275,7 @@ components:
6915269275
temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O
6915369276
allow_squash_merge: true
6915469277
allow_merge_commit: true
69278+
allow_forking: true
6915569279
forks: 123
6915669280
open_issues: 123
6915769281
license:
@@ -71311,6 +71435,7 @@ components:
7131171435
allow_auto_merge: false
7131271436
delete_branch_on_merge: true
7131371437
allow_merge_commit: true
71438+
allow_forking: true
7131471439
subscribers_count: 42
7131571440
network_count: 0
7131671441
repository-3:
@@ -73058,6 +73183,8 @@ components:
7305873183
state: pending
7305973184
lock_repositories: true
7306073185
exclude_attachments: false
73186+
exclude_releases: false
73187+
exclude_owner_projects: false
7306173188
repositories:
7306273189
- id: 1296269
7306373190
node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5
@@ -73207,6 +73334,8 @@ components:
7320773334
state: pending
7320873335
lock_repositories: true
7320973336
exclude_attachments: false
73337+
exclude_releases: false
73338+
exclude_owner_projects: false
7321073339
repositories:
7321173340
- id: 1296269
7321273341
node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5
@@ -73355,6 +73484,8 @@ components:
7335573484
state: exported
7335673485
lock_repositories: true
7335773486
exclude_attachments: false
73487+
exclude_releases: false
73488+
exclude_owner_projects: false
7335873489
repositories:
7335973490
- id: 1296269
7336073491
node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5

0 commit comments

Comments
 (0)