@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
package/generated/ghec.json
CHANGED
|
@@ -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": {
|
|
@@ -5641,9 +5641,6 @@
|
|
|
5641
5641
|
}
|
|
5642
5642
|
}
|
|
5643
5643
|
}
|
|
5644
|
-
},
|
|
5645
|
-
"403": {
|
|
5646
|
-
"$ref": "#/components/responses/code_scanning_forbidden_read"
|
|
5647
5644
|
}
|
|
5648
5645
|
},
|
|
5649
5646
|
"x-github": {
|
|
@@ -5845,7 +5842,7 @@
|
|
|
5845
5842
|
"/feeds": {
|
|
5846
5843
|
"get": {
|
|
5847
5844
|
"summary": "Get feeds",
|
|
5848
|
-
"description": "
|
|
5845
|
+
"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 Enterprise Cloud global public timeline\n* **User**: The public timeline for any user, using `uri_template`. For more information, see \"[Hypermedia](https://docs.github.com/enterprise-cloud@latest//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 Enterprise Cloud.\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/enterprise-cloud@latest//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/enterprise-cloud@latest//rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens.",
|
|
5849
5846
|
"tags": [
|
|
5850
5847
|
"activity"
|
|
5851
5848
|
],
|
|
@@ -8773,7 +8770,7 @@
|
|
|
8773
8770
|
"/organizations": {
|
|
8774
8771
|
"get": {
|
|
8775
8772
|
"summary": "List organizations",
|
|
8776
|
-
"description": "Lists all organizations, in the order that they were created
|
|
8773
|
+
"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/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations.",
|
|
8777
8774
|
"tags": [
|
|
8778
8775
|
"orgs"
|
|
8779
8776
|
],
|
|
@@ -13760,6 +13757,9 @@
|
|
|
13760
13757
|
"404": {
|
|
13761
13758
|
"$ref": "#/components/responses/not_found"
|
|
13762
13759
|
},
|
|
13760
|
+
"422": {
|
|
13761
|
+
"description": "There is a problem with your account's associated payment method."
|
|
13762
|
+
},
|
|
13763
13763
|
"500": {
|
|
13764
13764
|
"$ref": "#/components/responses/internal_error"
|
|
13765
13765
|
}
|
|
@@ -22571,9 +22571,6 @@
|
|
|
22571
22571
|
}
|
|
22572
22572
|
}
|
|
22573
22573
|
}
|
|
22574
|
-
},
|
|
22575
|
-
"403": {
|
|
22576
|
-
"$ref": "#/components/responses/code_scanning_forbidden_read"
|
|
22577
22574
|
}
|
|
22578
22575
|
},
|
|
22579
22576
|
"x-github": {
|
|
@@ -35346,11 +35343,14 @@
|
|
|
35346
35343
|
},
|
|
35347
35344
|
"status": {
|
|
35348
35345
|
"type": "string",
|
|
35349
|
-
"description": "The current status.",
|
|
35346
|
+
"description": "The current status of the check run. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`.",
|
|
35350
35347
|
"enum": [
|
|
35351
35348
|
"queued",
|
|
35352
35349
|
"in_progress",
|
|
35353
|
-
"completed"
|
|
35350
|
+
"completed",
|
|
35351
|
+
"waiting",
|
|
35352
|
+
"requested",
|
|
35353
|
+
"pending"
|
|
35354
35354
|
]
|
|
35355
35355
|
},
|
|
35356
35356
|
"conclusion": {
|
|
@@ -39029,6 +39029,9 @@
|
|
|
39029
39029
|
}
|
|
39030
39030
|
}
|
|
39031
39031
|
},
|
|
39032
|
+
"409": {
|
|
39033
|
+
"$ref": "#/components/responses/conflict"
|
|
39034
|
+
},
|
|
39032
39035
|
"422": {
|
|
39033
39036
|
"$ref": "#/components/responses/validation_failed"
|
|
39034
39037
|
}
|
|
@@ -39260,6 +39263,9 @@
|
|
|
39260
39263
|
"$ref": "#/components/headers/link"
|
|
39261
39264
|
}
|
|
39262
39265
|
}
|
|
39266
|
+
},
|
|
39267
|
+
"409": {
|
|
39268
|
+
"$ref": "#/components/responses/conflict"
|
|
39263
39269
|
}
|
|
39264
39270
|
},
|
|
39265
39271
|
"x-github": {
|
|
@@ -39319,6 +39325,9 @@
|
|
|
39319
39325
|
"404": {
|
|
39320
39326
|
"$ref": "#/components/responses/not_found"
|
|
39321
39327
|
},
|
|
39328
|
+
"409": {
|
|
39329
|
+
"$ref": "#/components/responses/conflict"
|
|
39330
|
+
},
|
|
39322
39331
|
"422": {
|
|
39323
39332
|
"$ref": "#/components/responses/validation_failed"
|
|
39324
39333
|
},
|
|
@@ -39702,7 +39711,7 @@
|
|
|
39702
39711
|
"/repos/{owner}/{repo}/compare/{basehead}": {
|
|
39703
39712
|
"get": {
|
|
39704
39713
|
"summary": "Compare two commits",
|
|
39705
|
-
"description": "Compares two commits against one another. You can compare branches in the same repository, or you can compare
|
|
39714
|
+
"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/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//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. |",
|
|
39706
39715
|
"tags": [
|
|
39707
39716
|
"repos"
|
|
39708
39717
|
],
|
|
@@ -42643,6 +42652,616 @@
|
|
|
42643
42652
|
"x-octokit": {}
|
|
42644
42653
|
}
|
|
42645
42654
|
},
|
|
42655
|
+
"/repos/{owner}/{repo}/environments/{environment_name}/secrets": {
|
|
42656
|
+
"get": {
|
|
42657
|
+
"summary": "List environment secrets",
|
|
42658
|
+
"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.",
|
|
42659
|
+
"tags": [
|
|
42660
|
+
"actions"
|
|
42661
|
+
],
|
|
42662
|
+
"operationId": "actions/list-environment-secrets",
|
|
42663
|
+
"externalDocs": {
|
|
42664
|
+
"description": "API method documentation",
|
|
42665
|
+
"url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-environment-secrets"
|
|
42666
|
+
},
|
|
42667
|
+
"parameters": [
|
|
42668
|
+
{
|
|
42669
|
+
"$ref": "#/components/parameters/owner"
|
|
42670
|
+
},
|
|
42671
|
+
{
|
|
42672
|
+
"$ref": "#/components/parameters/repo"
|
|
42673
|
+
},
|
|
42674
|
+
{
|
|
42675
|
+
"$ref": "#/components/parameters/environment-name"
|
|
42676
|
+
},
|
|
42677
|
+
{
|
|
42678
|
+
"$ref": "#/components/parameters/per-page"
|
|
42679
|
+
},
|
|
42680
|
+
{
|
|
42681
|
+
"$ref": "#/components/parameters/page"
|
|
42682
|
+
}
|
|
42683
|
+
],
|
|
42684
|
+
"responses": {
|
|
42685
|
+
"200": {
|
|
42686
|
+
"description": "Response",
|
|
42687
|
+
"content": {
|
|
42688
|
+
"application/json": {
|
|
42689
|
+
"schema": {
|
|
42690
|
+
"type": "object",
|
|
42691
|
+
"required": [
|
|
42692
|
+
"total_count",
|
|
42693
|
+
"secrets"
|
|
42694
|
+
],
|
|
42695
|
+
"properties": {
|
|
42696
|
+
"total_count": {
|
|
42697
|
+
"type": "integer"
|
|
42698
|
+
},
|
|
42699
|
+
"secrets": {
|
|
42700
|
+
"type": "array",
|
|
42701
|
+
"items": {
|
|
42702
|
+
"$ref": "#/components/schemas/actions-secret"
|
|
42703
|
+
}
|
|
42704
|
+
}
|
|
42705
|
+
}
|
|
42706
|
+
},
|
|
42707
|
+
"examples": {
|
|
42708
|
+
"default": {
|
|
42709
|
+
"$ref": "#/components/examples/actions-secret-paginated"
|
|
42710
|
+
}
|
|
42711
|
+
}
|
|
42712
|
+
}
|
|
42713
|
+
},
|
|
42714
|
+
"headers": {
|
|
42715
|
+
"Link": {
|
|
42716
|
+
"$ref": "#/components/headers/link"
|
|
42717
|
+
}
|
|
42718
|
+
}
|
|
42719
|
+
}
|
|
42720
|
+
},
|
|
42721
|
+
"x-github": {
|
|
42722
|
+
"githubCloudOnly": false,
|
|
42723
|
+
"enabledForGitHubApps": true,
|
|
42724
|
+
"category": "actions",
|
|
42725
|
+
"subcategory": "secrets"
|
|
42726
|
+
},
|
|
42727
|
+
"x-octokit": {}
|
|
42728
|
+
}
|
|
42729
|
+
},
|
|
42730
|
+
"/repos/{owner}/{repo}/environments/{environment_name}/secrets/public-key": {
|
|
42731
|
+
"get": {
|
|
42732
|
+
"summary": "Get an environment public key",
|
|
42733
|
+
"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.",
|
|
42734
|
+
"tags": [
|
|
42735
|
+
"actions"
|
|
42736
|
+
],
|
|
42737
|
+
"operationId": "actions/get-environment-public-key",
|
|
42738
|
+
"externalDocs": {
|
|
42739
|
+
"description": "API method documentation",
|
|
42740
|
+
"url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-public-key"
|
|
42741
|
+
},
|
|
42742
|
+
"parameters": [
|
|
42743
|
+
{
|
|
42744
|
+
"$ref": "#/components/parameters/owner"
|
|
42745
|
+
},
|
|
42746
|
+
{
|
|
42747
|
+
"$ref": "#/components/parameters/repo"
|
|
42748
|
+
},
|
|
42749
|
+
{
|
|
42750
|
+
"$ref": "#/components/parameters/environment-name"
|
|
42751
|
+
}
|
|
42752
|
+
],
|
|
42753
|
+
"responses": {
|
|
42754
|
+
"200": {
|
|
42755
|
+
"description": "Response",
|
|
42756
|
+
"content": {
|
|
42757
|
+
"application/json": {
|
|
42758
|
+
"schema": {
|
|
42759
|
+
"$ref": "#/components/schemas/actions-public-key"
|
|
42760
|
+
},
|
|
42761
|
+
"examples": {
|
|
42762
|
+
"default": {
|
|
42763
|
+
"$ref": "#/components/examples/actions-public-key"
|
|
42764
|
+
}
|
|
42765
|
+
}
|
|
42766
|
+
}
|
|
42767
|
+
}
|
|
42768
|
+
}
|
|
42769
|
+
},
|
|
42770
|
+
"x-github": {
|
|
42771
|
+
"githubCloudOnly": false,
|
|
42772
|
+
"enabledForGitHubApps": true,
|
|
42773
|
+
"category": "actions",
|
|
42774
|
+
"subcategory": "secrets"
|
|
42775
|
+
},
|
|
42776
|
+
"x-octokit": {}
|
|
42777
|
+
}
|
|
42778
|
+
},
|
|
42779
|
+
"/repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}": {
|
|
42780
|
+
"get": {
|
|
42781
|
+
"summary": "Get an environment secret",
|
|
42782
|
+
"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.",
|
|
42783
|
+
"tags": [
|
|
42784
|
+
"actions"
|
|
42785
|
+
],
|
|
42786
|
+
"operationId": "actions/get-environment-secret",
|
|
42787
|
+
"externalDocs": {
|
|
42788
|
+
"description": "API method documentation",
|
|
42789
|
+
"url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-secret"
|
|
42790
|
+
},
|
|
42791
|
+
"parameters": [
|
|
42792
|
+
{
|
|
42793
|
+
"$ref": "#/components/parameters/owner"
|
|
42794
|
+
},
|
|
42795
|
+
{
|
|
42796
|
+
"$ref": "#/components/parameters/repo"
|
|
42797
|
+
},
|
|
42798
|
+
{
|
|
42799
|
+
"$ref": "#/components/parameters/environment-name"
|
|
42800
|
+
},
|
|
42801
|
+
{
|
|
42802
|
+
"$ref": "#/components/parameters/secret-name"
|
|
42803
|
+
}
|
|
42804
|
+
],
|
|
42805
|
+
"responses": {
|
|
42806
|
+
"200": {
|
|
42807
|
+
"description": "Response",
|
|
42808
|
+
"content": {
|
|
42809
|
+
"application/json": {
|
|
42810
|
+
"schema": {
|
|
42811
|
+
"$ref": "#/components/schemas/actions-secret"
|
|
42812
|
+
},
|
|
42813
|
+
"examples": {
|
|
42814
|
+
"default": {
|
|
42815
|
+
"$ref": "#/components/examples/actions-secret"
|
|
42816
|
+
}
|
|
42817
|
+
}
|
|
42818
|
+
}
|
|
42819
|
+
}
|
|
42820
|
+
}
|
|
42821
|
+
},
|
|
42822
|
+
"x-github": {
|
|
42823
|
+
"githubCloudOnly": false,
|
|
42824
|
+
"enabledForGitHubApps": true,
|
|
42825
|
+
"category": "actions",
|
|
42826
|
+
"subcategory": "secrets"
|
|
42827
|
+
},
|
|
42828
|
+
"x-octokit": {}
|
|
42829
|
+
},
|
|
42830
|
+
"put": {
|
|
42831
|
+
"summary": "Create or update an environment secret",
|
|
42832
|
+
"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/enterprise-cloud@latest//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.",
|
|
42833
|
+
"tags": [
|
|
42834
|
+
"actions"
|
|
42835
|
+
],
|
|
42836
|
+
"operationId": "actions/create-or-update-environment-secret",
|
|
42837
|
+
"externalDocs": {
|
|
42838
|
+
"description": "API method documentation",
|
|
42839
|
+
"url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-environment-secret"
|
|
42840
|
+
},
|
|
42841
|
+
"parameters": [
|
|
42842
|
+
{
|
|
42843
|
+
"$ref": "#/components/parameters/owner"
|
|
42844
|
+
},
|
|
42845
|
+
{
|
|
42846
|
+
"$ref": "#/components/parameters/repo"
|
|
42847
|
+
},
|
|
42848
|
+
{
|
|
42849
|
+
"$ref": "#/components/parameters/environment-name"
|
|
42850
|
+
},
|
|
42851
|
+
{
|
|
42852
|
+
"$ref": "#/components/parameters/secret-name"
|
|
42853
|
+
}
|
|
42854
|
+
],
|
|
42855
|
+
"requestBody": {
|
|
42856
|
+
"required": true,
|
|
42857
|
+
"content": {
|
|
42858
|
+
"application/json": {
|
|
42859
|
+
"schema": {
|
|
42860
|
+
"type": "object",
|
|
42861
|
+
"properties": {
|
|
42862
|
+
"encrypted_value": {
|
|
42863
|
+
"type": "string",
|
|
42864
|
+
"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/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-public-key) endpoint.",
|
|
42865
|
+
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$"
|
|
42866
|
+
},
|
|
42867
|
+
"key_id": {
|
|
42868
|
+
"type": "string",
|
|
42869
|
+
"description": "ID of the key you used to encrypt the secret."
|
|
42870
|
+
}
|
|
42871
|
+
},
|
|
42872
|
+
"required": [
|
|
42873
|
+
"encrypted_value",
|
|
42874
|
+
"key_id"
|
|
42875
|
+
]
|
|
42876
|
+
},
|
|
42877
|
+
"examples": {
|
|
42878
|
+
"default": {
|
|
42879
|
+
"value": {
|
|
42880
|
+
"encrypted_value": "c2VjcmV0",
|
|
42881
|
+
"key_id": "012345678912345678"
|
|
42882
|
+
}
|
|
42883
|
+
}
|
|
42884
|
+
}
|
|
42885
|
+
}
|
|
42886
|
+
}
|
|
42887
|
+
},
|
|
42888
|
+
"responses": {
|
|
42889
|
+
"201": {
|
|
42890
|
+
"description": "Response when creating a secret",
|
|
42891
|
+
"content": {
|
|
42892
|
+
"application/json": {
|
|
42893
|
+
"schema": {
|
|
42894
|
+
"$ref": "#/components/schemas/empty-object"
|
|
42895
|
+
},
|
|
42896
|
+
"examples": {
|
|
42897
|
+
"default": {
|
|
42898
|
+
"value": null
|
|
42899
|
+
}
|
|
42900
|
+
}
|
|
42901
|
+
}
|
|
42902
|
+
}
|
|
42903
|
+
},
|
|
42904
|
+
"204": {
|
|
42905
|
+
"description": "Response when updating a secret"
|
|
42906
|
+
}
|
|
42907
|
+
},
|
|
42908
|
+
"x-github": {
|
|
42909
|
+
"githubCloudOnly": false,
|
|
42910
|
+
"enabledForGitHubApps": true,
|
|
42911
|
+
"category": "actions",
|
|
42912
|
+
"subcategory": "secrets"
|
|
42913
|
+
},
|
|
42914
|
+
"x-octokit": {}
|
|
42915
|
+
},
|
|
42916
|
+
"delete": {
|
|
42917
|
+
"summary": "Delete an environment secret",
|
|
42918
|
+
"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.",
|
|
42919
|
+
"tags": [
|
|
42920
|
+
"actions"
|
|
42921
|
+
],
|
|
42922
|
+
"operationId": "actions/delete-environment-secret",
|
|
42923
|
+
"externalDocs": {
|
|
42924
|
+
"description": "API method documentation",
|
|
42925
|
+
"url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-an-environment-secret"
|
|
42926
|
+
},
|
|
42927
|
+
"parameters": [
|
|
42928
|
+
{
|
|
42929
|
+
"$ref": "#/components/parameters/owner"
|
|
42930
|
+
},
|
|
42931
|
+
{
|
|
42932
|
+
"$ref": "#/components/parameters/repo"
|
|
42933
|
+
},
|
|
42934
|
+
{
|
|
42935
|
+
"$ref": "#/components/parameters/environment-name"
|
|
42936
|
+
},
|
|
42937
|
+
{
|
|
42938
|
+
"$ref": "#/components/parameters/secret-name"
|
|
42939
|
+
}
|
|
42940
|
+
],
|
|
42941
|
+
"responses": {
|
|
42942
|
+
"204": {
|
|
42943
|
+
"description": "Default response"
|
|
42944
|
+
}
|
|
42945
|
+
},
|
|
42946
|
+
"x-github": {
|
|
42947
|
+
"githubCloudOnly": false,
|
|
42948
|
+
"enabledForGitHubApps": true,
|
|
42949
|
+
"category": "actions",
|
|
42950
|
+
"subcategory": "secrets"
|
|
42951
|
+
},
|
|
42952
|
+
"x-octokit": {}
|
|
42953
|
+
}
|
|
42954
|
+
},
|
|
42955
|
+
"/repos/{owner}/{repo}/environments/{environment_name}/variables": {
|
|
42956
|
+
"get": {
|
|
42957
|
+
"summary": "List environment variables",
|
|
42958
|
+
"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.",
|
|
42959
|
+
"tags": [
|
|
42960
|
+
"actions"
|
|
42961
|
+
],
|
|
42962
|
+
"operationId": "actions/list-environment-variables",
|
|
42963
|
+
"externalDocs": {
|
|
42964
|
+
"description": "API method documentation",
|
|
42965
|
+
"url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-environment-variables"
|
|
42966
|
+
},
|
|
42967
|
+
"parameters": [
|
|
42968
|
+
{
|
|
42969
|
+
"$ref": "#/components/parameters/owner"
|
|
42970
|
+
},
|
|
42971
|
+
{
|
|
42972
|
+
"$ref": "#/components/parameters/repo"
|
|
42973
|
+
},
|
|
42974
|
+
{
|
|
42975
|
+
"$ref": "#/components/parameters/environment-name"
|
|
42976
|
+
},
|
|
42977
|
+
{
|
|
42978
|
+
"$ref": "#/components/parameters/variables-per-page"
|
|
42979
|
+
},
|
|
42980
|
+
{
|
|
42981
|
+
"$ref": "#/components/parameters/page"
|
|
42982
|
+
}
|
|
42983
|
+
],
|
|
42984
|
+
"responses": {
|
|
42985
|
+
"200": {
|
|
42986
|
+
"description": "Response",
|
|
42987
|
+
"content": {
|
|
42988
|
+
"application/json": {
|
|
42989
|
+
"schema": {
|
|
42990
|
+
"type": "object",
|
|
42991
|
+
"required": [
|
|
42992
|
+
"total_count",
|
|
42993
|
+
"variables"
|
|
42994
|
+
],
|
|
42995
|
+
"properties": {
|
|
42996
|
+
"total_count": {
|
|
42997
|
+
"type": "integer"
|
|
42998
|
+
},
|
|
42999
|
+
"variables": {
|
|
43000
|
+
"type": "array",
|
|
43001
|
+
"items": {
|
|
43002
|
+
"$ref": "#/components/schemas/actions-variable"
|
|
43003
|
+
}
|
|
43004
|
+
}
|
|
43005
|
+
}
|
|
43006
|
+
},
|
|
43007
|
+
"examples": {
|
|
43008
|
+
"default": {
|
|
43009
|
+
"$ref": "#/components/examples/actions-variables-paginated"
|
|
43010
|
+
}
|
|
43011
|
+
}
|
|
43012
|
+
}
|
|
43013
|
+
},
|
|
43014
|
+
"headers": {
|
|
43015
|
+
"Link": {
|
|
43016
|
+
"$ref": "#/components/headers/link"
|
|
43017
|
+
}
|
|
43018
|
+
}
|
|
43019
|
+
}
|
|
43020
|
+
},
|
|
43021
|
+
"x-github": {
|
|
43022
|
+
"githubCloudOnly": false,
|
|
43023
|
+
"enabledForGitHubApps": true,
|
|
43024
|
+
"category": "actions",
|
|
43025
|
+
"subcategory": "variables"
|
|
43026
|
+
},
|
|
43027
|
+
"x-octokit": {}
|
|
43028
|
+
},
|
|
43029
|
+
"post": {
|
|
43030
|
+
"summary": "Create an environment variable",
|
|
43031
|
+
"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.",
|
|
43032
|
+
"tags": [
|
|
43033
|
+
"actions"
|
|
43034
|
+
],
|
|
43035
|
+
"operationId": "actions/create-environment-variable",
|
|
43036
|
+
"externalDocs": {
|
|
43037
|
+
"description": "API method documentation",
|
|
43038
|
+
"url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-an-environment-variable"
|
|
43039
|
+
},
|
|
43040
|
+
"parameters": [
|
|
43041
|
+
{
|
|
43042
|
+
"$ref": "#/components/parameters/owner"
|
|
43043
|
+
},
|
|
43044
|
+
{
|
|
43045
|
+
"$ref": "#/components/parameters/repo"
|
|
43046
|
+
},
|
|
43047
|
+
{
|
|
43048
|
+
"$ref": "#/components/parameters/environment-name"
|
|
43049
|
+
}
|
|
43050
|
+
],
|
|
43051
|
+
"requestBody": {
|
|
43052
|
+
"required": true,
|
|
43053
|
+
"content": {
|
|
43054
|
+
"application/json": {
|
|
43055
|
+
"schema": {
|
|
43056
|
+
"type": "object",
|
|
43057
|
+
"properties": {
|
|
43058
|
+
"name": {
|
|
43059
|
+
"type": "string",
|
|
43060
|
+
"description": "The name of the variable."
|
|
43061
|
+
},
|
|
43062
|
+
"value": {
|
|
43063
|
+
"type": "string",
|
|
43064
|
+
"description": "The value of the variable."
|
|
43065
|
+
}
|
|
43066
|
+
},
|
|
43067
|
+
"required": [
|
|
43068
|
+
"name",
|
|
43069
|
+
"value"
|
|
43070
|
+
]
|
|
43071
|
+
},
|
|
43072
|
+
"examples": {
|
|
43073
|
+
"default": {
|
|
43074
|
+
"value": {
|
|
43075
|
+
"name": "USERNAME",
|
|
43076
|
+
"value": "octocat"
|
|
43077
|
+
}
|
|
43078
|
+
}
|
|
43079
|
+
}
|
|
43080
|
+
}
|
|
43081
|
+
}
|
|
43082
|
+
},
|
|
43083
|
+
"responses": {
|
|
43084
|
+
"201": {
|
|
43085
|
+
"description": "Response",
|
|
43086
|
+
"content": {
|
|
43087
|
+
"application/json": {
|
|
43088
|
+
"schema": {
|
|
43089
|
+
"$ref": "#/components/schemas/empty-object"
|
|
43090
|
+
},
|
|
43091
|
+
"examples": {
|
|
43092
|
+
"default": {
|
|
43093
|
+
"value": null
|
|
43094
|
+
}
|
|
43095
|
+
}
|
|
43096
|
+
}
|
|
43097
|
+
}
|
|
43098
|
+
}
|
|
43099
|
+
},
|
|
43100
|
+
"x-github": {
|
|
43101
|
+
"githubCloudOnly": false,
|
|
43102
|
+
"enabledForGitHubApps": true,
|
|
43103
|
+
"category": "actions",
|
|
43104
|
+
"subcategory": "variables"
|
|
43105
|
+
},
|
|
43106
|
+
"x-octokit": {}
|
|
43107
|
+
}
|
|
43108
|
+
},
|
|
43109
|
+
"/repos/{owner}/{repo}/environments/{environment_name}/variables/{name}": {
|
|
43110
|
+
"get": {
|
|
43111
|
+
"summary": "Get an environment variable",
|
|
43112
|
+
"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.",
|
|
43113
|
+
"tags": [
|
|
43114
|
+
"actions"
|
|
43115
|
+
],
|
|
43116
|
+
"operationId": "actions/get-environment-variable",
|
|
43117
|
+
"externalDocs": {
|
|
43118
|
+
"description": "API method documentation",
|
|
43119
|
+
"url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-an-environment-variable"
|
|
43120
|
+
},
|
|
43121
|
+
"parameters": [
|
|
43122
|
+
{
|
|
43123
|
+
"$ref": "#/components/parameters/owner"
|
|
43124
|
+
},
|
|
43125
|
+
{
|
|
43126
|
+
"$ref": "#/components/parameters/repo"
|
|
43127
|
+
},
|
|
43128
|
+
{
|
|
43129
|
+
"$ref": "#/components/parameters/environment-name"
|
|
43130
|
+
},
|
|
43131
|
+
{
|
|
43132
|
+
"$ref": "#/components/parameters/variable-name"
|
|
43133
|
+
}
|
|
43134
|
+
],
|
|
43135
|
+
"responses": {
|
|
43136
|
+
"200": {
|
|
43137
|
+
"description": "Response",
|
|
43138
|
+
"content": {
|
|
43139
|
+
"application/json": {
|
|
43140
|
+
"schema": {
|
|
43141
|
+
"$ref": "#/components/schemas/actions-variable"
|
|
43142
|
+
},
|
|
43143
|
+
"examples": {
|
|
43144
|
+
"default": {
|
|
43145
|
+
"$ref": "#/components/examples/actions-variable"
|
|
43146
|
+
}
|
|
43147
|
+
}
|
|
43148
|
+
}
|
|
43149
|
+
}
|
|
43150
|
+
}
|
|
43151
|
+
},
|
|
43152
|
+
"x-github": {
|
|
43153
|
+
"githubCloudOnly": false,
|
|
43154
|
+
"enabledForGitHubApps": true,
|
|
43155
|
+
"category": "actions",
|
|
43156
|
+
"subcategory": "variables"
|
|
43157
|
+
},
|
|
43158
|
+
"x-octokit": {}
|
|
43159
|
+
},
|
|
43160
|
+
"patch": {
|
|
43161
|
+
"summary": "Update an environment variable",
|
|
43162
|
+
"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.",
|
|
43163
|
+
"tags": [
|
|
43164
|
+
"actions"
|
|
43165
|
+
],
|
|
43166
|
+
"operationId": "actions/update-environment-variable",
|
|
43167
|
+
"externalDocs": {
|
|
43168
|
+
"description": "API method documentation",
|
|
43169
|
+
"url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-an-environment-variable"
|
|
43170
|
+
},
|
|
43171
|
+
"parameters": [
|
|
43172
|
+
{
|
|
43173
|
+
"$ref": "#/components/parameters/owner"
|
|
43174
|
+
},
|
|
43175
|
+
{
|
|
43176
|
+
"$ref": "#/components/parameters/repo"
|
|
43177
|
+
},
|
|
43178
|
+
{
|
|
43179
|
+
"$ref": "#/components/parameters/variable-name"
|
|
43180
|
+
},
|
|
43181
|
+
{
|
|
43182
|
+
"$ref": "#/components/parameters/environment-name"
|
|
43183
|
+
}
|
|
43184
|
+
],
|
|
43185
|
+
"requestBody": {
|
|
43186
|
+
"required": true,
|
|
43187
|
+
"content": {
|
|
43188
|
+
"application/json": {
|
|
43189
|
+
"schema": {
|
|
43190
|
+
"type": "object",
|
|
43191
|
+
"properties": {
|
|
43192
|
+
"name": {
|
|
43193
|
+
"type": "string",
|
|
43194
|
+
"description": "The name of the variable."
|
|
43195
|
+
},
|
|
43196
|
+
"value": {
|
|
43197
|
+
"type": "string",
|
|
43198
|
+
"description": "The value of the variable."
|
|
43199
|
+
}
|
|
43200
|
+
}
|
|
43201
|
+
},
|
|
43202
|
+
"examples": {
|
|
43203
|
+
"default": {
|
|
43204
|
+
"value": {
|
|
43205
|
+
"name": "USERNAME",
|
|
43206
|
+
"value": "octocat"
|
|
43207
|
+
}
|
|
43208
|
+
}
|
|
43209
|
+
}
|
|
43210
|
+
}
|
|
43211
|
+
}
|
|
43212
|
+
},
|
|
43213
|
+
"responses": {
|
|
43214
|
+
"204": {
|
|
43215
|
+
"description": "Response"
|
|
43216
|
+
}
|
|
43217
|
+
},
|
|
43218
|
+
"x-github": {
|
|
43219
|
+
"githubCloudOnly": false,
|
|
43220
|
+
"enabledForGitHubApps": true,
|
|
43221
|
+
"category": "actions",
|
|
43222
|
+
"subcategory": "variables"
|
|
43223
|
+
},
|
|
43224
|
+
"x-octokit": {}
|
|
43225
|
+
},
|
|
43226
|
+
"delete": {
|
|
43227
|
+
"summary": "Delete an environment variable",
|
|
43228
|
+
"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.",
|
|
43229
|
+
"tags": [
|
|
43230
|
+
"actions"
|
|
43231
|
+
],
|
|
43232
|
+
"operationId": "actions/delete-environment-variable",
|
|
43233
|
+
"externalDocs": {
|
|
43234
|
+
"description": "API method documentation",
|
|
43235
|
+
"url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-an-environment-variable"
|
|
43236
|
+
},
|
|
43237
|
+
"parameters": [
|
|
43238
|
+
{
|
|
43239
|
+
"$ref": "#/components/parameters/owner"
|
|
43240
|
+
},
|
|
43241
|
+
{
|
|
43242
|
+
"$ref": "#/components/parameters/repo"
|
|
43243
|
+
},
|
|
43244
|
+
{
|
|
43245
|
+
"$ref": "#/components/parameters/variable-name"
|
|
43246
|
+
},
|
|
43247
|
+
{
|
|
43248
|
+
"$ref": "#/components/parameters/environment-name"
|
|
43249
|
+
}
|
|
43250
|
+
],
|
|
43251
|
+
"responses": {
|
|
43252
|
+
"204": {
|
|
43253
|
+
"description": "Response"
|
|
43254
|
+
}
|
|
43255
|
+
},
|
|
43256
|
+
"x-github": {
|
|
43257
|
+
"githubCloudOnly": false,
|
|
43258
|
+
"enabledForGitHubApps": true,
|
|
43259
|
+
"category": "actions",
|
|
43260
|
+
"subcategory": "variables"
|
|
43261
|
+
},
|
|
43262
|
+
"x-octokit": {}
|
|
43263
|
+
}
|
|
43264
|
+
},
|
|
42646
43265
|
"/repos/{owner}/{repo}/events": {
|
|
42647
43266
|
"get": {
|
|
42648
43267
|
"summary": "List repository events",
|
|
@@ -43015,6 +43634,9 @@
|
|
|
43015
43634
|
"404": {
|
|
43016
43635
|
"$ref": "#/components/responses/not_found"
|
|
43017
43636
|
},
|
|
43637
|
+
"409": {
|
|
43638
|
+
"$ref": "#/components/responses/conflict"
|
|
43639
|
+
},
|
|
43018
43640
|
"422": {
|
|
43019
43641
|
"$ref": "#/components/responses/validation_failed"
|
|
43020
43642
|
}
|
|
@@ -43169,6 +43791,9 @@
|
|
|
43169
43791
|
"404": {
|
|
43170
43792
|
"$ref": "#/components/responses/not_found"
|
|
43171
43793
|
},
|
|
43794
|
+
"409": {
|
|
43795
|
+
"$ref": "#/components/responses/conflict"
|
|
43796
|
+
},
|
|
43172
43797
|
"422": {
|
|
43173
43798
|
"$ref": "#/components/responses/validation_failed"
|
|
43174
43799
|
}
|
|
@@ -43223,6 +43848,9 @@
|
|
|
43223
43848
|
},
|
|
43224
43849
|
"404": {
|
|
43225
43850
|
"$ref": "#/components/responses/not_found"
|
|
43851
|
+
},
|
|
43852
|
+
"409": {
|
|
43853
|
+
"$ref": "#/components/responses/conflict"
|
|
43226
43854
|
}
|
|
43227
43855
|
},
|
|
43228
43856
|
"x-github": {
|
|
@@ -43254,7 +43882,7 @@
|
|
|
43254
43882
|
"$ref": "#/components/parameters/repo"
|
|
43255
43883
|
},
|
|
43256
43884
|
{
|
|
43257
|
-
"$ref": "#/components/parameters/
|
|
43885
|
+
"$ref": "#/components/parameters/git-ref-only"
|
|
43258
43886
|
}
|
|
43259
43887
|
],
|
|
43260
43888
|
"responses": {
|
|
@@ -43280,6 +43908,9 @@
|
|
|
43280
43908
|
"$ref": "#/components/headers/link"
|
|
43281
43909
|
}
|
|
43282
43910
|
}
|
|
43911
|
+
},
|
|
43912
|
+
"409": {
|
|
43913
|
+
"$ref": "#/components/responses/conflict"
|
|
43283
43914
|
}
|
|
43284
43915
|
},
|
|
43285
43916
|
"x-github": {
|
|
@@ -43311,7 +43942,7 @@
|
|
|
43311
43942
|
"$ref": "#/components/parameters/repo"
|
|
43312
43943
|
},
|
|
43313
43944
|
{
|
|
43314
|
-
"$ref": "#/components/parameters/
|
|
43945
|
+
"$ref": "#/components/parameters/git-ref-only"
|
|
43315
43946
|
}
|
|
43316
43947
|
],
|
|
43317
43948
|
"responses": {
|
|
@@ -43332,6 +43963,9 @@
|
|
|
43332
43963
|
},
|
|
43333
43964
|
"404": {
|
|
43334
43965
|
"$ref": "#/components/responses/not_found"
|
|
43966
|
+
},
|
|
43967
|
+
"409": {
|
|
43968
|
+
"$ref": "#/components/responses/conflict"
|
|
43335
43969
|
}
|
|
43336
43970
|
},
|
|
43337
43971
|
"x-github": {
|
|
@@ -43419,6 +44053,9 @@
|
|
|
43419
44053
|
}
|
|
43420
44054
|
}
|
|
43421
44055
|
},
|
|
44056
|
+
"409": {
|
|
44057
|
+
"$ref": "#/components/responses/conflict"
|
|
44058
|
+
},
|
|
43422
44059
|
"422": {
|
|
43423
44060
|
"$ref": "#/components/responses/validation_failed"
|
|
43424
44061
|
}
|
|
@@ -43435,7 +44072,7 @@
|
|
|
43435
44072
|
"/repos/{owner}/{repo}/git/refs/{ref}": {
|
|
43436
44073
|
"patch": {
|
|
43437
44074
|
"summary": "Update a reference",
|
|
43438
|
-
"description": "",
|
|
44075
|
+
"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.",
|
|
43439
44076
|
"tags": [
|
|
43440
44077
|
"git"
|
|
43441
44078
|
],
|
|
@@ -43452,15 +44089,7 @@
|
|
|
43452
44089
|
"$ref": "#/components/parameters/repo"
|
|
43453
44090
|
},
|
|
43454
44091
|
{
|
|
43455
|
-
"
|
|
43456
|
-
"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.",
|
|
43457
|
-
"in": "path",
|
|
43458
|
-
"required": true,
|
|
43459
|
-
"example": "heads/featureA",
|
|
43460
|
-
"schema": {
|
|
43461
|
-
"type": "string"
|
|
43462
|
-
},
|
|
43463
|
-
"x-multi-segment": true
|
|
44092
|
+
"$ref": "#/components/parameters/git-ref-only"
|
|
43464
44093
|
}
|
|
43465
44094
|
],
|
|
43466
44095
|
"requestBody": {
|
|
@@ -43511,6 +44140,9 @@
|
|
|
43511
44140
|
}
|
|
43512
44141
|
}
|
|
43513
44142
|
},
|
|
44143
|
+
"409": {
|
|
44144
|
+
"$ref": "#/components/responses/conflict"
|
|
44145
|
+
},
|
|
43514
44146
|
"422": {
|
|
43515
44147
|
"$ref": "#/components/responses/validation_failed"
|
|
43516
44148
|
}
|
|
@@ -43525,7 +44157,7 @@
|
|
|
43525
44157
|
},
|
|
43526
44158
|
"delete": {
|
|
43527
44159
|
"summary": "Delete a reference",
|
|
43528
|
-
"description": "",
|
|
44160
|
+
"description": "Deletes the provided reference.",
|
|
43529
44161
|
"tags": [
|
|
43530
44162
|
"git"
|
|
43531
44163
|
],
|
|
@@ -43542,13 +44174,16 @@
|
|
|
43542
44174
|
"$ref": "#/components/parameters/repo"
|
|
43543
44175
|
},
|
|
43544
44176
|
{
|
|
43545
|
-
"$ref": "#/components/parameters/
|
|
44177
|
+
"$ref": "#/components/parameters/git-ref-only"
|
|
43546
44178
|
}
|
|
43547
44179
|
],
|
|
43548
44180
|
"responses": {
|
|
43549
44181
|
"204": {
|
|
43550
44182
|
"description": "Response"
|
|
43551
44183
|
},
|
|
44184
|
+
"409": {
|
|
44185
|
+
"$ref": "#/components/responses/conflict"
|
|
44186
|
+
},
|
|
43552
44187
|
"422": {
|
|
43553
44188
|
"$ref": "#/components/responses/validation_failed"
|
|
43554
44189
|
}
|
|
@@ -43683,6 +44318,9 @@
|
|
|
43683
44318
|
}
|
|
43684
44319
|
}
|
|
43685
44320
|
},
|
|
44321
|
+
"409": {
|
|
44322
|
+
"$ref": "#/components/responses/conflict"
|
|
44323
|
+
},
|
|
43686
44324
|
"422": {
|
|
43687
44325
|
"$ref": "#/components/responses/validation_failed"
|
|
43688
44326
|
}
|
|
@@ -43742,6 +44380,9 @@
|
|
|
43742
44380
|
},
|
|
43743
44381
|
"404": {
|
|
43744
44382
|
"$ref": "#/components/responses/not_found"
|
|
44383
|
+
},
|
|
44384
|
+
"409": {
|
|
44385
|
+
"$ref": "#/components/responses/conflict"
|
|
43745
44386
|
}
|
|
43746
44387
|
},
|
|
43747
44388
|
"x-github": {
|
|
@@ -43879,6 +44520,9 @@
|
|
|
43879
44520
|
"404": {
|
|
43880
44521
|
"$ref": "#/components/responses/not_found"
|
|
43881
44522
|
},
|
|
44523
|
+
"409": {
|
|
44524
|
+
"$ref": "#/components/responses/conflict"
|
|
44525
|
+
},
|
|
43882
44526
|
"422": {
|
|
43883
44527
|
"$ref": "#/components/responses/validation_failed"
|
|
43884
44528
|
}
|
|
@@ -43953,6 +44597,9 @@
|
|
|
43953
44597
|
"404": {
|
|
43954
44598
|
"$ref": "#/components/responses/not_found"
|
|
43955
44599
|
},
|
|
44600
|
+
"409": {
|
|
44601
|
+
"$ref": "#/components/responses/conflict"
|
|
44602
|
+
},
|
|
43956
44603
|
"422": {
|
|
43957
44604
|
"$ref": "#/components/responses/validation_failed"
|
|
43958
44605
|
}
|
|
@@ -48889,6 +49536,9 @@
|
|
|
48889
49536
|
},
|
|
48890
49537
|
{
|
|
48891
49538
|
"$ref": "#/components/parameters/repo"
|
|
49539
|
+
},
|
|
49540
|
+
{
|
|
49541
|
+
"$ref": "#/components/parameters/git-ref"
|
|
48892
49542
|
}
|
|
48893
49543
|
],
|
|
48894
49544
|
"responses": {
|
|
@@ -50529,6 +51179,64 @@
|
|
|
50529
51179
|
}
|
|
50530
51180
|
},
|
|
50531
51181
|
"/repos/{owner}/{repo}/private-vulnerability-reporting": {
|
|
51182
|
+
"get": {
|
|
51183
|
+
"summary": "Check if private vulnerability reporting is enabled for a repository",
|
|
51184
|
+
"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/enterprise-cloud@latest//code-security/security-advisories/working-with-repository-security-advisories/evaluating-the-security-settings-of-a-repository)\".",
|
|
51185
|
+
"tags": [
|
|
51186
|
+
"repos"
|
|
51187
|
+
],
|
|
51188
|
+
"operationId": "repos/check-private-vulnerability-reporting",
|
|
51189
|
+
"externalDocs": {
|
|
51190
|
+
"description": "API method documentation",
|
|
51191
|
+
"url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#check-if-private-vulnerability-reporting-is-enabled-for-a-repository"
|
|
51192
|
+
},
|
|
51193
|
+
"parameters": [
|
|
51194
|
+
{
|
|
51195
|
+
"$ref": "#/components/parameters/owner"
|
|
51196
|
+
},
|
|
51197
|
+
{
|
|
51198
|
+
"$ref": "#/components/parameters/repo"
|
|
51199
|
+
}
|
|
51200
|
+
],
|
|
51201
|
+
"responses": {
|
|
51202
|
+
"200": {
|
|
51203
|
+
"description": "Private vulnerability reporting status",
|
|
51204
|
+
"content": {
|
|
51205
|
+
"application/json": {
|
|
51206
|
+
"schema": {
|
|
51207
|
+
"type": "object",
|
|
51208
|
+
"properties": {
|
|
51209
|
+
"enabled": {
|
|
51210
|
+
"type": "boolean",
|
|
51211
|
+
"description": "Whether or not private vulnerability reporting is enabled for the repository."
|
|
51212
|
+
}
|
|
51213
|
+
},
|
|
51214
|
+
"required": [
|
|
51215
|
+
"enabled"
|
|
51216
|
+
]
|
|
51217
|
+
},
|
|
51218
|
+
"examples": {
|
|
51219
|
+
"default": {
|
|
51220
|
+
"value": {
|
|
51221
|
+
"enabled": true
|
|
51222
|
+
}
|
|
51223
|
+
}
|
|
51224
|
+
}
|
|
51225
|
+
}
|
|
51226
|
+
}
|
|
51227
|
+
},
|
|
51228
|
+
"422": {
|
|
51229
|
+
"$ref": "#/components/responses/bad_request"
|
|
51230
|
+
}
|
|
51231
|
+
},
|
|
51232
|
+
"x-github": {
|
|
51233
|
+
"githubCloudOnly": false,
|
|
51234
|
+
"enabledForGitHubApps": true,
|
|
51235
|
+
"category": "repos",
|
|
51236
|
+
"subcategory": "repos"
|
|
51237
|
+
},
|
|
51238
|
+
"x-octokit": {}
|
|
51239
|
+
},
|
|
50532
51240
|
"put": {
|
|
50533
51241
|
"summary": "Enable private vulnerability reporting for a repository",
|
|
50534
51242
|
"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/enterprise-cloud@latest//code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability).\"",
|
|
@@ -58249,587 +58957,7 @@
|
|
|
58249
58957
|
"x-octokit": {}
|
|
58250
58958
|
}
|
|
58251
58959
|
},
|
|
58252
|
-
"/
|
|
58253
|
-
"get": {
|
|
58254
|
-
"summary": "List environment secrets",
|
|
58255
|
-
"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.",
|
|
58256
|
-
"tags": [
|
|
58257
|
-
"actions"
|
|
58258
|
-
],
|
|
58259
|
-
"operationId": "actions/list-environment-secrets",
|
|
58260
|
-
"externalDocs": {
|
|
58261
|
-
"description": "API method documentation",
|
|
58262
|
-
"url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-environment-secrets"
|
|
58263
|
-
},
|
|
58264
|
-
"parameters": [
|
|
58265
|
-
{
|
|
58266
|
-
"$ref": "#/components/parameters/repository-id"
|
|
58267
|
-
},
|
|
58268
|
-
{
|
|
58269
|
-
"$ref": "#/components/parameters/environment-name"
|
|
58270
|
-
},
|
|
58271
|
-
{
|
|
58272
|
-
"$ref": "#/components/parameters/per-page"
|
|
58273
|
-
},
|
|
58274
|
-
{
|
|
58275
|
-
"$ref": "#/components/parameters/page"
|
|
58276
|
-
}
|
|
58277
|
-
],
|
|
58278
|
-
"responses": {
|
|
58279
|
-
"200": {
|
|
58280
|
-
"description": "Response",
|
|
58281
|
-
"content": {
|
|
58282
|
-
"application/json": {
|
|
58283
|
-
"schema": {
|
|
58284
|
-
"type": "object",
|
|
58285
|
-
"required": [
|
|
58286
|
-
"total_count",
|
|
58287
|
-
"secrets"
|
|
58288
|
-
],
|
|
58289
|
-
"properties": {
|
|
58290
|
-
"total_count": {
|
|
58291
|
-
"type": "integer"
|
|
58292
|
-
},
|
|
58293
|
-
"secrets": {
|
|
58294
|
-
"type": "array",
|
|
58295
|
-
"items": {
|
|
58296
|
-
"$ref": "#/components/schemas/actions-secret"
|
|
58297
|
-
}
|
|
58298
|
-
}
|
|
58299
|
-
}
|
|
58300
|
-
},
|
|
58301
|
-
"examples": {
|
|
58302
|
-
"default": {
|
|
58303
|
-
"$ref": "#/components/examples/actions-secret-paginated"
|
|
58304
|
-
}
|
|
58305
|
-
}
|
|
58306
|
-
}
|
|
58307
|
-
},
|
|
58308
|
-
"headers": {
|
|
58309
|
-
"Link": {
|
|
58310
|
-
"$ref": "#/components/headers/link"
|
|
58311
|
-
}
|
|
58312
|
-
}
|
|
58313
|
-
}
|
|
58314
|
-
},
|
|
58315
|
-
"x-github": {
|
|
58316
|
-
"githubCloudOnly": false,
|
|
58317
|
-
"enabledForGitHubApps": true,
|
|
58318
|
-
"category": "actions",
|
|
58319
|
-
"subcategory": "secrets"
|
|
58320
|
-
},
|
|
58321
|
-
"x-octokit": {}
|
|
58322
|
-
}
|
|
58323
|
-
},
|
|
58324
|
-
"/repositories/{repository_id}/environments/{environment_name}/secrets/public-key": {
|
|
58325
|
-
"get": {
|
|
58326
|
-
"summary": "Get an environment public key",
|
|
58327
|
-
"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.",
|
|
58328
|
-
"tags": [
|
|
58329
|
-
"actions"
|
|
58330
|
-
],
|
|
58331
|
-
"operationId": "actions/get-environment-public-key",
|
|
58332
|
-
"externalDocs": {
|
|
58333
|
-
"description": "API method documentation",
|
|
58334
|
-
"url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-public-key"
|
|
58335
|
-
},
|
|
58336
|
-
"parameters": [
|
|
58337
|
-
{
|
|
58338
|
-
"$ref": "#/components/parameters/repository-id"
|
|
58339
|
-
},
|
|
58340
|
-
{
|
|
58341
|
-
"$ref": "#/components/parameters/environment-name"
|
|
58342
|
-
}
|
|
58343
|
-
],
|
|
58344
|
-
"responses": {
|
|
58345
|
-
"200": {
|
|
58346
|
-
"description": "Response",
|
|
58347
|
-
"content": {
|
|
58348
|
-
"application/json": {
|
|
58349
|
-
"schema": {
|
|
58350
|
-
"$ref": "#/components/schemas/actions-public-key"
|
|
58351
|
-
},
|
|
58352
|
-
"examples": {
|
|
58353
|
-
"default": {
|
|
58354
|
-
"$ref": "#/components/examples/actions-public-key"
|
|
58355
|
-
}
|
|
58356
|
-
}
|
|
58357
|
-
}
|
|
58358
|
-
}
|
|
58359
|
-
}
|
|
58360
|
-
},
|
|
58361
|
-
"x-github": {
|
|
58362
|
-
"githubCloudOnly": false,
|
|
58363
|
-
"enabledForGitHubApps": true,
|
|
58364
|
-
"category": "actions",
|
|
58365
|
-
"subcategory": "secrets"
|
|
58366
|
-
},
|
|
58367
|
-
"x-octokit": {}
|
|
58368
|
-
}
|
|
58369
|
-
},
|
|
58370
|
-
"/repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}": {
|
|
58371
|
-
"get": {
|
|
58372
|
-
"summary": "Get an environment secret",
|
|
58373
|
-
"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.",
|
|
58374
|
-
"tags": [
|
|
58375
|
-
"actions"
|
|
58376
|
-
],
|
|
58377
|
-
"operationId": "actions/get-environment-secret",
|
|
58378
|
-
"externalDocs": {
|
|
58379
|
-
"description": "API method documentation",
|
|
58380
|
-
"url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-secret"
|
|
58381
|
-
},
|
|
58382
|
-
"parameters": [
|
|
58383
|
-
{
|
|
58384
|
-
"$ref": "#/components/parameters/repository-id"
|
|
58385
|
-
},
|
|
58386
|
-
{
|
|
58387
|
-
"$ref": "#/components/parameters/environment-name"
|
|
58388
|
-
},
|
|
58389
|
-
{
|
|
58390
|
-
"$ref": "#/components/parameters/secret-name"
|
|
58391
|
-
}
|
|
58392
|
-
],
|
|
58393
|
-
"responses": {
|
|
58394
|
-
"200": {
|
|
58395
|
-
"description": "Response",
|
|
58396
|
-
"content": {
|
|
58397
|
-
"application/json": {
|
|
58398
|
-
"schema": {
|
|
58399
|
-
"$ref": "#/components/schemas/actions-secret"
|
|
58400
|
-
},
|
|
58401
|
-
"examples": {
|
|
58402
|
-
"default": {
|
|
58403
|
-
"$ref": "#/components/examples/actions-secret"
|
|
58404
|
-
}
|
|
58405
|
-
}
|
|
58406
|
-
}
|
|
58407
|
-
}
|
|
58408
|
-
}
|
|
58409
|
-
},
|
|
58410
|
-
"x-github": {
|
|
58411
|
-
"githubCloudOnly": false,
|
|
58412
|
-
"enabledForGitHubApps": true,
|
|
58413
|
-
"category": "actions",
|
|
58414
|
-
"subcategory": "secrets"
|
|
58415
|
-
},
|
|
58416
|
-
"x-octokit": {}
|
|
58417
|
-
},
|
|
58418
|
-
"put": {
|
|
58419
|
-
"summary": "Create or update an environment secret",
|
|
58420
|
-
"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/enterprise-cloud@latest//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.",
|
|
58421
|
-
"tags": [
|
|
58422
|
-
"actions"
|
|
58423
|
-
],
|
|
58424
|
-
"operationId": "actions/create-or-update-environment-secret",
|
|
58425
|
-
"externalDocs": {
|
|
58426
|
-
"description": "API method documentation",
|
|
58427
|
-
"url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-environment-secret"
|
|
58428
|
-
},
|
|
58429
|
-
"parameters": [
|
|
58430
|
-
{
|
|
58431
|
-
"$ref": "#/components/parameters/repository-id"
|
|
58432
|
-
},
|
|
58433
|
-
{
|
|
58434
|
-
"$ref": "#/components/parameters/environment-name"
|
|
58435
|
-
},
|
|
58436
|
-
{
|
|
58437
|
-
"$ref": "#/components/parameters/secret-name"
|
|
58438
|
-
}
|
|
58439
|
-
],
|
|
58440
|
-
"requestBody": {
|
|
58441
|
-
"required": true,
|
|
58442
|
-
"content": {
|
|
58443
|
-
"application/json": {
|
|
58444
|
-
"schema": {
|
|
58445
|
-
"type": "object",
|
|
58446
|
-
"properties": {
|
|
58447
|
-
"encrypted_value": {
|
|
58448
|
-
"type": "string",
|
|
58449
|
-
"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/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-public-key) endpoint.",
|
|
58450
|
-
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$"
|
|
58451
|
-
},
|
|
58452
|
-
"key_id": {
|
|
58453
|
-
"type": "string",
|
|
58454
|
-
"description": "ID of the key you used to encrypt the secret."
|
|
58455
|
-
}
|
|
58456
|
-
},
|
|
58457
|
-
"required": [
|
|
58458
|
-
"encrypted_value",
|
|
58459
|
-
"key_id"
|
|
58460
|
-
]
|
|
58461
|
-
},
|
|
58462
|
-
"examples": {
|
|
58463
|
-
"default": {
|
|
58464
|
-
"value": {
|
|
58465
|
-
"encrypted_value": "c2VjcmV0",
|
|
58466
|
-
"key_id": "012345678912345678"
|
|
58467
|
-
}
|
|
58468
|
-
}
|
|
58469
|
-
}
|
|
58470
|
-
}
|
|
58471
|
-
}
|
|
58472
|
-
},
|
|
58473
|
-
"responses": {
|
|
58474
|
-
"201": {
|
|
58475
|
-
"description": "Response when creating a secret",
|
|
58476
|
-
"content": {
|
|
58477
|
-
"application/json": {
|
|
58478
|
-
"schema": {
|
|
58479
|
-
"$ref": "#/components/schemas/empty-object"
|
|
58480
|
-
},
|
|
58481
|
-
"examples": {
|
|
58482
|
-
"default": {
|
|
58483
|
-
"value": null
|
|
58484
|
-
}
|
|
58485
|
-
}
|
|
58486
|
-
}
|
|
58487
|
-
}
|
|
58488
|
-
},
|
|
58489
|
-
"204": {
|
|
58490
|
-
"description": "Response when updating a secret"
|
|
58491
|
-
}
|
|
58492
|
-
},
|
|
58493
|
-
"x-github": {
|
|
58494
|
-
"githubCloudOnly": false,
|
|
58495
|
-
"enabledForGitHubApps": true,
|
|
58496
|
-
"category": "actions",
|
|
58497
|
-
"subcategory": "secrets"
|
|
58498
|
-
},
|
|
58499
|
-
"x-octokit": {}
|
|
58500
|
-
},
|
|
58501
|
-
"delete": {
|
|
58502
|
-
"summary": "Delete an environment secret",
|
|
58503
|
-
"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.",
|
|
58504
|
-
"tags": [
|
|
58505
|
-
"actions"
|
|
58506
|
-
],
|
|
58507
|
-
"operationId": "actions/delete-environment-secret",
|
|
58508
|
-
"externalDocs": {
|
|
58509
|
-
"description": "API method documentation",
|
|
58510
|
-
"url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-an-environment-secret"
|
|
58511
|
-
},
|
|
58512
|
-
"parameters": [
|
|
58513
|
-
{
|
|
58514
|
-
"$ref": "#/components/parameters/repository-id"
|
|
58515
|
-
},
|
|
58516
|
-
{
|
|
58517
|
-
"$ref": "#/components/parameters/environment-name"
|
|
58518
|
-
},
|
|
58519
|
-
{
|
|
58520
|
-
"$ref": "#/components/parameters/secret-name"
|
|
58521
|
-
}
|
|
58522
|
-
],
|
|
58523
|
-
"responses": {
|
|
58524
|
-
"204": {
|
|
58525
|
-
"description": "Default response"
|
|
58526
|
-
}
|
|
58527
|
-
},
|
|
58528
|
-
"x-github": {
|
|
58529
|
-
"githubCloudOnly": false,
|
|
58530
|
-
"enabledForGitHubApps": true,
|
|
58531
|
-
"category": "actions",
|
|
58532
|
-
"subcategory": "secrets"
|
|
58533
|
-
},
|
|
58534
|
-
"x-octokit": {}
|
|
58535
|
-
}
|
|
58536
|
-
},
|
|
58537
|
-
"/repositories/{repository_id}/environments/{environment_name}/variables": {
|
|
58538
|
-
"get": {
|
|
58539
|
-
"summary": "List environment variables",
|
|
58540
|
-
"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.",
|
|
58541
|
-
"tags": [
|
|
58542
|
-
"actions"
|
|
58543
|
-
],
|
|
58544
|
-
"operationId": "actions/list-environment-variables",
|
|
58545
|
-
"externalDocs": {
|
|
58546
|
-
"description": "API method documentation",
|
|
58547
|
-
"url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-environment-variables"
|
|
58548
|
-
},
|
|
58549
|
-
"parameters": [
|
|
58550
|
-
{
|
|
58551
|
-
"$ref": "#/components/parameters/repository-id"
|
|
58552
|
-
},
|
|
58553
|
-
{
|
|
58554
|
-
"$ref": "#/components/parameters/environment-name"
|
|
58555
|
-
},
|
|
58556
|
-
{
|
|
58557
|
-
"$ref": "#/components/parameters/variables-per-page"
|
|
58558
|
-
},
|
|
58559
|
-
{
|
|
58560
|
-
"$ref": "#/components/parameters/page"
|
|
58561
|
-
}
|
|
58562
|
-
],
|
|
58563
|
-
"responses": {
|
|
58564
|
-
"200": {
|
|
58565
|
-
"description": "Response",
|
|
58566
|
-
"content": {
|
|
58567
|
-
"application/json": {
|
|
58568
|
-
"schema": {
|
|
58569
|
-
"type": "object",
|
|
58570
|
-
"required": [
|
|
58571
|
-
"total_count",
|
|
58572
|
-
"variables"
|
|
58573
|
-
],
|
|
58574
|
-
"properties": {
|
|
58575
|
-
"total_count": {
|
|
58576
|
-
"type": "integer"
|
|
58577
|
-
},
|
|
58578
|
-
"variables": {
|
|
58579
|
-
"type": "array",
|
|
58580
|
-
"items": {
|
|
58581
|
-
"$ref": "#/components/schemas/actions-variable"
|
|
58582
|
-
}
|
|
58583
|
-
}
|
|
58584
|
-
}
|
|
58585
|
-
},
|
|
58586
|
-
"examples": {
|
|
58587
|
-
"default": {
|
|
58588
|
-
"$ref": "#/components/examples/actions-variables-paginated"
|
|
58589
|
-
}
|
|
58590
|
-
}
|
|
58591
|
-
}
|
|
58592
|
-
},
|
|
58593
|
-
"headers": {
|
|
58594
|
-
"Link": {
|
|
58595
|
-
"$ref": "#/components/headers/link"
|
|
58596
|
-
}
|
|
58597
|
-
}
|
|
58598
|
-
}
|
|
58599
|
-
},
|
|
58600
|
-
"x-github": {
|
|
58601
|
-
"githubCloudOnly": false,
|
|
58602
|
-
"enabledForGitHubApps": true,
|
|
58603
|
-
"category": "actions",
|
|
58604
|
-
"subcategory": "variables"
|
|
58605
|
-
},
|
|
58606
|
-
"x-octokit": {}
|
|
58607
|
-
},
|
|
58608
|
-
"post": {
|
|
58609
|
-
"summary": "Create an environment variable",
|
|
58610
|
-
"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.",
|
|
58611
|
-
"tags": [
|
|
58612
|
-
"actions"
|
|
58613
|
-
],
|
|
58614
|
-
"operationId": "actions/create-environment-variable",
|
|
58615
|
-
"externalDocs": {
|
|
58616
|
-
"description": "API method documentation",
|
|
58617
|
-
"url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-an-environment-variable"
|
|
58618
|
-
},
|
|
58619
|
-
"parameters": [
|
|
58620
|
-
{
|
|
58621
|
-
"$ref": "#/components/parameters/repository-id"
|
|
58622
|
-
},
|
|
58623
|
-
{
|
|
58624
|
-
"$ref": "#/components/parameters/environment-name"
|
|
58625
|
-
}
|
|
58626
|
-
],
|
|
58627
|
-
"requestBody": {
|
|
58628
|
-
"required": true,
|
|
58629
|
-
"content": {
|
|
58630
|
-
"application/json": {
|
|
58631
|
-
"schema": {
|
|
58632
|
-
"type": "object",
|
|
58633
|
-
"properties": {
|
|
58634
|
-
"name": {
|
|
58635
|
-
"type": "string",
|
|
58636
|
-
"description": "The name of the variable."
|
|
58637
|
-
},
|
|
58638
|
-
"value": {
|
|
58639
|
-
"type": "string",
|
|
58640
|
-
"description": "The value of the variable."
|
|
58641
|
-
}
|
|
58642
|
-
},
|
|
58643
|
-
"required": [
|
|
58644
|
-
"name",
|
|
58645
|
-
"value"
|
|
58646
|
-
]
|
|
58647
|
-
},
|
|
58648
|
-
"examples": {
|
|
58649
|
-
"default": {
|
|
58650
|
-
"value": {
|
|
58651
|
-
"name": "USERNAME",
|
|
58652
|
-
"value": "octocat"
|
|
58653
|
-
}
|
|
58654
|
-
}
|
|
58655
|
-
}
|
|
58656
|
-
}
|
|
58657
|
-
}
|
|
58658
|
-
},
|
|
58659
|
-
"responses": {
|
|
58660
|
-
"201": {
|
|
58661
|
-
"description": "Response",
|
|
58662
|
-
"content": {
|
|
58663
|
-
"application/json": {
|
|
58664
|
-
"schema": {
|
|
58665
|
-
"$ref": "#/components/schemas/empty-object"
|
|
58666
|
-
},
|
|
58667
|
-
"examples": {
|
|
58668
|
-
"default": {
|
|
58669
|
-
"value": null
|
|
58670
|
-
}
|
|
58671
|
-
}
|
|
58672
|
-
}
|
|
58673
|
-
}
|
|
58674
|
-
}
|
|
58675
|
-
},
|
|
58676
|
-
"x-github": {
|
|
58677
|
-
"githubCloudOnly": false,
|
|
58678
|
-
"enabledForGitHubApps": true,
|
|
58679
|
-
"category": "actions",
|
|
58680
|
-
"subcategory": "variables"
|
|
58681
|
-
},
|
|
58682
|
-
"x-octokit": {}
|
|
58683
|
-
}
|
|
58684
|
-
},
|
|
58685
|
-
"/repositories/{repository_id}/environments/{environment_name}/variables/{name}": {
|
|
58686
|
-
"get": {
|
|
58687
|
-
"summary": "Get an environment variable",
|
|
58688
|
-
"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.",
|
|
58689
|
-
"tags": [
|
|
58690
|
-
"actions"
|
|
58691
|
-
],
|
|
58692
|
-
"operationId": "actions/get-environment-variable",
|
|
58693
|
-
"externalDocs": {
|
|
58694
|
-
"description": "API method documentation",
|
|
58695
|
-
"url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-an-environment-variable"
|
|
58696
|
-
},
|
|
58697
|
-
"parameters": [
|
|
58698
|
-
{
|
|
58699
|
-
"$ref": "#/components/parameters/repository-id"
|
|
58700
|
-
},
|
|
58701
|
-
{
|
|
58702
|
-
"$ref": "#/components/parameters/environment-name"
|
|
58703
|
-
},
|
|
58704
|
-
{
|
|
58705
|
-
"$ref": "#/components/parameters/variable-name"
|
|
58706
|
-
}
|
|
58707
|
-
],
|
|
58708
|
-
"responses": {
|
|
58709
|
-
"200": {
|
|
58710
|
-
"description": "Response",
|
|
58711
|
-
"content": {
|
|
58712
|
-
"application/json": {
|
|
58713
|
-
"schema": {
|
|
58714
|
-
"$ref": "#/components/schemas/actions-variable"
|
|
58715
|
-
},
|
|
58716
|
-
"examples": {
|
|
58717
|
-
"default": {
|
|
58718
|
-
"$ref": "#/components/examples/actions-variable"
|
|
58719
|
-
}
|
|
58720
|
-
}
|
|
58721
|
-
}
|
|
58722
|
-
}
|
|
58723
|
-
}
|
|
58724
|
-
},
|
|
58725
|
-
"x-github": {
|
|
58726
|
-
"githubCloudOnly": false,
|
|
58727
|
-
"enabledForGitHubApps": true,
|
|
58728
|
-
"category": "actions",
|
|
58729
|
-
"subcategory": "variables"
|
|
58730
|
-
},
|
|
58731
|
-
"x-octokit": {}
|
|
58732
|
-
},
|
|
58733
|
-
"patch": {
|
|
58734
|
-
"summary": "Update an environment variable",
|
|
58735
|
-
"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.",
|
|
58736
|
-
"tags": [
|
|
58737
|
-
"actions"
|
|
58738
|
-
],
|
|
58739
|
-
"operationId": "actions/update-environment-variable",
|
|
58740
|
-
"externalDocs": {
|
|
58741
|
-
"description": "API method documentation",
|
|
58742
|
-
"url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-an-environment-variable"
|
|
58743
|
-
},
|
|
58744
|
-
"parameters": [
|
|
58745
|
-
{
|
|
58746
|
-
"$ref": "#/components/parameters/repository-id"
|
|
58747
|
-
},
|
|
58748
|
-
{
|
|
58749
|
-
"$ref": "#/components/parameters/variable-name"
|
|
58750
|
-
},
|
|
58751
|
-
{
|
|
58752
|
-
"$ref": "#/components/parameters/environment-name"
|
|
58753
|
-
}
|
|
58754
|
-
],
|
|
58755
|
-
"requestBody": {
|
|
58756
|
-
"required": true,
|
|
58757
|
-
"content": {
|
|
58758
|
-
"application/json": {
|
|
58759
|
-
"schema": {
|
|
58760
|
-
"type": "object",
|
|
58761
|
-
"properties": {
|
|
58762
|
-
"name": {
|
|
58763
|
-
"type": "string",
|
|
58764
|
-
"description": "The name of the variable."
|
|
58765
|
-
},
|
|
58766
|
-
"value": {
|
|
58767
|
-
"type": "string",
|
|
58768
|
-
"description": "The value of the variable."
|
|
58769
|
-
}
|
|
58770
|
-
}
|
|
58771
|
-
},
|
|
58772
|
-
"examples": {
|
|
58773
|
-
"default": {
|
|
58774
|
-
"value": {
|
|
58775
|
-
"name": "USERNAME",
|
|
58776
|
-
"value": "octocat"
|
|
58777
|
-
}
|
|
58778
|
-
}
|
|
58779
|
-
}
|
|
58780
|
-
}
|
|
58781
|
-
}
|
|
58782
|
-
},
|
|
58783
|
-
"responses": {
|
|
58784
|
-
"204": {
|
|
58785
|
-
"description": "Response"
|
|
58786
|
-
}
|
|
58787
|
-
},
|
|
58788
|
-
"x-github": {
|
|
58789
|
-
"githubCloudOnly": false,
|
|
58790
|
-
"enabledForGitHubApps": true,
|
|
58791
|
-
"category": "actions",
|
|
58792
|
-
"subcategory": "variables"
|
|
58793
|
-
},
|
|
58794
|
-
"x-octokit": {}
|
|
58795
|
-
},
|
|
58796
|
-
"delete": {
|
|
58797
|
-
"summary": "Delete an environment variable",
|
|
58798
|
-
"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.",
|
|
58799
|
-
"tags": [
|
|
58800
|
-
"actions"
|
|
58801
|
-
],
|
|
58802
|
-
"operationId": "actions/delete-environment-variable",
|
|
58803
|
-
"externalDocs": {
|
|
58804
|
-
"description": "API method documentation",
|
|
58805
|
-
"url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-an-environment-variable"
|
|
58806
|
-
},
|
|
58807
|
-
"parameters": [
|
|
58808
|
-
{
|
|
58809
|
-
"$ref": "#/components/parameters/repository-id"
|
|
58810
|
-
},
|
|
58811
|
-
{
|
|
58812
|
-
"$ref": "#/components/parameters/variable-name"
|
|
58813
|
-
},
|
|
58814
|
-
{
|
|
58815
|
-
"$ref": "#/components/parameters/environment-name"
|
|
58816
|
-
}
|
|
58817
|
-
],
|
|
58818
|
-
"responses": {
|
|
58819
|
-
"204": {
|
|
58820
|
-
"description": "Response"
|
|
58821
|
-
}
|
|
58822
|
-
},
|
|
58823
|
-
"x-github": {
|
|
58824
|
-
"githubCloudOnly": false,
|
|
58825
|
-
"enabledForGitHubApps": true,
|
|
58826
|
-
"category": "actions",
|
|
58827
|
-
"subcategory": "variables"
|
|
58828
|
-
},
|
|
58829
|
-
"x-octokit": {}
|
|
58830
|
-
}
|
|
58831
|
-
},
|
|
58832
|
-
"/scim/v2/Groups": {
|
|
58960
|
+
"/scim/v2/enterprises/{enterprise}/Groups": {
|
|
58833
58961
|
"get": {
|
|
58834
58962
|
"summary": "List provisioned SCIM groups for an enterprise",
|
|
58835
58963
|
"description": "**Note:** The SCIM API endpoints for GitHub Enterprise Cloud accounts with enterprise managed users are currently only accessible through published identity provider applications.\nPublic access to SCIM API endpoints are in *private* beta and are subject to change.\n\nLists provisioned SCIM groups in an enterprise.\n\nYou can improve query search time by using the `excludedAttributes` query parameter with a value of `members` to exclude members from the response.",
|
|
@@ -58868,6 +58996,9 @@
|
|
|
58868
58996
|
},
|
|
58869
58997
|
{
|
|
58870
58998
|
"$ref": "#/components/parameters/count"
|
|
58999
|
+
},
|
|
59000
|
+
{
|
|
59001
|
+
"$ref": "#/components/parameters/enterprise"
|
|
58871
59002
|
}
|
|
58872
59003
|
],
|
|
58873
59004
|
"responses": {
|
|
@@ -58921,6 +59052,11 @@
|
|
|
58921
59052
|
"description": "API method documentation",
|
|
58922
59053
|
"url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#provision-a-scim-enterprise-group"
|
|
58923
59054
|
},
|
|
59055
|
+
"parameters": [
|
|
59056
|
+
{
|
|
59057
|
+
"$ref": "#/components/parameters/enterprise"
|
|
59058
|
+
}
|
|
59059
|
+
],
|
|
58924
59060
|
"requestBody": {
|
|
58925
59061
|
"required": true,
|
|
58926
59062
|
"content": {
|
|
@@ -58986,7 +59122,7 @@
|
|
|
58986
59122
|
"x-octokit": {}
|
|
58987
59123
|
}
|
|
58988
59124
|
},
|
|
58989
|
-
"/scim/v2/Groups/{scim_group_id}": {
|
|
59125
|
+
"/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}": {
|
|
58990
59126
|
"get": {
|
|
58991
59127
|
"summary": "Get SCIM provisioning information for an enterprise group",
|
|
58992
59128
|
"description": "**Note:** The SCIM API endpoints for GitHub Enterprise Cloud accounts with enterprise managed users are currently only accessible through published identity provider applications.\nPublic access to SCIM API endpoints are in *private* beta and are subject to change.\n\nGets information about a SCIM group.",
|
|
@@ -59004,6 +59140,9 @@
|
|
|
59004
59140
|
},
|
|
59005
59141
|
{
|
|
59006
59142
|
"$ref": "#/components/parameters/excluded-attributes"
|
|
59143
|
+
},
|
|
59144
|
+
{
|
|
59145
|
+
"$ref": "#/components/parameters/enterprise"
|
|
59007
59146
|
}
|
|
59008
59147
|
],
|
|
59009
59148
|
"responses": {
|
|
@@ -59063,6 +59202,9 @@
|
|
|
59063
59202
|
"parameters": [
|
|
59064
59203
|
{
|
|
59065
59204
|
"$ref": "#/components/parameters/scim-group-id"
|
|
59205
|
+
},
|
|
59206
|
+
{
|
|
59207
|
+
"$ref": "#/components/parameters/enterprise"
|
|
59066
59208
|
}
|
|
59067
59209
|
],
|
|
59068
59210
|
"requestBody": {
|
|
@@ -59170,6 +59312,9 @@
|
|
|
59170
59312
|
"parameters": [
|
|
59171
59313
|
{
|
|
59172
59314
|
"$ref": "#/components/parameters/scim-group-id"
|
|
59315
|
+
},
|
|
59316
|
+
{
|
|
59317
|
+
"$ref": "#/components/parameters/enterprise"
|
|
59173
59318
|
}
|
|
59174
59319
|
],
|
|
59175
59320
|
"requestBody": {
|
|
@@ -59287,6 +59432,9 @@
|
|
|
59287
59432
|
"parameters": [
|
|
59288
59433
|
{
|
|
59289
59434
|
"$ref": "#/components/parameters/scim-group-id"
|
|
59435
|
+
},
|
|
59436
|
+
{
|
|
59437
|
+
"$ref": "#/components/parameters/enterprise"
|
|
59290
59438
|
}
|
|
59291
59439
|
],
|
|
59292
59440
|
"responses": {
|
|
@@ -59321,7 +59469,7 @@
|
|
|
59321
59469
|
"x-octokit": {}
|
|
59322
59470
|
}
|
|
59323
59471
|
},
|
|
59324
|
-
"/scim/v2/Users": {
|
|
59472
|
+
"/scim/v2/enterprises/{enterprise}/Users": {
|
|
59325
59473
|
"get": {
|
|
59326
59474
|
"summary": "List SCIM provisioned identities for an enterprise",
|
|
59327
59475
|
"description": "**Note:** The SCIM API endpoints for GitHub Enterprise Cloud accounts with enterprise managed users are currently only accessible through published identity provider applications.\nPublic access to SCIM API endpoints are in *private* beta and are subject to change.\n\nLists provisioned SCIM enterprise members.\n\nWhen you remove a user with a SCIM-provisioned external identity from an enterprise using a `patch` with `active` flag to `false`, the user's metadata remains intact. This means they can potentially re-join the enterprise later. Although, while suspended, the user can't sign in. If you want to ensure the user can't re-join in the future, use the delete request. Only users who weren't permanently deleted will appear in the result list.",
|
|
@@ -59356,6 +59504,9 @@
|
|
|
59356
59504
|
},
|
|
59357
59505
|
{
|
|
59358
59506
|
"$ref": "#/components/parameters/count"
|
|
59507
|
+
},
|
|
59508
|
+
{
|
|
59509
|
+
"$ref": "#/components/parameters/enterprise"
|
|
59359
59510
|
}
|
|
59360
59511
|
],
|
|
59361
59512
|
"responses": {
|
|
@@ -59409,6 +59560,11 @@
|
|
|
59409
59560
|
"description": "API method documentation",
|
|
59410
59561
|
"url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#provision-a-scim-enterprise-user"
|
|
59411
59562
|
},
|
|
59563
|
+
"parameters": [
|
|
59564
|
+
{
|
|
59565
|
+
"$ref": "#/components/parameters/enterprise"
|
|
59566
|
+
}
|
|
59567
|
+
],
|
|
59412
59568
|
"requestBody": {
|
|
59413
59569
|
"required": true,
|
|
59414
59570
|
"content": {
|
|
@@ -59474,7 +59630,7 @@
|
|
|
59474
59630
|
"x-octokit": {}
|
|
59475
59631
|
}
|
|
59476
59632
|
},
|
|
59477
|
-
"/scim/v2/Users/{scim_user_id}": {
|
|
59633
|
+
"/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}": {
|
|
59478
59634
|
"get": {
|
|
59479
59635
|
"summary": "Get SCIM provisioning information for an enterprise user",
|
|
59480
59636
|
"description": "**Note:** The SCIM API endpoints for GitHub Enterprise Cloud accounts with enterprise managed users are currently only accessible through published identity provider applications.\nPublic access to SCIM API endpoints are in *private* beta and are subject to change.\n\nGets information about a SCIM user.",
|
|
@@ -59489,6 +59645,9 @@
|
|
|
59489
59645
|
"parameters": [
|
|
59490
59646
|
{
|
|
59491
59647
|
"$ref": "#/components/parameters/scim-user-id"
|
|
59648
|
+
},
|
|
59649
|
+
{
|
|
59650
|
+
"$ref": "#/components/parameters/enterprise"
|
|
59492
59651
|
}
|
|
59493
59652
|
],
|
|
59494
59653
|
"responses": {
|
|
@@ -59548,6 +59707,9 @@
|
|
|
59548
59707
|
"parameters": [
|
|
59549
59708
|
{
|
|
59550
59709
|
"$ref": "#/components/parameters/scim-user-id"
|
|
59710
|
+
},
|
|
59711
|
+
{
|
|
59712
|
+
"$ref": "#/components/parameters/enterprise"
|
|
59551
59713
|
}
|
|
59552
59714
|
],
|
|
59553
59715
|
"requestBody": {
|
|
@@ -59625,6 +59787,9 @@
|
|
|
59625
59787
|
"parameters": [
|
|
59626
59788
|
{
|
|
59627
59789
|
"$ref": "#/components/parameters/scim-user-id"
|
|
59790
|
+
},
|
|
59791
|
+
{
|
|
59792
|
+
"$ref": "#/components/parameters/enterprise"
|
|
59628
59793
|
}
|
|
59629
59794
|
],
|
|
59630
59795
|
"requestBody": {
|
|
@@ -59760,6 +59925,9 @@
|
|
|
59760
59925
|
"parameters": [
|
|
59761
59926
|
{
|
|
59762
59927
|
"$ref": "#/components/parameters/scim-user-id"
|
|
59928
|
+
},
|
|
59929
|
+
{
|
|
59930
|
+
"$ref": "#/components/parameters/enterprise"
|
|
59763
59931
|
}
|
|
59764
59932
|
],
|
|
59765
59933
|
"responses": {
|
|
@@ -70525,7 +70693,7 @@
|
|
|
70525
70693
|
"/users/{username}/hovercard": {
|
|
70526
70694
|
"get": {
|
|
70527
70695
|
"summary": "Get contextual information for a user",
|
|
70528
|
-
"description": "Provides hovercard information. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations.\n\
|
|
70696
|
+
"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.",
|
|
70529
70697
|
"tags": [
|
|
70530
70698
|
"users"
|
|
70531
70699
|
],
|
|
@@ -108405,6 +108573,38 @@
|
|
|
108405
108573
|
}
|
|
108406
108574
|
}
|
|
108407
108575
|
},
|
|
108576
|
+
"repository-rule-params-thresholds": {
|
|
108577
|
+
"title": "Thresholds",
|
|
108578
|
+
"description": "This setting will not take effect unless at least one code scanning status check is enabled.",
|
|
108579
|
+
"type": "object",
|
|
108580
|
+
"properties": {
|
|
108581
|
+
"code_scanning_alert_threshold": {
|
|
108582
|
+
"type": "string",
|
|
108583
|
+
"description": "Code scanning alert threshold",
|
|
108584
|
+
"enum": [
|
|
108585
|
+
"none",
|
|
108586
|
+
"errors",
|
|
108587
|
+
"errors_and_warnings",
|
|
108588
|
+
"all"
|
|
108589
|
+
]
|
|
108590
|
+
},
|
|
108591
|
+
"code_scanning_security_alert_threshold": {
|
|
108592
|
+
"type": "string",
|
|
108593
|
+
"description": "Code scanning security alert threshold.",
|
|
108594
|
+
"enum": [
|
|
108595
|
+
"none",
|
|
108596
|
+
"critical",
|
|
108597
|
+
"high_or_higher",
|
|
108598
|
+
"medium_or_higher",
|
|
108599
|
+
"all"
|
|
108600
|
+
]
|
|
108601
|
+
}
|
|
108602
|
+
},
|
|
108603
|
+
"required": [
|
|
108604
|
+
"code_scanning_alert_threshold",
|
|
108605
|
+
"code_scanning_security_alert_threshold"
|
|
108606
|
+
]
|
|
108607
|
+
},
|
|
108408
108608
|
"repository-rule": {
|
|
108409
108609
|
"title": "Repository Rule",
|
|
108410
108610
|
"type": "object",
|
|
@@ -110935,7 +111135,9 @@
|
|
|
110935
111135
|
"queued",
|
|
110936
111136
|
"in_progress",
|
|
110937
111137
|
"completed",
|
|
110938
|
-
"waiting"
|
|
111138
|
+
"waiting",
|
|
111139
|
+
"requested",
|
|
111140
|
+
"pending"
|
|
110939
111141
|
]
|
|
110940
111142
|
},
|
|
110941
111143
|
"conclusion": {
|
|
@@ -113624,13 +113826,16 @@
|
|
|
113624
113826
|
"nullable": true
|
|
113625
113827
|
},
|
|
113626
113828
|
"status": {
|
|
113627
|
-
"description": "The phase of the lifecycle that the check is currently in.",
|
|
113829
|
+
"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.",
|
|
113628
113830
|
"example": "queued",
|
|
113629
113831
|
"type": "string",
|
|
113630
113832
|
"enum": [
|
|
113631
113833
|
"queued",
|
|
113632
113834
|
"in_progress",
|
|
113633
|
-
"completed"
|
|
113835
|
+
"completed",
|
|
113836
|
+
"waiting",
|
|
113837
|
+
"requested",
|
|
113838
|
+
"pending"
|
|
113634
113839
|
]
|
|
113635
113840
|
},
|
|
113636
113841
|
"conclusion": {
|
|
@@ -113908,11 +114113,15 @@
|
|
|
113908
114113
|
},
|
|
113909
114114
|
"status": {
|
|
113910
114115
|
"type": "string",
|
|
114116
|
+
"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.",
|
|
113911
114117
|
"example": "completed",
|
|
113912
114118
|
"enum": [
|
|
113913
114119
|
"queued",
|
|
113914
114120
|
"in_progress",
|
|
113915
|
-
"completed"
|
|
114121
|
+
"completed",
|
|
114122
|
+
"waiting",
|
|
114123
|
+
"requested",
|
|
114124
|
+
"pending"
|
|
113916
114125
|
],
|
|
113917
114126
|
"nullable": true
|
|
113918
114127
|
},
|
|
@@ -181486,6 +181695,7 @@
|
|
|
181486
181695
|
"type": "object",
|
|
181487
181696
|
"properties": {
|
|
181488
181697
|
"permission": {
|
|
181698
|
+
"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.",
|
|
181489
181699
|
"type": "object",
|
|
181490
181700
|
"properties": {
|
|
181491
181701
|
"to": {
|
|
@@ -181500,6 +181710,18 @@
|
|
|
181500
181710
|
"required": [
|
|
181501
181711
|
"to"
|
|
181502
181712
|
]
|
|
181713
|
+
},
|
|
181714
|
+
"role_name": {
|
|
181715
|
+
"description": "The role assigned to the collaborator.",
|
|
181716
|
+
"type": "object",
|
|
181717
|
+
"properties": {
|
|
181718
|
+
"to": {
|
|
181719
|
+
"type": "string"
|
|
181720
|
+
}
|
|
181721
|
+
},
|
|
181722
|
+
"required": [
|
|
181723
|
+
"to"
|
|
181724
|
+
]
|
|
181503
181725
|
}
|
|
181504
181726
|
}
|
|
181505
181727
|
},
|
|
@@ -266249,7 +266471,7 @@
|
|
|
266249
266471
|
"type": "string"
|
|
266250
266472
|
},
|
|
266251
266473
|
"commits": {
|
|
266252
|
-
"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
|
|
266474
|
+
"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/enterprise-cloud@latest//rest/commits) to fetch additional commits.",
|
|
266253
266475
|
"type": "array",
|
|
266254
266476
|
"items": {
|
|
266255
266477
|
"title": "Commit",
|
|
@@ -319585,7 +319807,7 @@
|
|
|
319585
319807
|
},
|
|
319586
319808
|
"workflow-run-status": {
|
|
319587
319809
|
"name": "status",
|
|
319588
|
-
"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`.",
|
|
319810
|
+
"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`.",
|
|
319589
319811
|
"in": "query",
|
|
319590
319812
|
"required": false,
|
|
319591
319813
|
"schema": {
|
|
@@ -319839,6 +320061,17 @@
|
|
|
319839
320061
|
"type": "integer"
|
|
319840
320062
|
}
|
|
319841
320063
|
},
|
|
320064
|
+
"git-ref-only": {
|
|
320065
|
+
"name": "ref",
|
|
320066
|
+
"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.",
|
|
320067
|
+
"in": "path",
|
|
320068
|
+
"required": true,
|
|
320069
|
+
"example": "heads/feature-a",
|
|
320070
|
+
"schema": {
|
|
320071
|
+
"type": "string"
|
|
320072
|
+
},
|
|
320073
|
+
"x-multi-segment": true
|
|
320074
|
+
},
|
|
319842
320075
|
"since-user": {
|
|
319843
320076
|
"name": "since",
|
|
319844
320077
|
"description": "A user ID. Only return users with an ID greater than this ID.",
|
|
@@ -320307,16 +320540,6 @@
|
|
|
320307
320540
|
}
|
|
320308
320541
|
}
|
|
320309
320542
|
},
|
|
320310
|
-
"code_scanning_forbidden_read": {
|
|
320311
|
-
"description": "Response if GitHub Advanced Security is not enabled for this repository",
|
|
320312
|
-
"content": {
|
|
320313
|
-
"application/json": {
|
|
320314
|
-
"schema": {
|
|
320315
|
-
"$ref": "#/components/schemas/basic-error"
|
|
320316
|
-
}
|
|
320317
|
-
}
|
|
320318
|
-
}
|
|
320319
|
-
},
|
|
320320
320543
|
"forbidden_gist": {
|
|
320321
320544
|
"description": "Forbidden Gist",
|
|
320322
320545
|
"content": {
|
|
@@ -320406,6 +320629,16 @@
|
|
|
320406
320629
|
}
|
|
320407
320630
|
}
|
|
320408
320631
|
},
|
|
320632
|
+
"code_scanning_forbidden_read": {
|
|
320633
|
+
"description": "Response if GitHub Advanced Security is not enabled for this repository",
|
|
320634
|
+
"content": {
|
|
320635
|
+
"application/json": {
|
|
320636
|
+
"schema": {
|
|
320637
|
+
"$ref": "#/components/schemas/basic-error"
|
|
320638
|
+
}
|
|
320639
|
+
}
|
|
320640
|
+
}
|
|
320641
|
+
},
|
|
320409
320642
|
"code_scanning_forbidden_write": {
|
|
320410
320643
|
"description": "Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository",
|
|
320411
320644
|
"content": {
|