@octokit/openapi 14.0.0 → 14.1.0
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.
- package/generated/api.github.com.deref.json +2599 -1926
- package/generated/api.github.com.json +806 -607
- package/generated/ghec.deref.json +3808 -3075
- package/generated/ghec.json +860 -627
- package/generated/ghes-3.10.deref.json +3087 -2442
- package/generated/ghes-3.10.json +754 -611
- package/generated/ghes-3.11.deref.json +3087 -2442
- package/generated/ghes-3.11.json +786 -611
- package/generated/ghes-3.12.deref.json +3087 -2442
- package/generated/ghes-3.12.json +786 -611
- package/generated/ghes-3.8.deref.json +3158 -2513
- package/generated/ghes-3.8.json +754 -611
- package/generated/ghes-3.9.deref.json +3158 -2513
- package/generated/ghes-3.9.json +754 -611
- package/generated/github.ae.deref.json +1 -1
- package/generated/github.ae.json +1 -1
- package/package.json +8 -8
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"openapi": "3.0.3",
|
|
3
3
|
"info": {
|
|
4
|
-
"version": "14.
|
|
4
|
+
"version": "14.1.0",
|
|
5
5
|
"title": "GitHub's official OpenAPI spec + Octokit extension",
|
|
6
6
|
"description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
|
|
7
7
|
"license": {
|
|
@@ -3039,7 +3039,7 @@
|
|
|
3039
3039
|
"/feeds": {
|
|
3040
3040
|
"get": {
|
|
3041
3041
|
"summary": "Get feeds",
|
|
3042
|
-
"description": "
|
|
3042
|
+
"description": "Lists the feeds available to the authenticated user. The response provides a URL for each feed. You can then get a specific feed by sending a request to one of the feed URLs.\n\n* **Timeline**: The GitHub global public timeline\n* **User**: The public timeline for any user, using `uri_template`. For more information, see \"[Hypermedia](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia).\"\n* **Current user public**: The public timeline for the authenticated user\n* **Current user**: The private timeline for the authenticated user\n* **Current user actor**: The private timeline for activity created by the authenticated user\n* **Current user organizations**: The private timeline for the organizations the authenticated user is a member of.\n* **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub.\n\nBy default, timeline resources are returned in JSON. You can specify the `application/atom+xml` type in the `Accept` header to return timeline resources in Atom format. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n**Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens.",
|
|
3043
3043
|
"tags": [
|
|
3044
3044
|
"activity"
|
|
3045
3045
|
],
|
|
@@ -5967,7 +5967,7 @@
|
|
|
5967
5967
|
"/organizations": {
|
|
5968
5968
|
"get": {
|
|
5969
5969
|
"summary": "List organizations",
|
|
5970
|
-
"description": "Lists all organizations, in the order that they were created
|
|
5970
|
+
"description": "Lists all organizations, in the order that they were created.\n\n**Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations.",
|
|
5971
5971
|
"tags": [
|
|
5972
5972
|
"orgs"
|
|
5973
5973
|
],
|
|
@@ -9912,6 +9912,9 @@
|
|
|
9912
9912
|
"404": {
|
|
9913
9913
|
"$ref": "#/components/responses/not_found"
|
|
9914
9914
|
},
|
|
9915
|
+
"422": {
|
|
9916
|
+
"description": "There is a problem with your account's associated payment method."
|
|
9917
|
+
},
|
|
9915
9918
|
"500": {
|
|
9916
9919
|
"$ref": "#/components/responses/internal_error"
|
|
9917
9920
|
}
|
|
@@ -30240,11 +30243,14 @@
|
|
|
30240
30243
|
},
|
|
30241
30244
|
"status": {
|
|
30242
30245
|
"type": "string",
|
|
30243
|
-
"description": "The current status.",
|
|
30246
|
+
"description": "The current status of the check run. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`.",
|
|
30244
30247
|
"enum": [
|
|
30245
30248
|
"queued",
|
|
30246
30249
|
"in_progress",
|
|
30247
|
-
"completed"
|
|
30250
|
+
"completed",
|
|
30251
|
+
"waiting",
|
|
30252
|
+
"requested",
|
|
30253
|
+
"pending"
|
|
30248
30254
|
]
|
|
30249
30255
|
},
|
|
30250
30256
|
"conclusion": {
|
|
@@ -33915,6 +33921,9 @@
|
|
|
33915
33921
|
}
|
|
33916
33922
|
}
|
|
33917
33923
|
},
|
|
33924
|
+
"409": {
|
|
33925
|
+
"$ref": "#/components/responses/conflict"
|
|
33926
|
+
},
|
|
33918
33927
|
"422": {
|
|
33919
33928
|
"$ref": "#/components/responses/validation_failed"
|
|
33920
33929
|
}
|
|
@@ -34146,6 +34155,9 @@
|
|
|
34146
34155
|
"$ref": "#/components/headers/link"
|
|
34147
34156
|
}
|
|
34148
34157
|
}
|
|
34158
|
+
},
|
|
34159
|
+
"409": {
|
|
34160
|
+
"$ref": "#/components/responses/conflict"
|
|
34149
34161
|
}
|
|
34150
34162
|
},
|
|
34151
34163
|
"x-github": {
|
|
@@ -34205,6 +34217,9 @@
|
|
|
34205
34217
|
"404": {
|
|
34206
34218
|
"$ref": "#/components/responses/not_found"
|
|
34207
34219
|
},
|
|
34220
|
+
"409": {
|
|
34221
|
+
"$ref": "#/components/responses/conflict"
|
|
34222
|
+
},
|
|
34208
34223
|
"422": {
|
|
34209
34224
|
"$ref": "#/components/responses/validation_failed"
|
|
34210
34225
|
},
|
|
@@ -34588,7 +34603,7 @@
|
|
|
34588
34603
|
"/repos/{owner}/{repo}/compare/{basehead}": {
|
|
34589
34604
|
"get": {
|
|
34590
34605
|
"summary": "Compare two commits",
|
|
34591
|
-
"description": "Compares two commits against one another. You can compare branches in the same repository, or you can compare
|
|
34606
|
+
"description": "Compares two commits against one another. You can compare refs (branches or tags) and commit SHAs in the same repository, or you can compare refs and commit SHAs that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see \"[Understanding connections between repositories](https://docs.github.com/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories).\"\n\nThis endpoint is equivalent to running the `git log BASE..HEAD` command, but it returns commits in a different order. The `git log BASE..HEAD` command returns commits in reverse chronological order, whereas the API returns commits in chronological order.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.diff`**: Returns the diff of the commit.\n- **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property.\n\nThe API response includes details about the files that were changed between the two commits. This includes the status of the change (if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a `renamed` status have a `previous_filename` field showing the previous filename of the file, and files with a `modified` status have a `patch` field showing the changes made to the file.\n\nWhen calling this endpoint without any paging parameter (`per_page` or `page`), the returned list is limited to 250 commits, and the last commit in the list is the most recent of the entire comparison.\n\n**Working with large comparisons**\n\nTo process a response with a large number of commits, use a query parameter (`per_page` or `page`) to paginate the results. When using pagination:\n\n- The list of changed files is only shown on the first page of results, but it includes all changed files for the entire comparison.\n- The results are returned in chronological order, but the last commit in the returned list may not be the most recent one in the entire set if there are more pages of results.\n\nFor more information on working with pagination, see \"[Using pagination in the REST API](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).\"\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The `verification` object includes the following fields:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |",
|
|
34592
34607
|
"tags": [
|
|
34593
34608
|
"repos"
|
|
34594
34609
|
],
|
|
@@ -37529,6 +37544,616 @@
|
|
|
37529
37544
|
"x-octokit": {}
|
|
37530
37545
|
}
|
|
37531
37546
|
},
|
|
37547
|
+
"/repos/{owner}/{repo}/environments/{environment_name}/secrets": {
|
|
37548
|
+
"get": {
|
|
37549
|
+
"summary": "List environment secrets",
|
|
37550
|
+
"description": "Lists all secrets available in an environment without revealing their\nencrypted values.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
|
|
37551
|
+
"tags": [
|
|
37552
|
+
"actions"
|
|
37553
|
+
],
|
|
37554
|
+
"operationId": "actions/list-environment-secrets",
|
|
37555
|
+
"externalDocs": {
|
|
37556
|
+
"description": "API method documentation",
|
|
37557
|
+
"url": "https://docs.github.com/rest/actions/secrets#list-environment-secrets"
|
|
37558
|
+
},
|
|
37559
|
+
"parameters": [
|
|
37560
|
+
{
|
|
37561
|
+
"$ref": "#/components/parameters/owner"
|
|
37562
|
+
},
|
|
37563
|
+
{
|
|
37564
|
+
"$ref": "#/components/parameters/repo"
|
|
37565
|
+
},
|
|
37566
|
+
{
|
|
37567
|
+
"$ref": "#/components/parameters/environment-name"
|
|
37568
|
+
},
|
|
37569
|
+
{
|
|
37570
|
+
"$ref": "#/components/parameters/per-page"
|
|
37571
|
+
},
|
|
37572
|
+
{
|
|
37573
|
+
"$ref": "#/components/parameters/page"
|
|
37574
|
+
}
|
|
37575
|
+
],
|
|
37576
|
+
"responses": {
|
|
37577
|
+
"200": {
|
|
37578
|
+
"description": "Response",
|
|
37579
|
+
"content": {
|
|
37580
|
+
"application/json": {
|
|
37581
|
+
"schema": {
|
|
37582
|
+
"type": "object",
|
|
37583
|
+
"required": [
|
|
37584
|
+
"total_count",
|
|
37585
|
+
"secrets"
|
|
37586
|
+
],
|
|
37587
|
+
"properties": {
|
|
37588
|
+
"total_count": {
|
|
37589
|
+
"type": "integer"
|
|
37590
|
+
},
|
|
37591
|
+
"secrets": {
|
|
37592
|
+
"type": "array",
|
|
37593
|
+
"items": {
|
|
37594
|
+
"$ref": "#/components/schemas/actions-secret"
|
|
37595
|
+
}
|
|
37596
|
+
}
|
|
37597
|
+
}
|
|
37598
|
+
},
|
|
37599
|
+
"examples": {
|
|
37600
|
+
"default": {
|
|
37601
|
+
"$ref": "#/components/examples/actions-secret-paginated"
|
|
37602
|
+
}
|
|
37603
|
+
}
|
|
37604
|
+
}
|
|
37605
|
+
},
|
|
37606
|
+
"headers": {
|
|
37607
|
+
"Link": {
|
|
37608
|
+
"$ref": "#/components/headers/link"
|
|
37609
|
+
}
|
|
37610
|
+
}
|
|
37611
|
+
}
|
|
37612
|
+
},
|
|
37613
|
+
"x-github": {
|
|
37614
|
+
"githubCloudOnly": false,
|
|
37615
|
+
"enabledForGitHubApps": true,
|
|
37616
|
+
"category": "actions",
|
|
37617
|
+
"subcategory": "secrets"
|
|
37618
|
+
},
|
|
37619
|
+
"x-octokit": {}
|
|
37620
|
+
}
|
|
37621
|
+
},
|
|
37622
|
+
"/repos/{owner}/{repo}/environments/{environment_name}/secrets/public-key": {
|
|
37623
|
+
"get": {
|
|
37624
|
+
"summary": "Get an environment public key",
|
|
37625
|
+
"description": "Get the public key for an environment, which you need to encrypt environment\nsecrets. You need to encrypt a secret before you can create or update secrets.\n\nAnyone with read access to the repository can use this endpoint.\n\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
|
|
37626
|
+
"tags": [
|
|
37627
|
+
"actions"
|
|
37628
|
+
],
|
|
37629
|
+
"operationId": "actions/get-environment-public-key",
|
|
37630
|
+
"externalDocs": {
|
|
37631
|
+
"description": "API method documentation",
|
|
37632
|
+
"url": "https://docs.github.com/rest/actions/secrets#get-an-environment-public-key"
|
|
37633
|
+
},
|
|
37634
|
+
"parameters": [
|
|
37635
|
+
{
|
|
37636
|
+
"$ref": "#/components/parameters/owner"
|
|
37637
|
+
},
|
|
37638
|
+
{
|
|
37639
|
+
"$ref": "#/components/parameters/repo"
|
|
37640
|
+
},
|
|
37641
|
+
{
|
|
37642
|
+
"$ref": "#/components/parameters/environment-name"
|
|
37643
|
+
}
|
|
37644
|
+
],
|
|
37645
|
+
"responses": {
|
|
37646
|
+
"200": {
|
|
37647
|
+
"description": "Response",
|
|
37648
|
+
"content": {
|
|
37649
|
+
"application/json": {
|
|
37650
|
+
"schema": {
|
|
37651
|
+
"$ref": "#/components/schemas/actions-public-key"
|
|
37652
|
+
},
|
|
37653
|
+
"examples": {
|
|
37654
|
+
"default": {
|
|
37655
|
+
"$ref": "#/components/examples/actions-public-key"
|
|
37656
|
+
}
|
|
37657
|
+
}
|
|
37658
|
+
}
|
|
37659
|
+
}
|
|
37660
|
+
}
|
|
37661
|
+
},
|
|
37662
|
+
"x-github": {
|
|
37663
|
+
"githubCloudOnly": false,
|
|
37664
|
+
"enabledForGitHubApps": true,
|
|
37665
|
+
"category": "actions",
|
|
37666
|
+
"subcategory": "secrets"
|
|
37667
|
+
},
|
|
37668
|
+
"x-octokit": {}
|
|
37669
|
+
}
|
|
37670
|
+
},
|
|
37671
|
+
"/repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}": {
|
|
37672
|
+
"get": {
|
|
37673
|
+
"summary": "Get an environment secret",
|
|
37674
|
+
"description": "Gets a single environment secret without revealing its encrypted value.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
|
|
37675
|
+
"tags": [
|
|
37676
|
+
"actions"
|
|
37677
|
+
],
|
|
37678
|
+
"operationId": "actions/get-environment-secret",
|
|
37679
|
+
"externalDocs": {
|
|
37680
|
+
"description": "API method documentation",
|
|
37681
|
+
"url": "https://docs.github.com/rest/actions/secrets#get-an-environment-secret"
|
|
37682
|
+
},
|
|
37683
|
+
"parameters": [
|
|
37684
|
+
{
|
|
37685
|
+
"$ref": "#/components/parameters/owner"
|
|
37686
|
+
},
|
|
37687
|
+
{
|
|
37688
|
+
"$ref": "#/components/parameters/repo"
|
|
37689
|
+
},
|
|
37690
|
+
{
|
|
37691
|
+
"$ref": "#/components/parameters/environment-name"
|
|
37692
|
+
},
|
|
37693
|
+
{
|
|
37694
|
+
"$ref": "#/components/parameters/secret-name"
|
|
37695
|
+
}
|
|
37696
|
+
],
|
|
37697
|
+
"responses": {
|
|
37698
|
+
"200": {
|
|
37699
|
+
"description": "Response",
|
|
37700
|
+
"content": {
|
|
37701
|
+
"application/json": {
|
|
37702
|
+
"schema": {
|
|
37703
|
+
"$ref": "#/components/schemas/actions-secret"
|
|
37704
|
+
},
|
|
37705
|
+
"examples": {
|
|
37706
|
+
"default": {
|
|
37707
|
+
"$ref": "#/components/examples/actions-secret"
|
|
37708
|
+
}
|
|
37709
|
+
}
|
|
37710
|
+
}
|
|
37711
|
+
}
|
|
37712
|
+
}
|
|
37713
|
+
},
|
|
37714
|
+
"x-github": {
|
|
37715
|
+
"githubCloudOnly": false,
|
|
37716
|
+
"enabledForGitHubApps": true,
|
|
37717
|
+
"category": "actions",
|
|
37718
|
+
"subcategory": "secrets"
|
|
37719
|
+
},
|
|
37720
|
+
"x-octokit": {}
|
|
37721
|
+
},
|
|
37722
|
+
"put": {
|
|
37723
|
+
"summary": "Create or update an environment secret",
|
|
37724
|
+
"description": "Creates or updates an environment secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
|
|
37725
|
+
"tags": [
|
|
37726
|
+
"actions"
|
|
37727
|
+
],
|
|
37728
|
+
"operationId": "actions/create-or-update-environment-secret",
|
|
37729
|
+
"externalDocs": {
|
|
37730
|
+
"description": "API method documentation",
|
|
37731
|
+
"url": "https://docs.github.com/rest/actions/secrets#create-or-update-an-environment-secret"
|
|
37732
|
+
},
|
|
37733
|
+
"parameters": [
|
|
37734
|
+
{
|
|
37735
|
+
"$ref": "#/components/parameters/owner"
|
|
37736
|
+
},
|
|
37737
|
+
{
|
|
37738
|
+
"$ref": "#/components/parameters/repo"
|
|
37739
|
+
},
|
|
37740
|
+
{
|
|
37741
|
+
"$ref": "#/components/parameters/environment-name"
|
|
37742
|
+
},
|
|
37743
|
+
{
|
|
37744
|
+
"$ref": "#/components/parameters/secret-name"
|
|
37745
|
+
}
|
|
37746
|
+
],
|
|
37747
|
+
"requestBody": {
|
|
37748
|
+
"required": true,
|
|
37749
|
+
"content": {
|
|
37750
|
+
"application/json": {
|
|
37751
|
+
"schema": {
|
|
37752
|
+
"type": "object",
|
|
37753
|
+
"properties": {
|
|
37754
|
+
"encrypted_value": {
|
|
37755
|
+
"type": "string",
|
|
37756
|
+
"description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https://docs.github.com/rest/actions/secrets#get-an-environment-public-key) endpoint.",
|
|
37757
|
+
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$"
|
|
37758
|
+
},
|
|
37759
|
+
"key_id": {
|
|
37760
|
+
"type": "string",
|
|
37761
|
+
"description": "ID of the key you used to encrypt the secret."
|
|
37762
|
+
}
|
|
37763
|
+
},
|
|
37764
|
+
"required": [
|
|
37765
|
+
"encrypted_value",
|
|
37766
|
+
"key_id"
|
|
37767
|
+
]
|
|
37768
|
+
},
|
|
37769
|
+
"examples": {
|
|
37770
|
+
"default": {
|
|
37771
|
+
"value": {
|
|
37772
|
+
"encrypted_value": "c2VjcmV0",
|
|
37773
|
+
"key_id": "012345678912345678"
|
|
37774
|
+
}
|
|
37775
|
+
}
|
|
37776
|
+
}
|
|
37777
|
+
}
|
|
37778
|
+
}
|
|
37779
|
+
},
|
|
37780
|
+
"responses": {
|
|
37781
|
+
"201": {
|
|
37782
|
+
"description": "Response when creating a secret",
|
|
37783
|
+
"content": {
|
|
37784
|
+
"application/json": {
|
|
37785
|
+
"schema": {
|
|
37786
|
+
"$ref": "#/components/schemas/empty-object"
|
|
37787
|
+
},
|
|
37788
|
+
"examples": {
|
|
37789
|
+
"default": {
|
|
37790
|
+
"value": null
|
|
37791
|
+
}
|
|
37792
|
+
}
|
|
37793
|
+
}
|
|
37794
|
+
}
|
|
37795
|
+
},
|
|
37796
|
+
"204": {
|
|
37797
|
+
"description": "Response when updating a secret"
|
|
37798
|
+
}
|
|
37799
|
+
},
|
|
37800
|
+
"x-github": {
|
|
37801
|
+
"githubCloudOnly": false,
|
|
37802
|
+
"enabledForGitHubApps": true,
|
|
37803
|
+
"category": "actions",
|
|
37804
|
+
"subcategory": "secrets"
|
|
37805
|
+
},
|
|
37806
|
+
"x-octokit": {}
|
|
37807
|
+
},
|
|
37808
|
+
"delete": {
|
|
37809
|
+
"summary": "Delete an environment secret",
|
|
37810
|
+
"description": "Deletes a secret in an environment using the secret name.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
|
|
37811
|
+
"tags": [
|
|
37812
|
+
"actions"
|
|
37813
|
+
],
|
|
37814
|
+
"operationId": "actions/delete-environment-secret",
|
|
37815
|
+
"externalDocs": {
|
|
37816
|
+
"description": "API method documentation",
|
|
37817
|
+
"url": "https://docs.github.com/rest/actions/secrets#delete-an-environment-secret"
|
|
37818
|
+
},
|
|
37819
|
+
"parameters": [
|
|
37820
|
+
{
|
|
37821
|
+
"$ref": "#/components/parameters/owner"
|
|
37822
|
+
},
|
|
37823
|
+
{
|
|
37824
|
+
"$ref": "#/components/parameters/repo"
|
|
37825
|
+
},
|
|
37826
|
+
{
|
|
37827
|
+
"$ref": "#/components/parameters/environment-name"
|
|
37828
|
+
},
|
|
37829
|
+
{
|
|
37830
|
+
"$ref": "#/components/parameters/secret-name"
|
|
37831
|
+
}
|
|
37832
|
+
],
|
|
37833
|
+
"responses": {
|
|
37834
|
+
"204": {
|
|
37835
|
+
"description": "Default response"
|
|
37836
|
+
}
|
|
37837
|
+
},
|
|
37838
|
+
"x-github": {
|
|
37839
|
+
"githubCloudOnly": false,
|
|
37840
|
+
"enabledForGitHubApps": true,
|
|
37841
|
+
"category": "actions",
|
|
37842
|
+
"subcategory": "secrets"
|
|
37843
|
+
},
|
|
37844
|
+
"x-octokit": {}
|
|
37845
|
+
}
|
|
37846
|
+
},
|
|
37847
|
+
"/repos/{owner}/{repo}/environments/{environment_name}/variables": {
|
|
37848
|
+
"get": {
|
|
37849
|
+
"summary": "List environment variables",
|
|
37850
|
+
"description": "Lists all environment variables.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
|
|
37851
|
+
"tags": [
|
|
37852
|
+
"actions"
|
|
37853
|
+
],
|
|
37854
|
+
"operationId": "actions/list-environment-variables",
|
|
37855
|
+
"externalDocs": {
|
|
37856
|
+
"description": "API method documentation",
|
|
37857
|
+
"url": "https://docs.github.com/rest/actions/variables#list-environment-variables"
|
|
37858
|
+
},
|
|
37859
|
+
"parameters": [
|
|
37860
|
+
{
|
|
37861
|
+
"$ref": "#/components/parameters/owner"
|
|
37862
|
+
},
|
|
37863
|
+
{
|
|
37864
|
+
"$ref": "#/components/parameters/repo"
|
|
37865
|
+
},
|
|
37866
|
+
{
|
|
37867
|
+
"$ref": "#/components/parameters/environment-name"
|
|
37868
|
+
},
|
|
37869
|
+
{
|
|
37870
|
+
"$ref": "#/components/parameters/variables-per-page"
|
|
37871
|
+
},
|
|
37872
|
+
{
|
|
37873
|
+
"$ref": "#/components/parameters/page"
|
|
37874
|
+
}
|
|
37875
|
+
],
|
|
37876
|
+
"responses": {
|
|
37877
|
+
"200": {
|
|
37878
|
+
"description": "Response",
|
|
37879
|
+
"content": {
|
|
37880
|
+
"application/json": {
|
|
37881
|
+
"schema": {
|
|
37882
|
+
"type": "object",
|
|
37883
|
+
"required": [
|
|
37884
|
+
"total_count",
|
|
37885
|
+
"variables"
|
|
37886
|
+
],
|
|
37887
|
+
"properties": {
|
|
37888
|
+
"total_count": {
|
|
37889
|
+
"type": "integer"
|
|
37890
|
+
},
|
|
37891
|
+
"variables": {
|
|
37892
|
+
"type": "array",
|
|
37893
|
+
"items": {
|
|
37894
|
+
"$ref": "#/components/schemas/actions-variable"
|
|
37895
|
+
}
|
|
37896
|
+
}
|
|
37897
|
+
}
|
|
37898
|
+
},
|
|
37899
|
+
"examples": {
|
|
37900
|
+
"default": {
|
|
37901
|
+
"$ref": "#/components/examples/actions-variables-paginated"
|
|
37902
|
+
}
|
|
37903
|
+
}
|
|
37904
|
+
}
|
|
37905
|
+
},
|
|
37906
|
+
"headers": {
|
|
37907
|
+
"Link": {
|
|
37908
|
+
"$ref": "#/components/headers/link"
|
|
37909
|
+
}
|
|
37910
|
+
}
|
|
37911
|
+
}
|
|
37912
|
+
},
|
|
37913
|
+
"x-github": {
|
|
37914
|
+
"githubCloudOnly": false,
|
|
37915
|
+
"enabledForGitHubApps": true,
|
|
37916
|
+
"category": "actions",
|
|
37917
|
+
"subcategory": "variables"
|
|
37918
|
+
},
|
|
37919
|
+
"x-octokit": {}
|
|
37920
|
+
},
|
|
37921
|
+
"post": {
|
|
37922
|
+
"summary": "Create an environment variable",
|
|
37923
|
+
"description": "Create an environment variable that you can reference in a GitHub Actions workflow.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
|
|
37924
|
+
"tags": [
|
|
37925
|
+
"actions"
|
|
37926
|
+
],
|
|
37927
|
+
"operationId": "actions/create-environment-variable",
|
|
37928
|
+
"externalDocs": {
|
|
37929
|
+
"description": "API method documentation",
|
|
37930
|
+
"url": "https://docs.github.com/rest/actions/variables#create-an-environment-variable"
|
|
37931
|
+
},
|
|
37932
|
+
"parameters": [
|
|
37933
|
+
{
|
|
37934
|
+
"$ref": "#/components/parameters/owner"
|
|
37935
|
+
},
|
|
37936
|
+
{
|
|
37937
|
+
"$ref": "#/components/parameters/repo"
|
|
37938
|
+
},
|
|
37939
|
+
{
|
|
37940
|
+
"$ref": "#/components/parameters/environment-name"
|
|
37941
|
+
}
|
|
37942
|
+
],
|
|
37943
|
+
"requestBody": {
|
|
37944
|
+
"required": true,
|
|
37945
|
+
"content": {
|
|
37946
|
+
"application/json": {
|
|
37947
|
+
"schema": {
|
|
37948
|
+
"type": "object",
|
|
37949
|
+
"properties": {
|
|
37950
|
+
"name": {
|
|
37951
|
+
"type": "string",
|
|
37952
|
+
"description": "The name of the variable."
|
|
37953
|
+
},
|
|
37954
|
+
"value": {
|
|
37955
|
+
"type": "string",
|
|
37956
|
+
"description": "The value of the variable."
|
|
37957
|
+
}
|
|
37958
|
+
},
|
|
37959
|
+
"required": [
|
|
37960
|
+
"name",
|
|
37961
|
+
"value"
|
|
37962
|
+
]
|
|
37963
|
+
},
|
|
37964
|
+
"examples": {
|
|
37965
|
+
"default": {
|
|
37966
|
+
"value": {
|
|
37967
|
+
"name": "USERNAME",
|
|
37968
|
+
"value": "octocat"
|
|
37969
|
+
}
|
|
37970
|
+
}
|
|
37971
|
+
}
|
|
37972
|
+
}
|
|
37973
|
+
}
|
|
37974
|
+
},
|
|
37975
|
+
"responses": {
|
|
37976
|
+
"201": {
|
|
37977
|
+
"description": "Response",
|
|
37978
|
+
"content": {
|
|
37979
|
+
"application/json": {
|
|
37980
|
+
"schema": {
|
|
37981
|
+
"$ref": "#/components/schemas/empty-object"
|
|
37982
|
+
},
|
|
37983
|
+
"examples": {
|
|
37984
|
+
"default": {
|
|
37985
|
+
"value": null
|
|
37986
|
+
}
|
|
37987
|
+
}
|
|
37988
|
+
}
|
|
37989
|
+
}
|
|
37990
|
+
}
|
|
37991
|
+
},
|
|
37992
|
+
"x-github": {
|
|
37993
|
+
"githubCloudOnly": false,
|
|
37994
|
+
"enabledForGitHubApps": true,
|
|
37995
|
+
"category": "actions",
|
|
37996
|
+
"subcategory": "variables"
|
|
37997
|
+
},
|
|
37998
|
+
"x-octokit": {}
|
|
37999
|
+
}
|
|
38000
|
+
},
|
|
38001
|
+
"/repos/{owner}/{repo}/environments/{environment_name}/variables/{name}": {
|
|
38002
|
+
"get": {
|
|
38003
|
+
"summary": "Get an environment variable",
|
|
38004
|
+
"description": "Gets a specific variable in an environment.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
|
|
38005
|
+
"tags": [
|
|
38006
|
+
"actions"
|
|
38007
|
+
],
|
|
38008
|
+
"operationId": "actions/get-environment-variable",
|
|
38009
|
+
"externalDocs": {
|
|
38010
|
+
"description": "API method documentation",
|
|
38011
|
+
"url": "https://docs.github.com/rest/actions/variables#get-an-environment-variable"
|
|
38012
|
+
},
|
|
38013
|
+
"parameters": [
|
|
38014
|
+
{
|
|
38015
|
+
"$ref": "#/components/parameters/owner"
|
|
38016
|
+
},
|
|
38017
|
+
{
|
|
38018
|
+
"$ref": "#/components/parameters/repo"
|
|
38019
|
+
},
|
|
38020
|
+
{
|
|
38021
|
+
"$ref": "#/components/parameters/environment-name"
|
|
38022
|
+
},
|
|
38023
|
+
{
|
|
38024
|
+
"$ref": "#/components/parameters/variable-name"
|
|
38025
|
+
}
|
|
38026
|
+
],
|
|
38027
|
+
"responses": {
|
|
38028
|
+
"200": {
|
|
38029
|
+
"description": "Response",
|
|
38030
|
+
"content": {
|
|
38031
|
+
"application/json": {
|
|
38032
|
+
"schema": {
|
|
38033
|
+
"$ref": "#/components/schemas/actions-variable"
|
|
38034
|
+
},
|
|
38035
|
+
"examples": {
|
|
38036
|
+
"default": {
|
|
38037
|
+
"$ref": "#/components/examples/actions-variable"
|
|
38038
|
+
}
|
|
38039
|
+
}
|
|
38040
|
+
}
|
|
38041
|
+
}
|
|
38042
|
+
}
|
|
38043
|
+
},
|
|
38044
|
+
"x-github": {
|
|
38045
|
+
"githubCloudOnly": false,
|
|
38046
|
+
"enabledForGitHubApps": true,
|
|
38047
|
+
"category": "actions",
|
|
38048
|
+
"subcategory": "variables"
|
|
38049
|
+
},
|
|
38050
|
+
"x-octokit": {}
|
|
38051
|
+
},
|
|
38052
|
+
"patch": {
|
|
38053
|
+
"summary": "Update an environment variable",
|
|
38054
|
+
"description": "Updates an environment variable that you can reference in a GitHub Actions workflow.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
|
|
38055
|
+
"tags": [
|
|
38056
|
+
"actions"
|
|
38057
|
+
],
|
|
38058
|
+
"operationId": "actions/update-environment-variable",
|
|
38059
|
+
"externalDocs": {
|
|
38060
|
+
"description": "API method documentation",
|
|
38061
|
+
"url": "https://docs.github.com/rest/actions/variables#update-an-environment-variable"
|
|
38062
|
+
},
|
|
38063
|
+
"parameters": [
|
|
38064
|
+
{
|
|
38065
|
+
"$ref": "#/components/parameters/owner"
|
|
38066
|
+
},
|
|
38067
|
+
{
|
|
38068
|
+
"$ref": "#/components/parameters/repo"
|
|
38069
|
+
},
|
|
38070
|
+
{
|
|
38071
|
+
"$ref": "#/components/parameters/variable-name"
|
|
38072
|
+
},
|
|
38073
|
+
{
|
|
38074
|
+
"$ref": "#/components/parameters/environment-name"
|
|
38075
|
+
}
|
|
38076
|
+
],
|
|
38077
|
+
"requestBody": {
|
|
38078
|
+
"required": true,
|
|
38079
|
+
"content": {
|
|
38080
|
+
"application/json": {
|
|
38081
|
+
"schema": {
|
|
38082
|
+
"type": "object",
|
|
38083
|
+
"properties": {
|
|
38084
|
+
"name": {
|
|
38085
|
+
"type": "string",
|
|
38086
|
+
"description": "The name of the variable."
|
|
38087
|
+
},
|
|
38088
|
+
"value": {
|
|
38089
|
+
"type": "string",
|
|
38090
|
+
"description": "The value of the variable."
|
|
38091
|
+
}
|
|
38092
|
+
}
|
|
38093
|
+
},
|
|
38094
|
+
"examples": {
|
|
38095
|
+
"default": {
|
|
38096
|
+
"value": {
|
|
38097
|
+
"name": "USERNAME",
|
|
38098
|
+
"value": "octocat"
|
|
38099
|
+
}
|
|
38100
|
+
}
|
|
38101
|
+
}
|
|
38102
|
+
}
|
|
38103
|
+
}
|
|
38104
|
+
},
|
|
38105
|
+
"responses": {
|
|
38106
|
+
"204": {
|
|
38107
|
+
"description": "Response"
|
|
38108
|
+
}
|
|
38109
|
+
},
|
|
38110
|
+
"x-github": {
|
|
38111
|
+
"githubCloudOnly": false,
|
|
38112
|
+
"enabledForGitHubApps": true,
|
|
38113
|
+
"category": "actions",
|
|
38114
|
+
"subcategory": "variables"
|
|
38115
|
+
},
|
|
38116
|
+
"x-octokit": {}
|
|
38117
|
+
},
|
|
38118
|
+
"delete": {
|
|
38119
|
+
"summary": "Delete an environment variable",
|
|
38120
|
+
"description": "Deletes an environment variable using the variable name.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
|
|
38121
|
+
"tags": [
|
|
38122
|
+
"actions"
|
|
38123
|
+
],
|
|
38124
|
+
"operationId": "actions/delete-environment-variable",
|
|
38125
|
+
"externalDocs": {
|
|
38126
|
+
"description": "API method documentation",
|
|
38127
|
+
"url": "https://docs.github.com/rest/actions/variables#delete-an-environment-variable"
|
|
38128
|
+
},
|
|
38129
|
+
"parameters": [
|
|
38130
|
+
{
|
|
38131
|
+
"$ref": "#/components/parameters/owner"
|
|
38132
|
+
},
|
|
38133
|
+
{
|
|
38134
|
+
"$ref": "#/components/parameters/repo"
|
|
38135
|
+
},
|
|
38136
|
+
{
|
|
38137
|
+
"$ref": "#/components/parameters/variable-name"
|
|
38138
|
+
},
|
|
38139
|
+
{
|
|
38140
|
+
"$ref": "#/components/parameters/environment-name"
|
|
38141
|
+
}
|
|
38142
|
+
],
|
|
38143
|
+
"responses": {
|
|
38144
|
+
"204": {
|
|
38145
|
+
"description": "Response"
|
|
38146
|
+
}
|
|
38147
|
+
},
|
|
38148
|
+
"x-github": {
|
|
38149
|
+
"githubCloudOnly": false,
|
|
38150
|
+
"enabledForGitHubApps": true,
|
|
38151
|
+
"category": "actions",
|
|
38152
|
+
"subcategory": "variables"
|
|
38153
|
+
},
|
|
38154
|
+
"x-octokit": {}
|
|
38155
|
+
}
|
|
38156
|
+
},
|
|
37532
38157
|
"/repos/{owner}/{repo}/events": {
|
|
37533
38158
|
"get": {
|
|
37534
38159
|
"summary": "List repository events",
|
|
@@ -37901,6 +38526,9 @@
|
|
|
37901
38526
|
"404": {
|
|
37902
38527
|
"$ref": "#/components/responses/not_found"
|
|
37903
38528
|
},
|
|
38529
|
+
"409": {
|
|
38530
|
+
"$ref": "#/components/responses/conflict"
|
|
38531
|
+
},
|
|
37904
38532
|
"422": {
|
|
37905
38533
|
"$ref": "#/components/responses/validation_failed"
|
|
37906
38534
|
}
|
|
@@ -38055,6 +38683,9 @@
|
|
|
38055
38683
|
"404": {
|
|
38056
38684
|
"$ref": "#/components/responses/not_found"
|
|
38057
38685
|
},
|
|
38686
|
+
"409": {
|
|
38687
|
+
"$ref": "#/components/responses/conflict"
|
|
38688
|
+
},
|
|
38058
38689
|
"422": {
|
|
38059
38690
|
"$ref": "#/components/responses/validation_failed"
|
|
38060
38691
|
}
|
|
@@ -38109,6 +38740,9 @@
|
|
|
38109
38740
|
},
|
|
38110
38741
|
"404": {
|
|
38111
38742
|
"$ref": "#/components/responses/not_found"
|
|
38743
|
+
},
|
|
38744
|
+
"409": {
|
|
38745
|
+
"$ref": "#/components/responses/conflict"
|
|
38112
38746
|
}
|
|
38113
38747
|
},
|
|
38114
38748
|
"x-github": {
|
|
@@ -38140,7 +38774,7 @@
|
|
|
38140
38774
|
"$ref": "#/components/parameters/repo"
|
|
38141
38775
|
},
|
|
38142
38776
|
{
|
|
38143
|
-
"$ref": "#/components/parameters/
|
|
38777
|
+
"$ref": "#/components/parameters/git-ref-only"
|
|
38144
38778
|
}
|
|
38145
38779
|
],
|
|
38146
38780
|
"responses": {
|
|
@@ -38166,6 +38800,9 @@
|
|
|
38166
38800
|
"$ref": "#/components/headers/link"
|
|
38167
38801
|
}
|
|
38168
38802
|
}
|
|
38803
|
+
},
|
|
38804
|
+
"409": {
|
|
38805
|
+
"$ref": "#/components/responses/conflict"
|
|
38169
38806
|
}
|
|
38170
38807
|
},
|
|
38171
38808
|
"x-github": {
|
|
@@ -38197,7 +38834,7 @@
|
|
|
38197
38834
|
"$ref": "#/components/parameters/repo"
|
|
38198
38835
|
},
|
|
38199
38836
|
{
|
|
38200
|
-
"$ref": "#/components/parameters/
|
|
38837
|
+
"$ref": "#/components/parameters/git-ref-only"
|
|
38201
38838
|
}
|
|
38202
38839
|
],
|
|
38203
38840
|
"responses": {
|
|
@@ -38218,6 +38855,9 @@
|
|
|
38218
38855
|
},
|
|
38219
38856
|
"404": {
|
|
38220
38857
|
"$ref": "#/components/responses/not_found"
|
|
38858
|
+
},
|
|
38859
|
+
"409": {
|
|
38860
|
+
"$ref": "#/components/responses/conflict"
|
|
38221
38861
|
}
|
|
38222
38862
|
},
|
|
38223
38863
|
"x-github": {
|
|
@@ -38305,6 +38945,9 @@
|
|
|
38305
38945
|
}
|
|
38306
38946
|
}
|
|
38307
38947
|
},
|
|
38948
|
+
"409": {
|
|
38949
|
+
"$ref": "#/components/responses/conflict"
|
|
38950
|
+
},
|
|
38308
38951
|
"422": {
|
|
38309
38952
|
"$ref": "#/components/responses/validation_failed"
|
|
38310
38953
|
}
|
|
@@ -38321,7 +38964,7 @@
|
|
|
38321
38964
|
"/repos/{owner}/{repo}/git/refs/{ref}": {
|
|
38322
38965
|
"patch": {
|
|
38323
38966
|
"summary": "Update a reference",
|
|
38324
|
-
"description": "",
|
|
38967
|
+
"description": "Updates the provided reference to point to a new SHA. For more information, see \"[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)\" in the Git documentation.",
|
|
38325
38968
|
"tags": [
|
|
38326
38969
|
"git"
|
|
38327
38970
|
],
|
|
@@ -38338,15 +38981,7 @@
|
|
|
38338
38981
|
"$ref": "#/components/parameters/repo"
|
|
38339
38982
|
},
|
|
38340
38983
|
{
|
|
38341
|
-
"
|
|
38342
|
-
"description": "The name of the reference to update (for example, `heads/featureA`). Can be a branch name (`heads/BRANCH_NAME`) or tag name (`tags/TAG_NAME`). For more information, see \"[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)\" in the Git documentation.",
|
|
38343
|
-
"in": "path",
|
|
38344
|
-
"required": true,
|
|
38345
|
-
"example": "heads/featureA",
|
|
38346
|
-
"schema": {
|
|
38347
|
-
"type": "string"
|
|
38348
|
-
},
|
|
38349
|
-
"x-multi-segment": true
|
|
38984
|
+
"$ref": "#/components/parameters/git-ref-only"
|
|
38350
38985
|
}
|
|
38351
38986
|
],
|
|
38352
38987
|
"requestBody": {
|
|
@@ -38397,6 +39032,9 @@
|
|
|
38397
39032
|
}
|
|
38398
39033
|
}
|
|
38399
39034
|
},
|
|
39035
|
+
"409": {
|
|
39036
|
+
"$ref": "#/components/responses/conflict"
|
|
39037
|
+
},
|
|
38400
39038
|
"422": {
|
|
38401
39039
|
"$ref": "#/components/responses/validation_failed"
|
|
38402
39040
|
}
|
|
@@ -38411,7 +39049,7 @@
|
|
|
38411
39049
|
},
|
|
38412
39050
|
"delete": {
|
|
38413
39051
|
"summary": "Delete a reference",
|
|
38414
|
-
"description": "",
|
|
39052
|
+
"description": "Deletes the provided reference.",
|
|
38415
39053
|
"tags": [
|
|
38416
39054
|
"git"
|
|
38417
39055
|
],
|
|
@@ -38428,13 +39066,16 @@
|
|
|
38428
39066
|
"$ref": "#/components/parameters/repo"
|
|
38429
39067
|
},
|
|
38430
39068
|
{
|
|
38431
|
-
"$ref": "#/components/parameters/
|
|
39069
|
+
"$ref": "#/components/parameters/git-ref-only"
|
|
38432
39070
|
}
|
|
38433
39071
|
],
|
|
38434
39072
|
"responses": {
|
|
38435
39073
|
"204": {
|
|
38436
39074
|
"description": "Response"
|
|
38437
39075
|
},
|
|
39076
|
+
"409": {
|
|
39077
|
+
"$ref": "#/components/responses/conflict"
|
|
39078
|
+
},
|
|
38438
39079
|
"422": {
|
|
38439
39080
|
"$ref": "#/components/responses/validation_failed"
|
|
38440
39081
|
}
|
|
@@ -38569,6 +39210,9 @@
|
|
|
38569
39210
|
}
|
|
38570
39211
|
}
|
|
38571
39212
|
},
|
|
39213
|
+
"409": {
|
|
39214
|
+
"$ref": "#/components/responses/conflict"
|
|
39215
|
+
},
|
|
38572
39216
|
"422": {
|
|
38573
39217
|
"$ref": "#/components/responses/validation_failed"
|
|
38574
39218
|
}
|
|
@@ -38628,6 +39272,9 @@
|
|
|
38628
39272
|
},
|
|
38629
39273
|
"404": {
|
|
38630
39274
|
"$ref": "#/components/responses/not_found"
|
|
39275
|
+
},
|
|
39276
|
+
"409": {
|
|
39277
|
+
"$ref": "#/components/responses/conflict"
|
|
38631
39278
|
}
|
|
38632
39279
|
},
|
|
38633
39280
|
"x-github": {
|
|
@@ -38765,6 +39412,9 @@
|
|
|
38765
39412
|
"404": {
|
|
38766
39413
|
"$ref": "#/components/responses/not_found"
|
|
38767
39414
|
},
|
|
39415
|
+
"409": {
|
|
39416
|
+
"$ref": "#/components/responses/conflict"
|
|
39417
|
+
},
|
|
38768
39418
|
"422": {
|
|
38769
39419
|
"$ref": "#/components/responses/validation_failed"
|
|
38770
39420
|
}
|
|
@@ -38839,6 +39489,9 @@
|
|
|
38839
39489
|
"404": {
|
|
38840
39490
|
"$ref": "#/components/responses/not_found"
|
|
38841
39491
|
},
|
|
39492
|
+
"409": {
|
|
39493
|
+
"$ref": "#/components/responses/conflict"
|
|
39494
|
+
},
|
|
38842
39495
|
"422": {
|
|
38843
39496
|
"$ref": "#/components/responses/validation_failed"
|
|
38844
39497
|
}
|
|
@@ -43706,6 +44359,9 @@
|
|
|
43706
44359
|
},
|
|
43707
44360
|
{
|
|
43708
44361
|
"$ref": "#/components/parameters/repo"
|
|
44362
|
+
},
|
|
44363
|
+
{
|
|
44364
|
+
"$ref": "#/components/parameters/git-ref"
|
|
43709
44365
|
}
|
|
43710
44366
|
],
|
|
43711
44367
|
"responses": {
|
|
@@ -45342,6 +45998,64 @@
|
|
|
45342
45998
|
}
|
|
45343
45999
|
},
|
|
45344
46000
|
"/repos/{owner}/{repo}/private-vulnerability-reporting": {
|
|
46001
|
+
"get": {
|
|
46002
|
+
"summary": "Check if private vulnerability reporting is enabled for a repository",
|
|
46003
|
+
"description": "Returns a boolean indicating whether or not private vulnerability reporting is enabled for the repository. For more information, see \"[Evaluating the security settings of a repository](https://docs.github.com/code-security/security-advisories/working-with-repository-security-advisories/evaluating-the-security-settings-of-a-repository)\".",
|
|
46004
|
+
"tags": [
|
|
46005
|
+
"repos"
|
|
46006
|
+
],
|
|
46007
|
+
"operationId": "repos/check-private-vulnerability-reporting",
|
|
46008
|
+
"externalDocs": {
|
|
46009
|
+
"description": "API method documentation",
|
|
46010
|
+
"url": "https://docs.github.com/rest/repos/repos#check-if-private-vulnerability-reporting-is-enabled-for-a-repository"
|
|
46011
|
+
},
|
|
46012
|
+
"parameters": [
|
|
46013
|
+
{
|
|
46014
|
+
"$ref": "#/components/parameters/owner"
|
|
46015
|
+
},
|
|
46016
|
+
{
|
|
46017
|
+
"$ref": "#/components/parameters/repo"
|
|
46018
|
+
}
|
|
46019
|
+
],
|
|
46020
|
+
"responses": {
|
|
46021
|
+
"200": {
|
|
46022
|
+
"description": "Private vulnerability reporting status",
|
|
46023
|
+
"content": {
|
|
46024
|
+
"application/json": {
|
|
46025
|
+
"schema": {
|
|
46026
|
+
"type": "object",
|
|
46027
|
+
"properties": {
|
|
46028
|
+
"enabled": {
|
|
46029
|
+
"type": "boolean",
|
|
46030
|
+
"description": "Whether or not private vulnerability reporting is enabled for the repository."
|
|
46031
|
+
}
|
|
46032
|
+
},
|
|
46033
|
+
"required": [
|
|
46034
|
+
"enabled"
|
|
46035
|
+
]
|
|
46036
|
+
},
|
|
46037
|
+
"examples": {
|
|
46038
|
+
"default": {
|
|
46039
|
+
"value": {
|
|
46040
|
+
"enabled": true
|
|
46041
|
+
}
|
|
46042
|
+
}
|
|
46043
|
+
}
|
|
46044
|
+
}
|
|
46045
|
+
}
|
|
46046
|
+
},
|
|
46047
|
+
"422": {
|
|
46048
|
+
"$ref": "#/components/responses/bad_request"
|
|
46049
|
+
}
|
|
46050
|
+
},
|
|
46051
|
+
"x-github": {
|
|
46052
|
+
"githubCloudOnly": false,
|
|
46053
|
+
"enabledForGitHubApps": true,
|
|
46054
|
+
"category": "repos",
|
|
46055
|
+
"subcategory": "repos"
|
|
46056
|
+
},
|
|
46057
|
+
"x-octokit": {}
|
|
46058
|
+
},
|
|
45345
46059
|
"put": {
|
|
45346
46060
|
"summary": "Enable private vulnerability reporting for a repository",
|
|
45347
46061
|
"description": "Enables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see \"[Privately reporting a security vulnerability](https://docs.github.com/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability).\"",
|
|
@@ -53062,586 +53776,6 @@
|
|
|
53062
53776
|
"x-octokit": {}
|
|
53063
53777
|
}
|
|
53064
53778
|
},
|
|
53065
|
-
"/repositories/{repository_id}/environments/{environment_name}/secrets": {
|
|
53066
|
-
"get": {
|
|
53067
|
-
"summary": "List environment secrets",
|
|
53068
|
-
"description": "Lists all secrets available in an environment without revealing their\nencrypted values.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
|
|
53069
|
-
"tags": [
|
|
53070
|
-
"actions"
|
|
53071
|
-
],
|
|
53072
|
-
"operationId": "actions/list-environment-secrets",
|
|
53073
|
-
"externalDocs": {
|
|
53074
|
-
"description": "API method documentation",
|
|
53075
|
-
"url": "https://docs.github.com/rest/actions/secrets#list-environment-secrets"
|
|
53076
|
-
},
|
|
53077
|
-
"parameters": [
|
|
53078
|
-
{
|
|
53079
|
-
"$ref": "#/components/parameters/repository-id"
|
|
53080
|
-
},
|
|
53081
|
-
{
|
|
53082
|
-
"$ref": "#/components/parameters/environment-name"
|
|
53083
|
-
},
|
|
53084
|
-
{
|
|
53085
|
-
"$ref": "#/components/parameters/per-page"
|
|
53086
|
-
},
|
|
53087
|
-
{
|
|
53088
|
-
"$ref": "#/components/parameters/page"
|
|
53089
|
-
}
|
|
53090
|
-
],
|
|
53091
|
-
"responses": {
|
|
53092
|
-
"200": {
|
|
53093
|
-
"description": "Response",
|
|
53094
|
-
"content": {
|
|
53095
|
-
"application/json": {
|
|
53096
|
-
"schema": {
|
|
53097
|
-
"type": "object",
|
|
53098
|
-
"required": [
|
|
53099
|
-
"total_count",
|
|
53100
|
-
"secrets"
|
|
53101
|
-
],
|
|
53102
|
-
"properties": {
|
|
53103
|
-
"total_count": {
|
|
53104
|
-
"type": "integer"
|
|
53105
|
-
},
|
|
53106
|
-
"secrets": {
|
|
53107
|
-
"type": "array",
|
|
53108
|
-
"items": {
|
|
53109
|
-
"$ref": "#/components/schemas/actions-secret"
|
|
53110
|
-
}
|
|
53111
|
-
}
|
|
53112
|
-
}
|
|
53113
|
-
},
|
|
53114
|
-
"examples": {
|
|
53115
|
-
"default": {
|
|
53116
|
-
"$ref": "#/components/examples/actions-secret-paginated"
|
|
53117
|
-
}
|
|
53118
|
-
}
|
|
53119
|
-
}
|
|
53120
|
-
},
|
|
53121
|
-
"headers": {
|
|
53122
|
-
"Link": {
|
|
53123
|
-
"$ref": "#/components/headers/link"
|
|
53124
|
-
}
|
|
53125
|
-
}
|
|
53126
|
-
}
|
|
53127
|
-
},
|
|
53128
|
-
"x-github": {
|
|
53129
|
-
"githubCloudOnly": false,
|
|
53130
|
-
"enabledForGitHubApps": true,
|
|
53131
|
-
"category": "actions",
|
|
53132
|
-
"subcategory": "secrets"
|
|
53133
|
-
},
|
|
53134
|
-
"x-octokit": {}
|
|
53135
|
-
}
|
|
53136
|
-
},
|
|
53137
|
-
"/repositories/{repository_id}/environments/{environment_name}/secrets/public-key": {
|
|
53138
|
-
"get": {
|
|
53139
|
-
"summary": "Get an environment public key",
|
|
53140
|
-
"description": "Get the public key for an environment, which you need to encrypt environment\nsecrets. You need to encrypt a secret before you can create or update secrets.\n\nAnyone with read access to the repository can use this endpoint.\n\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
|
|
53141
|
-
"tags": [
|
|
53142
|
-
"actions"
|
|
53143
|
-
],
|
|
53144
|
-
"operationId": "actions/get-environment-public-key",
|
|
53145
|
-
"externalDocs": {
|
|
53146
|
-
"description": "API method documentation",
|
|
53147
|
-
"url": "https://docs.github.com/rest/actions/secrets#get-an-environment-public-key"
|
|
53148
|
-
},
|
|
53149
|
-
"parameters": [
|
|
53150
|
-
{
|
|
53151
|
-
"$ref": "#/components/parameters/repository-id"
|
|
53152
|
-
},
|
|
53153
|
-
{
|
|
53154
|
-
"$ref": "#/components/parameters/environment-name"
|
|
53155
|
-
}
|
|
53156
|
-
],
|
|
53157
|
-
"responses": {
|
|
53158
|
-
"200": {
|
|
53159
|
-
"description": "Response",
|
|
53160
|
-
"content": {
|
|
53161
|
-
"application/json": {
|
|
53162
|
-
"schema": {
|
|
53163
|
-
"$ref": "#/components/schemas/actions-public-key"
|
|
53164
|
-
},
|
|
53165
|
-
"examples": {
|
|
53166
|
-
"default": {
|
|
53167
|
-
"$ref": "#/components/examples/actions-public-key"
|
|
53168
|
-
}
|
|
53169
|
-
}
|
|
53170
|
-
}
|
|
53171
|
-
}
|
|
53172
|
-
}
|
|
53173
|
-
},
|
|
53174
|
-
"x-github": {
|
|
53175
|
-
"githubCloudOnly": false,
|
|
53176
|
-
"enabledForGitHubApps": true,
|
|
53177
|
-
"category": "actions",
|
|
53178
|
-
"subcategory": "secrets"
|
|
53179
|
-
},
|
|
53180
|
-
"x-octokit": {}
|
|
53181
|
-
}
|
|
53182
|
-
},
|
|
53183
|
-
"/repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}": {
|
|
53184
|
-
"get": {
|
|
53185
|
-
"summary": "Get an environment secret",
|
|
53186
|
-
"description": "Gets a single environment secret without revealing its encrypted value.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
|
|
53187
|
-
"tags": [
|
|
53188
|
-
"actions"
|
|
53189
|
-
],
|
|
53190
|
-
"operationId": "actions/get-environment-secret",
|
|
53191
|
-
"externalDocs": {
|
|
53192
|
-
"description": "API method documentation",
|
|
53193
|
-
"url": "https://docs.github.com/rest/actions/secrets#get-an-environment-secret"
|
|
53194
|
-
},
|
|
53195
|
-
"parameters": [
|
|
53196
|
-
{
|
|
53197
|
-
"$ref": "#/components/parameters/repository-id"
|
|
53198
|
-
},
|
|
53199
|
-
{
|
|
53200
|
-
"$ref": "#/components/parameters/environment-name"
|
|
53201
|
-
},
|
|
53202
|
-
{
|
|
53203
|
-
"$ref": "#/components/parameters/secret-name"
|
|
53204
|
-
}
|
|
53205
|
-
],
|
|
53206
|
-
"responses": {
|
|
53207
|
-
"200": {
|
|
53208
|
-
"description": "Response",
|
|
53209
|
-
"content": {
|
|
53210
|
-
"application/json": {
|
|
53211
|
-
"schema": {
|
|
53212
|
-
"$ref": "#/components/schemas/actions-secret"
|
|
53213
|
-
},
|
|
53214
|
-
"examples": {
|
|
53215
|
-
"default": {
|
|
53216
|
-
"$ref": "#/components/examples/actions-secret"
|
|
53217
|
-
}
|
|
53218
|
-
}
|
|
53219
|
-
}
|
|
53220
|
-
}
|
|
53221
|
-
}
|
|
53222
|
-
},
|
|
53223
|
-
"x-github": {
|
|
53224
|
-
"githubCloudOnly": false,
|
|
53225
|
-
"enabledForGitHubApps": true,
|
|
53226
|
-
"category": "actions",
|
|
53227
|
-
"subcategory": "secrets"
|
|
53228
|
-
},
|
|
53229
|
-
"x-octokit": {}
|
|
53230
|
-
},
|
|
53231
|
-
"put": {
|
|
53232
|
-
"summary": "Create or update an environment secret",
|
|
53233
|
-
"description": "Creates or updates an environment secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
|
|
53234
|
-
"tags": [
|
|
53235
|
-
"actions"
|
|
53236
|
-
],
|
|
53237
|
-
"operationId": "actions/create-or-update-environment-secret",
|
|
53238
|
-
"externalDocs": {
|
|
53239
|
-
"description": "API method documentation",
|
|
53240
|
-
"url": "https://docs.github.com/rest/actions/secrets#create-or-update-an-environment-secret"
|
|
53241
|
-
},
|
|
53242
|
-
"parameters": [
|
|
53243
|
-
{
|
|
53244
|
-
"$ref": "#/components/parameters/repository-id"
|
|
53245
|
-
},
|
|
53246
|
-
{
|
|
53247
|
-
"$ref": "#/components/parameters/environment-name"
|
|
53248
|
-
},
|
|
53249
|
-
{
|
|
53250
|
-
"$ref": "#/components/parameters/secret-name"
|
|
53251
|
-
}
|
|
53252
|
-
],
|
|
53253
|
-
"requestBody": {
|
|
53254
|
-
"required": true,
|
|
53255
|
-
"content": {
|
|
53256
|
-
"application/json": {
|
|
53257
|
-
"schema": {
|
|
53258
|
-
"type": "object",
|
|
53259
|
-
"properties": {
|
|
53260
|
-
"encrypted_value": {
|
|
53261
|
-
"type": "string",
|
|
53262
|
-
"description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https://docs.github.com/rest/actions/secrets#get-an-environment-public-key) endpoint.",
|
|
53263
|
-
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$"
|
|
53264
|
-
},
|
|
53265
|
-
"key_id": {
|
|
53266
|
-
"type": "string",
|
|
53267
|
-
"description": "ID of the key you used to encrypt the secret."
|
|
53268
|
-
}
|
|
53269
|
-
},
|
|
53270
|
-
"required": [
|
|
53271
|
-
"encrypted_value",
|
|
53272
|
-
"key_id"
|
|
53273
|
-
]
|
|
53274
|
-
},
|
|
53275
|
-
"examples": {
|
|
53276
|
-
"default": {
|
|
53277
|
-
"value": {
|
|
53278
|
-
"encrypted_value": "c2VjcmV0",
|
|
53279
|
-
"key_id": "012345678912345678"
|
|
53280
|
-
}
|
|
53281
|
-
}
|
|
53282
|
-
}
|
|
53283
|
-
}
|
|
53284
|
-
}
|
|
53285
|
-
},
|
|
53286
|
-
"responses": {
|
|
53287
|
-
"201": {
|
|
53288
|
-
"description": "Response when creating a secret",
|
|
53289
|
-
"content": {
|
|
53290
|
-
"application/json": {
|
|
53291
|
-
"schema": {
|
|
53292
|
-
"$ref": "#/components/schemas/empty-object"
|
|
53293
|
-
},
|
|
53294
|
-
"examples": {
|
|
53295
|
-
"default": {
|
|
53296
|
-
"value": null
|
|
53297
|
-
}
|
|
53298
|
-
}
|
|
53299
|
-
}
|
|
53300
|
-
}
|
|
53301
|
-
},
|
|
53302
|
-
"204": {
|
|
53303
|
-
"description": "Response when updating a secret"
|
|
53304
|
-
}
|
|
53305
|
-
},
|
|
53306
|
-
"x-github": {
|
|
53307
|
-
"githubCloudOnly": false,
|
|
53308
|
-
"enabledForGitHubApps": true,
|
|
53309
|
-
"category": "actions",
|
|
53310
|
-
"subcategory": "secrets"
|
|
53311
|
-
},
|
|
53312
|
-
"x-octokit": {}
|
|
53313
|
-
},
|
|
53314
|
-
"delete": {
|
|
53315
|
-
"summary": "Delete an environment secret",
|
|
53316
|
-
"description": "Deletes a secret in an environment using the secret name.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
|
|
53317
|
-
"tags": [
|
|
53318
|
-
"actions"
|
|
53319
|
-
],
|
|
53320
|
-
"operationId": "actions/delete-environment-secret",
|
|
53321
|
-
"externalDocs": {
|
|
53322
|
-
"description": "API method documentation",
|
|
53323
|
-
"url": "https://docs.github.com/rest/actions/secrets#delete-an-environment-secret"
|
|
53324
|
-
},
|
|
53325
|
-
"parameters": [
|
|
53326
|
-
{
|
|
53327
|
-
"$ref": "#/components/parameters/repository-id"
|
|
53328
|
-
},
|
|
53329
|
-
{
|
|
53330
|
-
"$ref": "#/components/parameters/environment-name"
|
|
53331
|
-
},
|
|
53332
|
-
{
|
|
53333
|
-
"$ref": "#/components/parameters/secret-name"
|
|
53334
|
-
}
|
|
53335
|
-
],
|
|
53336
|
-
"responses": {
|
|
53337
|
-
"204": {
|
|
53338
|
-
"description": "Default response"
|
|
53339
|
-
}
|
|
53340
|
-
},
|
|
53341
|
-
"x-github": {
|
|
53342
|
-
"githubCloudOnly": false,
|
|
53343
|
-
"enabledForGitHubApps": true,
|
|
53344
|
-
"category": "actions",
|
|
53345
|
-
"subcategory": "secrets"
|
|
53346
|
-
},
|
|
53347
|
-
"x-octokit": {}
|
|
53348
|
-
}
|
|
53349
|
-
},
|
|
53350
|
-
"/repositories/{repository_id}/environments/{environment_name}/variables": {
|
|
53351
|
-
"get": {
|
|
53352
|
-
"summary": "List environment variables",
|
|
53353
|
-
"description": "Lists all environment variables.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
|
|
53354
|
-
"tags": [
|
|
53355
|
-
"actions"
|
|
53356
|
-
],
|
|
53357
|
-
"operationId": "actions/list-environment-variables",
|
|
53358
|
-
"externalDocs": {
|
|
53359
|
-
"description": "API method documentation",
|
|
53360
|
-
"url": "https://docs.github.com/rest/actions/variables#list-environment-variables"
|
|
53361
|
-
},
|
|
53362
|
-
"parameters": [
|
|
53363
|
-
{
|
|
53364
|
-
"$ref": "#/components/parameters/repository-id"
|
|
53365
|
-
},
|
|
53366
|
-
{
|
|
53367
|
-
"$ref": "#/components/parameters/environment-name"
|
|
53368
|
-
},
|
|
53369
|
-
{
|
|
53370
|
-
"$ref": "#/components/parameters/variables-per-page"
|
|
53371
|
-
},
|
|
53372
|
-
{
|
|
53373
|
-
"$ref": "#/components/parameters/page"
|
|
53374
|
-
}
|
|
53375
|
-
],
|
|
53376
|
-
"responses": {
|
|
53377
|
-
"200": {
|
|
53378
|
-
"description": "Response",
|
|
53379
|
-
"content": {
|
|
53380
|
-
"application/json": {
|
|
53381
|
-
"schema": {
|
|
53382
|
-
"type": "object",
|
|
53383
|
-
"required": [
|
|
53384
|
-
"total_count",
|
|
53385
|
-
"variables"
|
|
53386
|
-
],
|
|
53387
|
-
"properties": {
|
|
53388
|
-
"total_count": {
|
|
53389
|
-
"type": "integer"
|
|
53390
|
-
},
|
|
53391
|
-
"variables": {
|
|
53392
|
-
"type": "array",
|
|
53393
|
-
"items": {
|
|
53394
|
-
"$ref": "#/components/schemas/actions-variable"
|
|
53395
|
-
}
|
|
53396
|
-
}
|
|
53397
|
-
}
|
|
53398
|
-
},
|
|
53399
|
-
"examples": {
|
|
53400
|
-
"default": {
|
|
53401
|
-
"$ref": "#/components/examples/actions-variables-paginated"
|
|
53402
|
-
}
|
|
53403
|
-
}
|
|
53404
|
-
}
|
|
53405
|
-
},
|
|
53406
|
-
"headers": {
|
|
53407
|
-
"Link": {
|
|
53408
|
-
"$ref": "#/components/headers/link"
|
|
53409
|
-
}
|
|
53410
|
-
}
|
|
53411
|
-
}
|
|
53412
|
-
},
|
|
53413
|
-
"x-github": {
|
|
53414
|
-
"githubCloudOnly": false,
|
|
53415
|
-
"enabledForGitHubApps": true,
|
|
53416
|
-
"category": "actions",
|
|
53417
|
-
"subcategory": "variables"
|
|
53418
|
-
},
|
|
53419
|
-
"x-octokit": {}
|
|
53420
|
-
},
|
|
53421
|
-
"post": {
|
|
53422
|
-
"summary": "Create an environment variable",
|
|
53423
|
-
"description": "Create an environment variable that you can reference in a GitHub Actions workflow.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
|
|
53424
|
-
"tags": [
|
|
53425
|
-
"actions"
|
|
53426
|
-
],
|
|
53427
|
-
"operationId": "actions/create-environment-variable",
|
|
53428
|
-
"externalDocs": {
|
|
53429
|
-
"description": "API method documentation",
|
|
53430
|
-
"url": "https://docs.github.com/rest/actions/variables#create-an-environment-variable"
|
|
53431
|
-
},
|
|
53432
|
-
"parameters": [
|
|
53433
|
-
{
|
|
53434
|
-
"$ref": "#/components/parameters/repository-id"
|
|
53435
|
-
},
|
|
53436
|
-
{
|
|
53437
|
-
"$ref": "#/components/parameters/environment-name"
|
|
53438
|
-
}
|
|
53439
|
-
],
|
|
53440
|
-
"requestBody": {
|
|
53441
|
-
"required": true,
|
|
53442
|
-
"content": {
|
|
53443
|
-
"application/json": {
|
|
53444
|
-
"schema": {
|
|
53445
|
-
"type": "object",
|
|
53446
|
-
"properties": {
|
|
53447
|
-
"name": {
|
|
53448
|
-
"type": "string",
|
|
53449
|
-
"description": "The name of the variable."
|
|
53450
|
-
},
|
|
53451
|
-
"value": {
|
|
53452
|
-
"type": "string",
|
|
53453
|
-
"description": "The value of the variable."
|
|
53454
|
-
}
|
|
53455
|
-
},
|
|
53456
|
-
"required": [
|
|
53457
|
-
"name",
|
|
53458
|
-
"value"
|
|
53459
|
-
]
|
|
53460
|
-
},
|
|
53461
|
-
"examples": {
|
|
53462
|
-
"default": {
|
|
53463
|
-
"value": {
|
|
53464
|
-
"name": "USERNAME",
|
|
53465
|
-
"value": "octocat"
|
|
53466
|
-
}
|
|
53467
|
-
}
|
|
53468
|
-
}
|
|
53469
|
-
}
|
|
53470
|
-
}
|
|
53471
|
-
},
|
|
53472
|
-
"responses": {
|
|
53473
|
-
"201": {
|
|
53474
|
-
"description": "Response",
|
|
53475
|
-
"content": {
|
|
53476
|
-
"application/json": {
|
|
53477
|
-
"schema": {
|
|
53478
|
-
"$ref": "#/components/schemas/empty-object"
|
|
53479
|
-
},
|
|
53480
|
-
"examples": {
|
|
53481
|
-
"default": {
|
|
53482
|
-
"value": null
|
|
53483
|
-
}
|
|
53484
|
-
}
|
|
53485
|
-
}
|
|
53486
|
-
}
|
|
53487
|
-
}
|
|
53488
|
-
},
|
|
53489
|
-
"x-github": {
|
|
53490
|
-
"githubCloudOnly": false,
|
|
53491
|
-
"enabledForGitHubApps": true,
|
|
53492
|
-
"category": "actions",
|
|
53493
|
-
"subcategory": "variables"
|
|
53494
|
-
},
|
|
53495
|
-
"x-octokit": {}
|
|
53496
|
-
}
|
|
53497
|
-
},
|
|
53498
|
-
"/repositories/{repository_id}/environments/{environment_name}/variables/{name}": {
|
|
53499
|
-
"get": {
|
|
53500
|
-
"summary": "Get an environment variable",
|
|
53501
|
-
"description": "Gets a specific variable in an environment.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
|
|
53502
|
-
"tags": [
|
|
53503
|
-
"actions"
|
|
53504
|
-
],
|
|
53505
|
-
"operationId": "actions/get-environment-variable",
|
|
53506
|
-
"externalDocs": {
|
|
53507
|
-
"description": "API method documentation",
|
|
53508
|
-
"url": "https://docs.github.com/rest/actions/variables#get-an-environment-variable"
|
|
53509
|
-
},
|
|
53510
|
-
"parameters": [
|
|
53511
|
-
{
|
|
53512
|
-
"$ref": "#/components/parameters/repository-id"
|
|
53513
|
-
},
|
|
53514
|
-
{
|
|
53515
|
-
"$ref": "#/components/parameters/environment-name"
|
|
53516
|
-
},
|
|
53517
|
-
{
|
|
53518
|
-
"$ref": "#/components/parameters/variable-name"
|
|
53519
|
-
}
|
|
53520
|
-
],
|
|
53521
|
-
"responses": {
|
|
53522
|
-
"200": {
|
|
53523
|
-
"description": "Response",
|
|
53524
|
-
"content": {
|
|
53525
|
-
"application/json": {
|
|
53526
|
-
"schema": {
|
|
53527
|
-
"$ref": "#/components/schemas/actions-variable"
|
|
53528
|
-
},
|
|
53529
|
-
"examples": {
|
|
53530
|
-
"default": {
|
|
53531
|
-
"$ref": "#/components/examples/actions-variable"
|
|
53532
|
-
}
|
|
53533
|
-
}
|
|
53534
|
-
}
|
|
53535
|
-
}
|
|
53536
|
-
}
|
|
53537
|
-
},
|
|
53538
|
-
"x-github": {
|
|
53539
|
-
"githubCloudOnly": false,
|
|
53540
|
-
"enabledForGitHubApps": true,
|
|
53541
|
-
"category": "actions",
|
|
53542
|
-
"subcategory": "variables"
|
|
53543
|
-
},
|
|
53544
|
-
"x-octokit": {}
|
|
53545
|
-
},
|
|
53546
|
-
"patch": {
|
|
53547
|
-
"summary": "Update an environment variable",
|
|
53548
|
-
"description": "Updates an environment variable that you can reference in a GitHub Actions workflow.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
|
|
53549
|
-
"tags": [
|
|
53550
|
-
"actions"
|
|
53551
|
-
],
|
|
53552
|
-
"operationId": "actions/update-environment-variable",
|
|
53553
|
-
"externalDocs": {
|
|
53554
|
-
"description": "API method documentation",
|
|
53555
|
-
"url": "https://docs.github.com/rest/actions/variables#update-an-environment-variable"
|
|
53556
|
-
},
|
|
53557
|
-
"parameters": [
|
|
53558
|
-
{
|
|
53559
|
-
"$ref": "#/components/parameters/repository-id"
|
|
53560
|
-
},
|
|
53561
|
-
{
|
|
53562
|
-
"$ref": "#/components/parameters/variable-name"
|
|
53563
|
-
},
|
|
53564
|
-
{
|
|
53565
|
-
"$ref": "#/components/parameters/environment-name"
|
|
53566
|
-
}
|
|
53567
|
-
],
|
|
53568
|
-
"requestBody": {
|
|
53569
|
-
"required": true,
|
|
53570
|
-
"content": {
|
|
53571
|
-
"application/json": {
|
|
53572
|
-
"schema": {
|
|
53573
|
-
"type": "object",
|
|
53574
|
-
"properties": {
|
|
53575
|
-
"name": {
|
|
53576
|
-
"type": "string",
|
|
53577
|
-
"description": "The name of the variable."
|
|
53578
|
-
},
|
|
53579
|
-
"value": {
|
|
53580
|
-
"type": "string",
|
|
53581
|
-
"description": "The value of the variable."
|
|
53582
|
-
}
|
|
53583
|
-
}
|
|
53584
|
-
},
|
|
53585
|
-
"examples": {
|
|
53586
|
-
"default": {
|
|
53587
|
-
"value": {
|
|
53588
|
-
"name": "USERNAME",
|
|
53589
|
-
"value": "octocat"
|
|
53590
|
-
}
|
|
53591
|
-
}
|
|
53592
|
-
}
|
|
53593
|
-
}
|
|
53594
|
-
}
|
|
53595
|
-
},
|
|
53596
|
-
"responses": {
|
|
53597
|
-
"204": {
|
|
53598
|
-
"description": "Response"
|
|
53599
|
-
}
|
|
53600
|
-
},
|
|
53601
|
-
"x-github": {
|
|
53602
|
-
"githubCloudOnly": false,
|
|
53603
|
-
"enabledForGitHubApps": true,
|
|
53604
|
-
"category": "actions",
|
|
53605
|
-
"subcategory": "variables"
|
|
53606
|
-
},
|
|
53607
|
-
"x-octokit": {}
|
|
53608
|
-
},
|
|
53609
|
-
"delete": {
|
|
53610
|
-
"summary": "Delete an environment variable",
|
|
53611
|
-
"description": "Deletes an environment variable using the variable name.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
|
|
53612
|
-
"tags": [
|
|
53613
|
-
"actions"
|
|
53614
|
-
],
|
|
53615
|
-
"operationId": "actions/delete-environment-variable",
|
|
53616
|
-
"externalDocs": {
|
|
53617
|
-
"description": "API method documentation",
|
|
53618
|
-
"url": "https://docs.github.com/rest/actions/variables#delete-an-environment-variable"
|
|
53619
|
-
},
|
|
53620
|
-
"parameters": [
|
|
53621
|
-
{
|
|
53622
|
-
"$ref": "#/components/parameters/repository-id"
|
|
53623
|
-
},
|
|
53624
|
-
{
|
|
53625
|
-
"$ref": "#/components/parameters/variable-name"
|
|
53626
|
-
},
|
|
53627
|
-
{
|
|
53628
|
-
"$ref": "#/components/parameters/environment-name"
|
|
53629
|
-
}
|
|
53630
|
-
],
|
|
53631
|
-
"responses": {
|
|
53632
|
-
"204": {
|
|
53633
|
-
"description": "Response"
|
|
53634
|
-
}
|
|
53635
|
-
},
|
|
53636
|
-
"x-github": {
|
|
53637
|
-
"githubCloudOnly": false,
|
|
53638
|
-
"enabledForGitHubApps": true,
|
|
53639
|
-
"category": "actions",
|
|
53640
|
-
"subcategory": "variables"
|
|
53641
|
-
},
|
|
53642
|
-
"x-octokit": {}
|
|
53643
|
-
}
|
|
53644
|
-
},
|
|
53645
53779
|
"/search/code": {
|
|
53646
53780
|
"get": {
|
|
53647
53781
|
"summary": "Search code",
|
|
@@ -63499,7 +63633,7 @@
|
|
|
63499
63633
|
"/users/{username}/hovercard": {
|
|
63500
63634
|
"get": {
|
|
63501
63635
|
"summary": "Get contextual information for a user",
|
|
63502
|
-
"description": "Provides hovercard information. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations.\n\
|
|
63636
|
+
"description": "Provides hovercard information. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations.\n\n The `subject_type` and `subject_id` parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about `octocat` who owns the `Spoon-Knife` repository, you would use a `subject_type` value of `repository` and a `subject_id` value of `1300192` (the ID of the `Spoon-Knife` repository).\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
|
|
63503
63637
|
"tags": [
|
|
63504
63638
|
"users"
|
|
63505
63639
|
],
|
|
@@ -99906,6 +100040,38 @@
|
|
|
99906
100040
|
}
|
|
99907
100041
|
}
|
|
99908
100042
|
},
|
|
100043
|
+
"repository-rule-params-thresholds": {
|
|
100044
|
+
"title": "Thresholds",
|
|
100045
|
+
"description": "This setting will not take effect unless at least one code scanning status check is enabled.",
|
|
100046
|
+
"type": "object",
|
|
100047
|
+
"properties": {
|
|
100048
|
+
"code_scanning_alert_threshold": {
|
|
100049
|
+
"type": "string",
|
|
100050
|
+
"description": "Code scanning alert threshold",
|
|
100051
|
+
"enum": [
|
|
100052
|
+
"none",
|
|
100053
|
+
"errors",
|
|
100054
|
+
"errors_and_warnings",
|
|
100055
|
+
"all"
|
|
100056
|
+
]
|
|
100057
|
+
},
|
|
100058
|
+
"code_scanning_security_alert_threshold": {
|
|
100059
|
+
"type": "string",
|
|
100060
|
+
"description": "Code scanning security alert threshold.",
|
|
100061
|
+
"enum": [
|
|
100062
|
+
"none",
|
|
100063
|
+
"critical",
|
|
100064
|
+
"high_or_higher",
|
|
100065
|
+
"medium_or_higher",
|
|
100066
|
+
"all"
|
|
100067
|
+
]
|
|
100068
|
+
}
|
|
100069
|
+
},
|
|
100070
|
+
"required": [
|
|
100071
|
+
"code_scanning_alert_threshold",
|
|
100072
|
+
"code_scanning_security_alert_threshold"
|
|
100073
|
+
]
|
|
100074
|
+
},
|
|
99909
100075
|
"repository-rule": {
|
|
99910
100076
|
"title": "Repository Rule",
|
|
99911
100077
|
"type": "object",
|
|
@@ -102509,7 +102675,9 @@
|
|
|
102509
102675
|
"queued",
|
|
102510
102676
|
"in_progress",
|
|
102511
102677
|
"completed",
|
|
102512
|
-
"waiting"
|
|
102678
|
+
"waiting",
|
|
102679
|
+
"requested",
|
|
102680
|
+
"pending"
|
|
102513
102681
|
]
|
|
102514
102682
|
},
|
|
102515
102683
|
"conclusion": {
|
|
@@ -105197,13 +105365,16 @@
|
|
|
105197
105365
|
"nullable": true
|
|
105198
105366
|
},
|
|
105199
105367
|
"status": {
|
|
105200
|
-
"description": "The phase of the lifecycle that the check is currently in.",
|
|
105368
|
+
"description": "The phase of the lifecycle that the check is currently in. Statuses of waiting, requested, and pending are reserved for GitHub Actions check runs.",
|
|
105201
105369
|
"example": "queued",
|
|
105202
105370
|
"type": "string",
|
|
105203
105371
|
"enum": [
|
|
105204
105372
|
"queued",
|
|
105205
105373
|
"in_progress",
|
|
105206
|
-
"completed"
|
|
105374
|
+
"completed",
|
|
105375
|
+
"waiting",
|
|
105376
|
+
"requested",
|
|
105377
|
+
"pending"
|
|
105207
105378
|
]
|
|
105208
105379
|
},
|
|
105209
105380
|
"conclusion": {
|
|
@@ -105481,11 +105652,15 @@
|
|
|
105481
105652
|
},
|
|
105482
105653
|
"status": {
|
|
105483
105654
|
"type": "string",
|
|
105655
|
+
"description": "The phase of the lifecycle that the check suite is currently in. Statuses of waiting, requested, and pending are reserved for GitHub Actions check suites.",
|
|
105484
105656
|
"example": "completed",
|
|
105485
105657
|
"enum": [
|
|
105486
105658
|
"queued",
|
|
105487
105659
|
"in_progress",
|
|
105488
|
-
"completed"
|
|
105660
|
+
"completed",
|
|
105661
|
+
"waiting",
|
|
105662
|
+
"requested",
|
|
105663
|
+
"pending"
|
|
105489
105664
|
],
|
|
105490
105665
|
"nullable": true
|
|
105491
105666
|
},
|
|
@@ -172167,6 +172342,7 @@
|
|
|
172167
172342
|
"type": "object",
|
|
172168
172343
|
"properties": {
|
|
172169
172344
|
"permission": {
|
|
172345
|
+
"description": "This field is included for legacy purposes; use the `role_name` field instead. The `maintain`\nrole is mapped to `write` and the `triage` role is mapped to `read`. To determine the role\nassigned to the collaborator, use the `role_name` field instead, which will provide the full\nrole name, including custom roles.",
|
|
172170
172346
|
"type": "object",
|
|
172171
172347
|
"properties": {
|
|
172172
172348
|
"to": {
|
|
@@ -172181,6 +172357,18 @@
|
|
|
172181
172357
|
"required": [
|
|
172182
172358
|
"to"
|
|
172183
172359
|
]
|
|
172360
|
+
},
|
|
172361
|
+
"role_name": {
|
|
172362
|
+
"description": "The role assigned to the collaborator.",
|
|
172363
|
+
"type": "object",
|
|
172364
|
+
"properties": {
|
|
172365
|
+
"to": {
|
|
172366
|
+
"type": "string"
|
|
172367
|
+
}
|
|
172368
|
+
},
|
|
172369
|
+
"required": [
|
|
172370
|
+
"to"
|
|
172371
|
+
]
|
|
172184
172372
|
}
|
|
172185
172373
|
}
|
|
172186
172374
|
},
|
|
@@ -256930,7 +257118,7 @@
|
|
|
256930
257118
|
"type": "string"
|
|
256931
257119
|
},
|
|
256932
257120
|
"commits": {
|
|
256933
|
-
"description": "An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the `compare` between the `before` commit and the `after` commit.) The array includes a maximum of
|
|
257121
|
+
"description": "An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the `compare` between the `before` commit and the `after` commit.) The array includes a maximum of 2048 commits. If necessary, you can use the [Commits API](https://docs.github.com/rest/commits) to fetch additional commits.",
|
|
256934
257122
|
"type": "array",
|
|
256935
257123
|
"items": {
|
|
256936
257124
|
"title": "Commit",
|
|
@@ -309077,7 +309265,7 @@
|
|
|
309077
309265
|
},
|
|
309078
309266
|
"workflow-run-status": {
|
|
309079
309267
|
"name": "status",
|
|
309080
|
-
"description": "Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`.",
|
|
309268
|
+
"description": "Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`.",
|
|
309081
309269
|
"in": "query",
|
|
309082
309270
|
"required": false,
|
|
309083
309271
|
"schema": {
|
|
@@ -309331,6 +309519,17 @@
|
|
|
309331
309519
|
"type": "integer"
|
|
309332
309520
|
}
|
|
309333
309521
|
},
|
|
309522
|
+
"git-ref-only": {
|
|
309523
|
+
"name": "ref",
|
|
309524
|
+
"description": "The Git reference. For more information, see \"[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)\" in the Git documentation.",
|
|
309525
|
+
"in": "path",
|
|
309526
|
+
"required": true,
|
|
309527
|
+
"example": "heads/feature-a",
|
|
309528
|
+
"schema": {
|
|
309529
|
+
"type": "string"
|
|
309530
|
+
},
|
|
309531
|
+
"x-multi-segment": true
|
|
309532
|
+
},
|
|
309334
309533
|
"since-user": {
|
|
309335
309534
|
"name": "since",
|
|
309336
309535
|
"description": "A user ID. Only return users with an ID greater than this ID.",
|