@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/ghes-3.10.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": {
|
|
@@ -8490,7 +8490,7 @@
|
|
|
8490
8490
|
"/feeds": {
|
|
8491
8491
|
"get": {
|
|
8492
8492
|
"summary": "Get feeds",
|
|
8493
|
-
"description": "
|
|
8493
|
+
"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 Server global public timeline\n* **User**: The public timeline for any user, using `uri_template`. For more information, see \"[Hypermedia](https://docs.github.com/enterprise-server@3.10/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 Server.\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-server@3.10/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-server@3.10/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens.",
|
|
8494
8494
|
"tags": [
|
|
8495
8495
|
"activity"
|
|
8496
8496
|
],
|
|
@@ -11362,7 +11362,7 @@
|
|
|
11362
11362
|
"/organizations": {
|
|
11363
11363
|
"get": {
|
|
11364
11364
|
"summary": "List organizations",
|
|
11365
|
-
"description": "Lists all organizations, in the order that they were created
|
|
11365
|
+
"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-server@3.10/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations.",
|
|
11366
11366
|
"tags": [
|
|
11367
11367
|
"orgs"
|
|
11368
11368
|
],
|
|
@@ -32707,11 +32707,14 @@
|
|
|
32707
32707
|
},
|
|
32708
32708
|
"status": {
|
|
32709
32709
|
"type": "string",
|
|
32710
|
-
"description": "The current status.",
|
|
32710
|
+
"description": "The current status of the check run. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`.",
|
|
32711
32711
|
"enum": [
|
|
32712
32712
|
"queued",
|
|
32713
32713
|
"in_progress",
|
|
32714
|
-
"completed"
|
|
32714
|
+
"completed",
|
|
32715
|
+
"waiting",
|
|
32716
|
+
"requested",
|
|
32717
|
+
"pending"
|
|
32715
32718
|
]
|
|
32716
32719
|
},
|
|
32717
32720
|
"conclusion": {
|
|
@@ -35366,6 +35369,9 @@
|
|
|
35366
35369
|
}
|
|
35367
35370
|
}
|
|
35368
35371
|
},
|
|
35372
|
+
"409": {
|
|
35373
|
+
"$ref": "#/components/responses/conflict"
|
|
35374
|
+
},
|
|
35369
35375
|
"422": {
|
|
35370
35376
|
"$ref": "#/components/responses/validation_failed"
|
|
35371
35377
|
}
|
|
@@ -35597,6 +35603,9 @@
|
|
|
35597
35603
|
"$ref": "#/components/headers/link"
|
|
35598
35604
|
}
|
|
35599
35605
|
}
|
|
35606
|
+
},
|
|
35607
|
+
"409": {
|
|
35608
|
+
"$ref": "#/components/responses/conflict"
|
|
35600
35609
|
}
|
|
35601
35610
|
},
|
|
35602
35611
|
"x-github": {
|
|
@@ -35656,6 +35665,9 @@
|
|
|
35656
35665
|
"404": {
|
|
35657
35666
|
"$ref": "#/components/responses/not_found"
|
|
35658
35667
|
},
|
|
35668
|
+
"409": {
|
|
35669
|
+
"$ref": "#/components/responses/conflict"
|
|
35670
|
+
},
|
|
35659
35671
|
"422": {
|
|
35660
35672
|
"$ref": "#/components/responses/validation_failed"
|
|
35661
35673
|
},
|
|
@@ -35993,7 +36005,7 @@
|
|
|
35993
36005
|
"/repos/{owner}/{repo}/compare/{basehead}": {
|
|
35994
36006
|
"get": {
|
|
35995
36007
|
"summary": "Compare two commits",
|
|
35996
|
-
"description": "Compares two commits against one another. You can compare branches in the same repository, or you can compare
|
|
36008
|
+
"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-server@3.10/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-server@3.10/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-server@3.10/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. |",
|
|
35997
36009
|
"tags": [
|
|
35998
36010
|
"repos"
|
|
35999
36011
|
],
|
|
@@ -38919,6 +38931,616 @@
|
|
|
38919
38931
|
"x-octokit": {}
|
|
38920
38932
|
}
|
|
38921
38933
|
},
|
|
38934
|
+
"/repos/{owner}/{repo}/environments/{environment_name}/secrets": {
|
|
38935
|
+
"get": {
|
|
38936
|
+
"summary": "List environment secrets",
|
|
38937
|
+
"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.",
|
|
38938
|
+
"tags": [
|
|
38939
|
+
"actions"
|
|
38940
|
+
],
|
|
38941
|
+
"operationId": "actions/list-environment-secrets",
|
|
38942
|
+
"externalDocs": {
|
|
38943
|
+
"description": "API method documentation",
|
|
38944
|
+
"url": "https://docs.github.com/enterprise-server@3.10/rest/actions/secrets#list-environment-secrets"
|
|
38945
|
+
},
|
|
38946
|
+
"parameters": [
|
|
38947
|
+
{
|
|
38948
|
+
"$ref": "#/components/parameters/owner"
|
|
38949
|
+
},
|
|
38950
|
+
{
|
|
38951
|
+
"$ref": "#/components/parameters/repo"
|
|
38952
|
+
},
|
|
38953
|
+
{
|
|
38954
|
+
"$ref": "#/components/parameters/environment-name"
|
|
38955
|
+
},
|
|
38956
|
+
{
|
|
38957
|
+
"$ref": "#/components/parameters/per-page"
|
|
38958
|
+
},
|
|
38959
|
+
{
|
|
38960
|
+
"$ref": "#/components/parameters/page"
|
|
38961
|
+
}
|
|
38962
|
+
],
|
|
38963
|
+
"responses": {
|
|
38964
|
+
"200": {
|
|
38965
|
+
"description": "Response",
|
|
38966
|
+
"content": {
|
|
38967
|
+
"application/json": {
|
|
38968
|
+
"schema": {
|
|
38969
|
+
"type": "object",
|
|
38970
|
+
"required": [
|
|
38971
|
+
"total_count",
|
|
38972
|
+
"secrets"
|
|
38973
|
+
],
|
|
38974
|
+
"properties": {
|
|
38975
|
+
"total_count": {
|
|
38976
|
+
"type": "integer"
|
|
38977
|
+
},
|
|
38978
|
+
"secrets": {
|
|
38979
|
+
"type": "array",
|
|
38980
|
+
"items": {
|
|
38981
|
+
"$ref": "#/components/schemas/actions-secret"
|
|
38982
|
+
}
|
|
38983
|
+
}
|
|
38984
|
+
}
|
|
38985
|
+
},
|
|
38986
|
+
"examples": {
|
|
38987
|
+
"default": {
|
|
38988
|
+
"$ref": "#/components/examples/actions-secret-paginated"
|
|
38989
|
+
}
|
|
38990
|
+
}
|
|
38991
|
+
}
|
|
38992
|
+
},
|
|
38993
|
+
"headers": {
|
|
38994
|
+
"Link": {
|
|
38995
|
+
"$ref": "#/components/headers/link"
|
|
38996
|
+
}
|
|
38997
|
+
}
|
|
38998
|
+
}
|
|
38999
|
+
},
|
|
39000
|
+
"x-github": {
|
|
39001
|
+
"githubCloudOnly": false,
|
|
39002
|
+
"enabledForGitHubApps": true,
|
|
39003
|
+
"category": "actions",
|
|
39004
|
+
"subcategory": "secrets"
|
|
39005
|
+
},
|
|
39006
|
+
"x-octokit": {}
|
|
39007
|
+
}
|
|
39008
|
+
},
|
|
39009
|
+
"/repos/{owner}/{repo}/environments/{environment_name}/secrets/public-key": {
|
|
39010
|
+
"get": {
|
|
39011
|
+
"summary": "Get an environment public key",
|
|
39012
|
+
"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.",
|
|
39013
|
+
"tags": [
|
|
39014
|
+
"actions"
|
|
39015
|
+
],
|
|
39016
|
+
"operationId": "actions/get-environment-public-key",
|
|
39017
|
+
"externalDocs": {
|
|
39018
|
+
"description": "API method documentation",
|
|
39019
|
+
"url": "https://docs.github.com/enterprise-server@3.10/rest/actions/secrets#get-an-environment-public-key"
|
|
39020
|
+
},
|
|
39021
|
+
"parameters": [
|
|
39022
|
+
{
|
|
39023
|
+
"$ref": "#/components/parameters/owner"
|
|
39024
|
+
},
|
|
39025
|
+
{
|
|
39026
|
+
"$ref": "#/components/parameters/repo"
|
|
39027
|
+
},
|
|
39028
|
+
{
|
|
39029
|
+
"$ref": "#/components/parameters/environment-name"
|
|
39030
|
+
}
|
|
39031
|
+
],
|
|
39032
|
+
"responses": {
|
|
39033
|
+
"200": {
|
|
39034
|
+
"description": "Response",
|
|
39035
|
+
"content": {
|
|
39036
|
+
"application/json": {
|
|
39037
|
+
"schema": {
|
|
39038
|
+
"$ref": "#/components/schemas/actions-public-key"
|
|
39039
|
+
},
|
|
39040
|
+
"examples": {
|
|
39041
|
+
"default": {
|
|
39042
|
+
"$ref": "#/components/examples/actions-public-key"
|
|
39043
|
+
}
|
|
39044
|
+
}
|
|
39045
|
+
}
|
|
39046
|
+
}
|
|
39047
|
+
}
|
|
39048
|
+
},
|
|
39049
|
+
"x-github": {
|
|
39050
|
+
"githubCloudOnly": false,
|
|
39051
|
+
"enabledForGitHubApps": true,
|
|
39052
|
+
"category": "actions",
|
|
39053
|
+
"subcategory": "secrets"
|
|
39054
|
+
},
|
|
39055
|
+
"x-octokit": {}
|
|
39056
|
+
}
|
|
39057
|
+
},
|
|
39058
|
+
"/repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}": {
|
|
39059
|
+
"get": {
|
|
39060
|
+
"summary": "Get an environment secret",
|
|
39061
|
+
"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.",
|
|
39062
|
+
"tags": [
|
|
39063
|
+
"actions"
|
|
39064
|
+
],
|
|
39065
|
+
"operationId": "actions/get-environment-secret",
|
|
39066
|
+
"externalDocs": {
|
|
39067
|
+
"description": "API method documentation",
|
|
39068
|
+
"url": "https://docs.github.com/enterprise-server@3.10/rest/actions/secrets#get-an-environment-secret"
|
|
39069
|
+
},
|
|
39070
|
+
"parameters": [
|
|
39071
|
+
{
|
|
39072
|
+
"$ref": "#/components/parameters/owner"
|
|
39073
|
+
},
|
|
39074
|
+
{
|
|
39075
|
+
"$ref": "#/components/parameters/repo"
|
|
39076
|
+
},
|
|
39077
|
+
{
|
|
39078
|
+
"$ref": "#/components/parameters/environment-name"
|
|
39079
|
+
},
|
|
39080
|
+
{
|
|
39081
|
+
"$ref": "#/components/parameters/secret-name"
|
|
39082
|
+
}
|
|
39083
|
+
],
|
|
39084
|
+
"responses": {
|
|
39085
|
+
"200": {
|
|
39086
|
+
"description": "Response",
|
|
39087
|
+
"content": {
|
|
39088
|
+
"application/json": {
|
|
39089
|
+
"schema": {
|
|
39090
|
+
"$ref": "#/components/schemas/actions-secret"
|
|
39091
|
+
},
|
|
39092
|
+
"examples": {
|
|
39093
|
+
"default": {
|
|
39094
|
+
"$ref": "#/components/examples/actions-secret"
|
|
39095
|
+
}
|
|
39096
|
+
}
|
|
39097
|
+
}
|
|
39098
|
+
}
|
|
39099
|
+
}
|
|
39100
|
+
},
|
|
39101
|
+
"x-github": {
|
|
39102
|
+
"githubCloudOnly": false,
|
|
39103
|
+
"enabledForGitHubApps": true,
|
|
39104
|
+
"category": "actions",
|
|
39105
|
+
"subcategory": "secrets"
|
|
39106
|
+
},
|
|
39107
|
+
"x-octokit": {}
|
|
39108
|
+
},
|
|
39109
|
+
"put": {
|
|
39110
|
+
"summary": "Create or update an environment secret",
|
|
39111
|
+
"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-server@3.10/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.",
|
|
39112
|
+
"tags": [
|
|
39113
|
+
"actions"
|
|
39114
|
+
],
|
|
39115
|
+
"operationId": "actions/create-or-update-environment-secret",
|
|
39116
|
+
"externalDocs": {
|
|
39117
|
+
"description": "API method documentation",
|
|
39118
|
+
"url": "https://docs.github.com/enterprise-server@3.10/rest/actions/secrets#create-or-update-an-environment-secret"
|
|
39119
|
+
},
|
|
39120
|
+
"parameters": [
|
|
39121
|
+
{
|
|
39122
|
+
"$ref": "#/components/parameters/owner"
|
|
39123
|
+
},
|
|
39124
|
+
{
|
|
39125
|
+
"$ref": "#/components/parameters/repo"
|
|
39126
|
+
},
|
|
39127
|
+
{
|
|
39128
|
+
"$ref": "#/components/parameters/environment-name"
|
|
39129
|
+
},
|
|
39130
|
+
{
|
|
39131
|
+
"$ref": "#/components/parameters/secret-name"
|
|
39132
|
+
}
|
|
39133
|
+
],
|
|
39134
|
+
"requestBody": {
|
|
39135
|
+
"required": true,
|
|
39136
|
+
"content": {
|
|
39137
|
+
"application/json": {
|
|
39138
|
+
"schema": {
|
|
39139
|
+
"type": "object",
|
|
39140
|
+
"properties": {
|
|
39141
|
+
"encrypted_value": {
|
|
39142
|
+
"type": "string",
|
|
39143
|
+
"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-server@3.10/rest/actions/secrets#get-an-environment-public-key) endpoint.",
|
|
39144
|
+
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$"
|
|
39145
|
+
},
|
|
39146
|
+
"key_id": {
|
|
39147
|
+
"type": "string",
|
|
39148
|
+
"description": "ID of the key you used to encrypt the secret."
|
|
39149
|
+
}
|
|
39150
|
+
},
|
|
39151
|
+
"required": [
|
|
39152
|
+
"encrypted_value",
|
|
39153
|
+
"key_id"
|
|
39154
|
+
]
|
|
39155
|
+
},
|
|
39156
|
+
"examples": {
|
|
39157
|
+
"default": {
|
|
39158
|
+
"value": {
|
|
39159
|
+
"encrypted_value": "c2VjcmV0",
|
|
39160
|
+
"key_id": "012345678912345678"
|
|
39161
|
+
}
|
|
39162
|
+
}
|
|
39163
|
+
}
|
|
39164
|
+
}
|
|
39165
|
+
}
|
|
39166
|
+
},
|
|
39167
|
+
"responses": {
|
|
39168
|
+
"201": {
|
|
39169
|
+
"description": "Response when creating a secret",
|
|
39170
|
+
"content": {
|
|
39171
|
+
"application/json": {
|
|
39172
|
+
"schema": {
|
|
39173
|
+
"$ref": "#/components/schemas/empty-object"
|
|
39174
|
+
},
|
|
39175
|
+
"examples": {
|
|
39176
|
+
"default": {
|
|
39177
|
+
"value": null
|
|
39178
|
+
}
|
|
39179
|
+
}
|
|
39180
|
+
}
|
|
39181
|
+
}
|
|
39182
|
+
},
|
|
39183
|
+
"204": {
|
|
39184
|
+
"description": "Response when updating a secret"
|
|
39185
|
+
}
|
|
39186
|
+
},
|
|
39187
|
+
"x-github": {
|
|
39188
|
+
"githubCloudOnly": false,
|
|
39189
|
+
"enabledForGitHubApps": true,
|
|
39190
|
+
"category": "actions",
|
|
39191
|
+
"subcategory": "secrets"
|
|
39192
|
+
},
|
|
39193
|
+
"x-octokit": {}
|
|
39194
|
+
},
|
|
39195
|
+
"delete": {
|
|
39196
|
+
"summary": "Delete an environment secret",
|
|
39197
|
+
"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.",
|
|
39198
|
+
"tags": [
|
|
39199
|
+
"actions"
|
|
39200
|
+
],
|
|
39201
|
+
"operationId": "actions/delete-environment-secret",
|
|
39202
|
+
"externalDocs": {
|
|
39203
|
+
"description": "API method documentation",
|
|
39204
|
+
"url": "https://docs.github.com/enterprise-server@3.10/rest/actions/secrets#delete-an-environment-secret"
|
|
39205
|
+
},
|
|
39206
|
+
"parameters": [
|
|
39207
|
+
{
|
|
39208
|
+
"$ref": "#/components/parameters/owner"
|
|
39209
|
+
},
|
|
39210
|
+
{
|
|
39211
|
+
"$ref": "#/components/parameters/repo"
|
|
39212
|
+
},
|
|
39213
|
+
{
|
|
39214
|
+
"$ref": "#/components/parameters/environment-name"
|
|
39215
|
+
},
|
|
39216
|
+
{
|
|
39217
|
+
"$ref": "#/components/parameters/secret-name"
|
|
39218
|
+
}
|
|
39219
|
+
],
|
|
39220
|
+
"responses": {
|
|
39221
|
+
"204": {
|
|
39222
|
+
"description": "Default response"
|
|
39223
|
+
}
|
|
39224
|
+
},
|
|
39225
|
+
"x-github": {
|
|
39226
|
+
"githubCloudOnly": false,
|
|
39227
|
+
"enabledForGitHubApps": true,
|
|
39228
|
+
"category": "actions",
|
|
39229
|
+
"subcategory": "secrets"
|
|
39230
|
+
},
|
|
39231
|
+
"x-octokit": {}
|
|
39232
|
+
}
|
|
39233
|
+
},
|
|
39234
|
+
"/repos/{owner}/{repo}/environments/{environment_name}/variables": {
|
|
39235
|
+
"get": {
|
|
39236
|
+
"summary": "List environment variables",
|
|
39237
|
+
"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.",
|
|
39238
|
+
"tags": [
|
|
39239
|
+
"actions"
|
|
39240
|
+
],
|
|
39241
|
+
"operationId": "actions/list-environment-variables",
|
|
39242
|
+
"externalDocs": {
|
|
39243
|
+
"description": "API method documentation",
|
|
39244
|
+
"url": "https://docs.github.com/enterprise-server@3.10/rest/actions/variables#list-environment-variables"
|
|
39245
|
+
},
|
|
39246
|
+
"parameters": [
|
|
39247
|
+
{
|
|
39248
|
+
"$ref": "#/components/parameters/owner"
|
|
39249
|
+
},
|
|
39250
|
+
{
|
|
39251
|
+
"$ref": "#/components/parameters/repo"
|
|
39252
|
+
},
|
|
39253
|
+
{
|
|
39254
|
+
"$ref": "#/components/parameters/environment-name"
|
|
39255
|
+
},
|
|
39256
|
+
{
|
|
39257
|
+
"$ref": "#/components/parameters/variables-per-page"
|
|
39258
|
+
},
|
|
39259
|
+
{
|
|
39260
|
+
"$ref": "#/components/parameters/page"
|
|
39261
|
+
}
|
|
39262
|
+
],
|
|
39263
|
+
"responses": {
|
|
39264
|
+
"200": {
|
|
39265
|
+
"description": "Response",
|
|
39266
|
+
"content": {
|
|
39267
|
+
"application/json": {
|
|
39268
|
+
"schema": {
|
|
39269
|
+
"type": "object",
|
|
39270
|
+
"required": [
|
|
39271
|
+
"total_count",
|
|
39272
|
+
"variables"
|
|
39273
|
+
],
|
|
39274
|
+
"properties": {
|
|
39275
|
+
"total_count": {
|
|
39276
|
+
"type": "integer"
|
|
39277
|
+
},
|
|
39278
|
+
"variables": {
|
|
39279
|
+
"type": "array",
|
|
39280
|
+
"items": {
|
|
39281
|
+
"$ref": "#/components/schemas/actions-variable"
|
|
39282
|
+
}
|
|
39283
|
+
}
|
|
39284
|
+
}
|
|
39285
|
+
},
|
|
39286
|
+
"examples": {
|
|
39287
|
+
"default": {
|
|
39288
|
+
"$ref": "#/components/examples/actions-variables-paginated"
|
|
39289
|
+
}
|
|
39290
|
+
}
|
|
39291
|
+
}
|
|
39292
|
+
},
|
|
39293
|
+
"headers": {
|
|
39294
|
+
"Link": {
|
|
39295
|
+
"$ref": "#/components/headers/link"
|
|
39296
|
+
}
|
|
39297
|
+
}
|
|
39298
|
+
}
|
|
39299
|
+
},
|
|
39300
|
+
"x-github": {
|
|
39301
|
+
"githubCloudOnly": false,
|
|
39302
|
+
"enabledForGitHubApps": true,
|
|
39303
|
+
"category": "actions",
|
|
39304
|
+
"subcategory": "variables"
|
|
39305
|
+
},
|
|
39306
|
+
"x-octokit": {}
|
|
39307
|
+
},
|
|
39308
|
+
"post": {
|
|
39309
|
+
"summary": "Create an environment variable",
|
|
39310
|
+
"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.",
|
|
39311
|
+
"tags": [
|
|
39312
|
+
"actions"
|
|
39313
|
+
],
|
|
39314
|
+
"operationId": "actions/create-environment-variable",
|
|
39315
|
+
"externalDocs": {
|
|
39316
|
+
"description": "API method documentation",
|
|
39317
|
+
"url": "https://docs.github.com/enterprise-server@3.10/rest/actions/variables#create-an-environment-variable"
|
|
39318
|
+
},
|
|
39319
|
+
"parameters": [
|
|
39320
|
+
{
|
|
39321
|
+
"$ref": "#/components/parameters/owner"
|
|
39322
|
+
},
|
|
39323
|
+
{
|
|
39324
|
+
"$ref": "#/components/parameters/repo"
|
|
39325
|
+
},
|
|
39326
|
+
{
|
|
39327
|
+
"$ref": "#/components/parameters/environment-name"
|
|
39328
|
+
}
|
|
39329
|
+
],
|
|
39330
|
+
"requestBody": {
|
|
39331
|
+
"required": true,
|
|
39332
|
+
"content": {
|
|
39333
|
+
"application/json": {
|
|
39334
|
+
"schema": {
|
|
39335
|
+
"type": "object",
|
|
39336
|
+
"properties": {
|
|
39337
|
+
"name": {
|
|
39338
|
+
"type": "string",
|
|
39339
|
+
"description": "The name of the variable."
|
|
39340
|
+
},
|
|
39341
|
+
"value": {
|
|
39342
|
+
"type": "string",
|
|
39343
|
+
"description": "The value of the variable."
|
|
39344
|
+
}
|
|
39345
|
+
},
|
|
39346
|
+
"required": [
|
|
39347
|
+
"name",
|
|
39348
|
+
"value"
|
|
39349
|
+
]
|
|
39350
|
+
},
|
|
39351
|
+
"examples": {
|
|
39352
|
+
"default": {
|
|
39353
|
+
"value": {
|
|
39354
|
+
"name": "USERNAME",
|
|
39355
|
+
"value": "octocat"
|
|
39356
|
+
}
|
|
39357
|
+
}
|
|
39358
|
+
}
|
|
39359
|
+
}
|
|
39360
|
+
}
|
|
39361
|
+
},
|
|
39362
|
+
"responses": {
|
|
39363
|
+
"201": {
|
|
39364
|
+
"description": "Response",
|
|
39365
|
+
"content": {
|
|
39366
|
+
"application/json": {
|
|
39367
|
+
"schema": {
|
|
39368
|
+
"$ref": "#/components/schemas/empty-object"
|
|
39369
|
+
},
|
|
39370
|
+
"examples": {
|
|
39371
|
+
"default": {
|
|
39372
|
+
"value": null
|
|
39373
|
+
}
|
|
39374
|
+
}
|
|
39375
|
+
}
|
|
39376
|
+
}
|
|
39377
|
+
}
|
|
39378
|
+
},
|
|
39379
|
+
"x-github": {
|
|
39380
|
+
"githubCloudOnly": false,
|
|
39381
|
+
"enabledForGitHubApps": true,
|
|
39382
|
+
"category": "actions",
|
|
39383
|
+
"subcategory": "variables"
|
|
39384
|
+
},
|
|
39385
|
+
"x-octokit": {}
|
|
39386
|
+
}
|
|
39387
|
+
},
|
|
39388
|
+
"/repos/{owner}/{repo}/environments/{environment_name}/variables/{name}": {
|
|
39389
|
+
"get": {
|
|
39390
|
+
"summary": "Get an environment variable",
|
|
39391
|
+
"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.",
|
|
39392
|
+
"tags": [
|
|
39393
|
+
"actions"
|
|
39394
|
+
],
|
|
39395
|
+
"operationId": "actions/get-environment-variable",
|
|
39396
|
+
"externalDocs": {
|
|
39397
|
+
"description": "API method documentation",
|
|
39398
|
+
"url": "https://docs.github.com/enterprise-server@3.10/rest/actions/variables#get-an-environment-variable"
|
|
39399
|
+
},
|
|
39400
|
+
"parameters": [
|
|
39401
|
+
{
|
|
39402
|
+
"$ref": "#/components/parameters/owner"
|
|
39403
|
+
},
|
|
39404
|
+
{
|
|
39405
|
+
"$ref": "#/components/parameters/repo"
|
|
39406
|
+
},
|
|
39407
|
+
{
|
|
39408
|
+
"$ref": "#/components/parameters/environment-name"
|
|
39409
|
+
},
|
|
39410
|
+
{
|
|
39411
|
+
"$ref": "#/components/parameters/variable-name"
|
|
39412
|
+
}
|
|
39413
|
+
],
|
|
39414
|
+
"responses": {
|
|
39415
|
+
"200": {
|
|
39416
|
+
"description": "Response",
|
|
39417
|
+
"content": {
|
|
39418
|
+
"application/json": {
|
|
39419
|
+
"schema": {
|
|
39420
|
+
"$ref": "#/components/schemas/actions-variable"
|
|
39421
|
+
},
|
|
39422
|
+
"examples": {
|
|
39423
|
+
"default": {
|
|
39424
|
+
"$ref": "#/components/examples/actions-variable"
|
|
39425
|
+
}
|
|
39426
|
+
}
|
|
39427
|
+
}
|
|
39428
|
+
}
|
|
39429
|
+
}
|
|
39430
|
+
},
|
|
39431
|
+
"x-github": {
|
|
39432
|
+
"githubCloudOnly": false,
|
|
39433
|
+
"enabledForGitHubApps": true,
|
|
39434
|
+
"category": "actions",
|
|
39435
|
+
"subcategory": "variables"
|
|
39436
|
+
},
|
|
39437
|
+
"x-octokit": {}
|
|
39438
|
+
},
|
|
39439
|
+
"patch": {
|
|
39440
|
+
"summary": "Update an environment variable",
|
|
39441
|
+
"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.",
|
|
39442
|
+
"tags": [
|
|
39443
|
+
"actions"
|
|
39444
|
+
],
|
|
39445
|
+
"operationId": "actions/update-environment-variable",
|
|
39446
|
+
"externalDocs": {
|
|
39447
|
+
"description": "API method documentation",
|
|
39448
|
+
"url": "https://docs.github.com/enterprise-server@3.10/rest/actions/variables#update-an-environment-variable"
|
|
39449
|
+
},
|
|
39450
|
+
"parameters": [
|
|
39451
|
+
{
|
|
39452
|
+
"$ref": "#/components/parameters/owner"
|
|
39453
|
+
},
|
|
39454
|
+
{
|
|
39455
|
+
"$ref": "#/components/parameters/repo"
|
|
39456
|
+
},
|
|
39457
|
+
{
|
|
39458
|
+
"$ref": "#/components/parameters/variable-name"
|
|
39459
|
+
},
|
|
39460
|
+
{
|
|
39461
|
+
"$ref": "#/components/parameters/environment-name"
|
|
39462
|
+
}
|
|
39463
|
+
],
|
|
39464
|
+
"requestBody": {
|
|
39465
|
+
"required": true,
|
|
39466
|
+
"content": {
|
|
39467
|
+
"application/json": {
|
|
39468
|
+
"schema": {
|
|
39469
|
+
"type": "object",
|
|
39470
|
+
"properties": {
|
|
39471
|
+
"name": {
|
|
39472
|
+
"type": "string",
|
|
39473
|
+
"description": "The name of the variable."
|
|
39474
|
+
},
|
|
39475
|
+
"value": {
|
|
39476
|
+
"type": "string",
|
|
39477
|
+
"description": "The value of the variable."
|
|
39478
|
+
}
|
|
39479
|
+
}
|
|
39480
|
+
},
|
|
39481
|
+
"examples": {
|
|
39482
|
+
"default": {
|
|
39483
|
+
"value": {
|
|
39484
|
+
"name": "USERNAME",
|
|
39485
|
+
"value": "octocat"
|
|
39486
|
+
}
|
|
39487
|
+
}
|
|
39488
|
+
}
|
|
39489
|
+
}
|
|
39490
|
+
}
|
|
39491
|
+
},
|
|
39492
|
+
"responses": {
|
|
39493
|
+
"204": {
|
|
39494
|
+
"description": "Response"
|
|
39495
|
+
}
|
|
39496
|
+
},
|
|
39497
|
+
"x-github": {
|
|
39498
|
+
"githubCloudOnly": false,
|
|
39499
|
+
"enabledForGitHubApps": true,
|
|
39500
|
+
"category": "actions",
|
|
39501
|
+
"subcategory": "variables"
|
|
39502
|
+
},
|
|
39503
|
+
"x-octokit": {}
|
|
39504
|
+
},
|
|
39505
|
+
"delete": {
|
|
39506
|
+
"summary": "Delete an environment variable",
|
|
39507
|
+
"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.",
|
|
39508
|
+
"tags": [
|
|
39509
|
+
"actions"
|
|
39510
|
+
],
|
|
39511
|
+
"operationId": "actions/delete-environment-variable",
|
|
39512
|
+
"externalDocs": {
|
|
39513
|
+
"description": "API method documentation",
|
|
39514
|
+
"url": "https://docs.github.com/enterprise-server@3.10/rest/actions/variables#delete-an-environment-variable"
|
|
39515
|
+
},
|
|
39516
|
+
"parameters": [
|
|
39517
|
+
{
|
|
39518
|
+
"$ref": "#/components/parameters/owner"
|
|
39519
|
+
},
|
|
39520
|
+
{
|
|
39521
|
+
"$ref": "#/components/parameters/repo"
|
|
39522
|
+
},
|
|
39523
|
+
{
|
|
39524
|
+
"$ref": "#/components/parameters/variable-name"
|
|
39525
|
+
},
|
|
39526
|
+
{
|
|
39527
|
+
"$ref": "#/components/parameters/environment-name"
|
|
39528
|
+
}
|
|
39529
|
+
],
|
|
39530
|
+
"responses": {
|
|
39531
|
+
"204": {
|
|
39532
|
+
"description": "Response"
|
|
39533
|
+
}
|
|
39534
|
+
},
|
|
39535
|
+
"x-github": {
|
|
39536
|
+
"githubCloudOnly": false,
|
|
39537
|
+
"enabledForGitHubApps": true,
|
|
39538
|
+
"category": "actions",
|
|
39539
|
+
"subcategory": "variables"
|
|
39540
|
+
},
|
|
39541
|
+
"x-octokit": {}
|
|
39542
|
+
}
|
|
39543
|
+
},
|
|
38922
39544
|
"/repos/{owner}/{repo}/events": {
|
|
38923
39545
|
"get": {
|
|
38924
39546
|
"summary": "List repository events",
|
|
@@ -39291,6 +39913,9 @@
|
|
|
39291
39913
|
"404": {
|
|
39292
39914
|
"$ref": "#/components/responses/not_found"
|
|
39293
39915
|
},
|
|
39916
|
+
"409": {
|
|
39917
|
+
"$ref": "#/components/responses/conflict"
|
|
39918
|
+
},
|
|
39294
39919
|
"422": {
|
|
39295
39920
|
"$ref": "#/components/responses/validation_failed"
|
|
39296
39921
|
}
|
|
@@ -39445,6 +40070,9 @@
|
|
|
39445
40070
|
"404": {
|
|
39446
40071
|
"$ref": "#/components/responses/not_found"
|
|
39447
40072
|
},
|
|
40073
|
+
"409": {
|
|
40074
|
+
"$ref": "#/components/responses/conflict"
|
|
40075
|
+
},
|
|
39448
40076
|
"422": {
|
|
39449
40077
|
"$ref": "#/components/responses/validation_failed"
|
|
39450
40078
|
}
|
|
@@ -39499,6 +40127,9 @@
|
|
|
39499
40127
|
},
|
|
39500
40128
|
"404": {
|
|
39501
40129
|
"$ref": "#/components/responses/not_found"
|
|
40130
|
+
},
|
|
40131
|
+
"409": {
|
|
40132
|
+
"$ref": "#/components/responses/conflict"
|
|
39502
40133
|
}
|
|
39503
40134
|
},
|
|
39504
40135
|
"x-github": {
|
|
@@ -39530,7 +40161,7 @@
|
|
|
39530
40161
|
"$ref": "#/components/parameters/repo"
|
|
39531
40162
|
},
|
|
39532
40163
|
{
|
|
39533
|
-
"$ref": "#/components/parameters/
|
|
40164
|
+
"$ref": "#/components/parameters/git-ref-only"
|
|
39534
40165
|
}
|
|
39535
40166
|
],
|
|
39536
40167
|
"responses": {
|
|
@@ -39556,6 +40187,9 @@
|
|
|
39556
40187
|
"$ref": "#/components/headers/link"
|
|
39557
40188
|
}
|
|
39558
40189
|
}
|
|
40190
|
+
},
|
|
40191
|
+
"409": {
|
|
40192
|
+
"$ref": "#/components/responses/conflict"
|
|
39559
40193
|
}
|
|
39560
40194
|
},
|
|
39561
40195
|
"x-github": {
|
|
@@ -39587,7 +40221,7 @@
|
|
|
39587
40221
|
"$ref": "#/components/parameters/repo"
|
|
39588
40222
|
},
|
|
39589
40223
|
{
|
|
39590
|
-
"$ref": "#/components/parameters/
|
|
40224
|
+
"$ref": "#/components/parameters/git-ref-only"
|
|
39591
40225
|
}
|
|
39592
40226
|
],
|
|
39593
40227
|
"responses": {
|
|
@@ -39608,6 +40242,9 @@
|
|
|
39608
40242
|
},
|
|
39609
40243
|
"404": {
|
|
39610
40244
|
"$ref": "#/components/responses/not_found"
|
|
40245
|
+
},
|
|
40246
|
+
"409": {
|
|
40247
|
+
"$ref": "#/components/responses/conflict"
|
|
39611
40248
|
}
|
|
39612
40249
|
},
|
|
39613
40250
|
"x-github": {
|
|
@@ -39695,6 +40332,9 @@
|
|
|
39695
40332
|
}
|
|
39696
40333
|
}
|
|
39697
40334
|
},
|
|
40335
|
+
"409": {
|
|
40336
|
+
"$ref": "#/components/responses/conflict"
|
|
40337
|
+
},
|
|
39698
40338
|
"422": {
|
|
39699
40339
|
"$ref": "#/components/responses/validation_failed"
|
|
39700
40340
|
}
|
|
@@ -39711,7 +40351,7 @@
|
|
|
39711
40351
|
"/repos/{owner}/{repo}/git/refs/{ref}": {
|
|
39712
40352
|
"patch": {
|
|
39713
40353
|
"summary": "Update a reference",
|
|
39714
|
-
"description": "",
|
|
40354
|
+
"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.",
|
|
39715
40355
|
"tags": [
|
|
39716
40356
|
"git"
|
|
39717
40357
|
],
|
|
@@ -39728,15 +40368,7 @@
|
|
|
39728
40368
|
"$ref": "#/components/parameters/repo"
|
|
39729
40369
|
},
|
|
39730
40370
|
{
|
|
39731
|
-
"
|
|
39732
|
-
"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.",
|
|
39733
|
-
"in": "path",
|
|
39734
|
-
"required": true,
|
|
39735
|
-
"example": "heads/featureA",
|
|
39736
|
-
"schema": {
|
|
39737
|
-
"type": "string"
|
|
39738
|
-
},
|
|
39739
|
-
"x-multi-segment": true
|
|
40371
|
+
"$ref": "#/components/parameters/git-ref-only"
|
|
39740
40372
|
}
|
|
39741
40373
|
],
|
|
39742
40374
|
"requestBody": {
|
|
@@ -39787,6 +40419,9 @@
|
|
|
39787
40419
|
}
|
|
39788
40420
|
}
|
|
39789
40421
|
},
|
|
40422
|
+
"409": {
|
|
40423
|
+
"$ref": "#/components/responses/conflict"
|
|
40424
|
+
},
|
|
39790
40425
|
"422": {
|
|
39791
40426
|
"$ref": "#/components/responses/validation_failed"
|
|
39792
40427
|
}
|
|
@@ -39801,7 +40436,7 @@
|
|
|
39801
40436
|
},
|
|
39802
40437
|
"delete": {
|
|
39803
40438
|
"summary": "Delete a reference",
|
|
39804
|
-
"description": "",
|
|
40439
|
+
"description": "Deletes the provided reference.",
|
|
39805
40440
|
"tags": [
|
|
39806
40441
|
"git"
|
|
39807
40442
|
],
|
|
@@ -39818,13 +40453,16 @@
|
|
|
39818
40453
|
"$ref": "#/components/parameters/repo"
|
|
39819
40454
|
},
|
|
39820
40455
|
{
|
|
39821
|
-
"$ref": "#/components/parameters/
|
|
40456
|
+
"$ref": "#/components/parameters/git-ref-only"
|
|
39822
40457
|
}
|
|
39823
40458
|
],
|
|
39824
40459
|
"responses": {
|
|
39825
40460
|
"204": {
|
|
39826
40461
|
"description": "Response"
|
|
39827
40462
|
},
|
|
40463
|
+
"409": {
|
|
40464
|
+
"$ref": "#/components/responses/conflict"
|
|
40465
|
+
},
|
|
39828
40466
|
"422": {
|
|
39829
40467
|
"$ref": "#/components/responses/validation_failed"
|
|
39830
40468
|
}
|
|
@@ -39959,6 +40597,9 @@
|
|
|
39959
40597
|
}
|
|
39960
40598
|
}
|
|
39961
40599
|
},
|
|
40600
|
+
"409": {
|
|
40601
|
+
"$ref": "#/components/responses/conflict"
|
|
40602
|
+
},
|
|
39962
40603
|
"422": {
|
|
39963
40604
|
"$ref": "#/components/responses/validation_failed"
|
|
39964
40605
|
}
|
|
@@ -40018,6 +40659,9 @@
|
|
|
40018
40659
|
},
|
|
40019
40660
|
"404": {
|
|
40020
40661
|
"$ref": "#/components/responses/not_found"
|
|
40662
|
+
},
|
|
40663
|
+
"409": {
|
|
40664
|
+
"$ref": "#/components/responses/conflict"
|
|
40021
40665
|
}
|
|
40022
40666
|
},
|
|
40023
40667
|
"x-github": {
|
|
@@ -40155,6 +40799,9 @@
|
|
|
40155
40799
|
"404": {
|
|
40156
40800
|
"$ref": "#/components/responses/not_found"
|
|
40157
40801
|
},
|
|
40802
|
+
"409": {
|
|
40803
|
+
"$ref": "#/components/responses/conflict"
|
|
40804
|
+
},
|
|
40158
40805
|
"422": {
|
|
40159
40806
|
"$ref": "#/components/responses/validation_failed"
|
|
40160
40807
|
}
|
|
@@ -40229,6 +40876,9 @@
|
|
|
40229
40876
|
"404": {
|
|
40230
40877
|
"$ref": "#/components/responses/not_found"
|
|
40231
40878
|
},
|
|
40879
|
+
"409": {
|
|
40880
|
+
"$ref": "#/components/responses/conflict"
|
|
40881
|
+
},
|
|
40232
40882
|
"422": {
|
|
40233
40883
|
"$ref": "#/components/responses/validation_failed"
|
|
40234
40884
|
}
|
|
@@ -52092,587 +52742,7 @@
|
|
|
52092
52742
|
"x-octokit": {}
|
|
52093
52743
|
}
|
|
52094
52744
|
},
|
|
52095
|
-
"/
|
|
52096
|
-
"get": {
|
|
52097
|
-
"summary": "List environment secrets",
|
|
52098
|
-
"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.",
|
|
52099
|
-
"tags": [
|
|
52100
|
-
"actions"
|
|
52101
|
-
],
|
|
52102
|
-
"operationId": "actions/list-environment-secrets",
|
|
52103
|
-
"externalDocs": {
|
|
52104
|
-
"description": "API method documentation",
|
|
52105
|
-
"url": "https://docs.github.com/enterprise-server@3.10/rest/actions/secrets#list-environment-secrets"
|
|
52106
|
-
},
|
|
52107
|
-
"parameters": [
|
|
52108
|
-
{
|
|
52109
|
-
"$ref": "#/components/parameters/repository-id"
|
|
52110
|
-
},
|
|
52111
|
-
{
|
|
52112
|
-
"$ref": "#/components/parameters/environment-name"
|
|
52113
|
-
},
|
|
52114
|
-
{
|
|
52115
|
-
"$ref": "#/components/parameters/per-page"
|
|
52116
|
-
},
|
|
52117
|
-
{
|
|
52118
|
-
"$ref": "#/components/parameters/page"
|
|
52119
|
-
}
|
|
52120
|
-
],
|
|
52121
|
-
"responses": {
|
|
52122
|
-
"200": {
|
|
52123
|
-
"description": "Response",
|
|
52124
|
-
"content": {
|
|
52125
|
-
"application/json": {
|
|
52126
|
-
"schema": {
|
|
52127
|
-
"type": "object",
|
|
52128
|
-
"required": [
|
|
52129
|
-
"total_count",
|
|
52130
|
-
"secrets"
|
|
52131
|
-
],
|
|
52132
|
-
"properties": {
|
|
52133
|
-
"total_count": {
|
|
52134
|
-
"type": "integer"
|
|
52135
|
-
},
|
|
52136
|
-
"secrets": {
|
|
52137
|
-
"type": "array",
|
|
52138
|
-
"items": {
|
|
52139
|
-
"$ref": "#/components/schemas/actions-secret"
|
|
52140
|
-
}
|
|
52141
|
-
}
|
|
52142
|
-
}
|
|
52143
|
-
},
|
|
52144
|
-
"examples": {
|
|
52145
|
-
"default": {
|
|
52146
|
-
"$ref": "#/components/examples/actions-secret-paginated"
|
|
52147
|
-
}
|
|
52148
|
-
}
|
|
52149
|
-
}
|
|
52150
|
-
},
|
|
52151
|
-
"headers": {
|
|
52152
|
-
"Link": {
|
|
52153
|
-
"$ref": "#/components/headers/link"
|
|
52154
|
-
}
|
|
52155
|
-
}
|
|
52156
|
-
}
|
|
52157
|
-
},
|
|
52158
|
-
"x-github": {
|
|
52159
|
-
"githubCloudOnly": false,
|
|
52160
|
-
"enabledForGitHubApps": true,
|
|
52161
|
-
"category": "actions",
|
|
52162
|
-
"subcategory": "secrets"
|
|
52163
|
-
},
|
|
52164
|
-
"x-octokit": {}
|
|
52165
|
-
}
|
|
52166
|
-
},
|
|
52167
|
-
"/repositories/{repository_id}/environments/{environment_name}/secrets/public-key": {
|
|
52168
|
-
"get": {
|
|
52169
|
-
"summary": "Get an environment public key",
|
|
52170
|
-
"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.",
|
|
52171
|
-
"tags": [
|
|
52172
|
-
"actions"
|
|
52173
|
-
],
|
|
52174
|
-
"operationId": "actions/get-environment-public-key",
|
|
52175
|
-
"externalDocs": {
|
|
52176
|
-
"description": "API method documentation",
|
|
52177
|
-
"url": "https://docs.github.com/enterprise-server@3.10/rest/actions/secrets#get-an-environment-public-key"
|
|
52178
|
-
},
|
|
52179
|
-
"parameters": [
|
|
52180
|
-
{
|
|
52181
|
-
"$ref": "#/components/parameters/repository-id"
|
|
52182
|
-
},
|
|
52183
|
-
{
|
|
52184
|
-
"$ref": "#/components/parameters/environment-name"
|
|
52185
|
-
}
|
|
52186
|
-
],
|
|
52187
|
-
"responses": {
|
|
52188
|
-
"200": {
|
|
52189
|
-
"description": "Response",
|
|
52190
|
-
"content": {
|
|
52191
|
-
"application/json": {
|
|
52192
|
-
"schema": {
|
|
52193
|
-
"$ref": "#/components/schemas/actions-public-key"
|
|
52194
|
-
},
|
|
52195
|
-
"examples": {
|
|
52196
|
-
"default": {
|
|
52197
|
-
"$ref": "#/components/examples/actions-public-key"
|
|
52198
|
-
}
|
|
52199
|
-
}
|
|
52200
|
-
}
|
|
52201
|
-
}
|
|
52202
|
-
}
|
|
52203
|
-
},
|
|
52204
|
-
"x-github": {
|
|
52205
|
-
"githubCloudOnly": false,
|
|
52206
|
-
"enabledForGitHubApps": true,
|
|
52207
|
-
"category": "actions",
|
|
52208
|
-
"subcategory": "secrets"
|
|
52209
|
-
},
|
|
52210
|
-
"x-octokit": {}
|
|
52211
|
-
}
|
|
52212
|
-
},
|
|
52213
|
-
"/repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}": {
|
|
52214
|
-
"get": {
|
|
52215
|
-
"summary": "Get an environment secret",
|
|
52216
|
-
"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.",
|
|
52217
|
-
"tags": [
|
|
52218
|
-
"actions"
|
|
52219
|
-
],
|
|
52220
|
-
"operationId": "actions/get-environment-secret",
|
|
52221
|
-
"externalDocs": {
|
|
52222
|
-
"description": "API method documentation",
|
|
52223
|
-
"url": "https://docs.github.com/enterprise-server@3.10/rest/actions/secrets#get-an-environment-secret"
|
|
52224
|
-
},
|
|
52225
|
-
"parameters": [
|
|
52226
|
-
{
|
|
52227
|
-
"$ref": "#/components/parameters/repository-id"
|
|
52228
|
-
},
|
|
52229
|
-
{
|
|
52230
|
-
"$ref": "#/components/parameters/environment-name"
|
|
52231
|
-
},
|
|
52232
|
-
{
|
|
52233
|
-
"$ref": "#/components/parameters/secret-name"
|
|
52234
|
-
}
|
|
52235
|
-
],
|
|
52236
|
-
"responses": {
|
|
52237
|
-
"200": {
|
|
52238
|
-
"description": "Response",
|
|
52239
|
-
"content": {
|
|
52240
|
-
"application/json": {
|
|
52241
|
-
"schema": {
|
|
52242
|
-
"$ref": "#/components/schemas/actions-secret"
|
|
52243
|
-
},
|
|
52244
|
-
"examples": {
|
|
52245
|
-
"default": {
|
|
52246
|
-
"$ref": "#/components/examples/actions-secret"
|
|
52247
|
-
}
|
|
52248
|
-
}
|
|
52249
|
-
}
|
|
52250
|
-
}
|
|
52251
|
-
}
|
|
52252
|
-
},
|
|
52253
|
-
"x-github": {
|
|
52254
|
-
"githubCloudOnly": false,
|
|
52255
|
-
"enabledForGitHubApps": true,
|
|
52256
|
-
"category": "actions",
|
|
52257
|
-
"subcategory": "secrets"
|
|
52258
|
-
},
|
|
52259
|
-
"x-octokit": {}
|
|
52260
|
-
},
|
|
52261
|
-
"put": {
|
|
52262
|
-
"summary": "Create or update an environment secret",
|
|
52263
|
-
"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-server@3.10/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.",
|
|
52264
|
-
"tags": [
|
|
52265
|
-
"actions"
|
|
52266
|
-
],
|
|
52267
|
-
"operationId": "actions/create-or-update-environment-secret",
|
|
52268
|
-
"externalDocs": {
|
|
52269
|
-
"description": "API method documentation",
|
|
52270
|
-
"url": "https://docs.github.com/enterprise-server@3.10/rest/actions/secrets#create-or-update-an-environment-secret"
|
|
52271
|
-
},
|
|
52272
|
-
"parameters": [
|
|
52273
|
-
{
|
|
52274
|
-
"$ref": "#/components/parameters/repository-id"
|
|
52275
|
-
},
|
|
52276
|
-
{
|
|
52277
|
-
"$ref": "#/components/parameters/environment-name"
|
|
52278
|
-
},
|
|
52279
|
-
{
|
|
52280
|
-
"$ref": "#/components/parameters/secret-name"
|
|
52281
|
-
}
|
|
52282
|
-
],
|
|
52283
|
-
"requestBody": {
|
|
52284
|
-
"required": true,
|
|
52285
|
-
"content": {
|
|
52286
|
-
"application/json": {
|
|
52287
|
-
"schema": {
|
|
52288
|
-
"type": "object",
|
|
52289
|
-
"properties": {
|
|
52290
|
-
"encrypted_value": {
|
|
52291
|
-
"type": "string",
|
|
52292
|
-
"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-server@3.10/rest/actions/secrets#get-an-environment-public-key) endpoint.",
|
|
52293
|
-
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$"
|
|
52294
|
-
},
|
|
52295
|
-
"key_id": {
|
|
52296
|
-
"type": "string",
|
|
52297
|
-
"description": "ID of the key you used to encrypt the secret."
|
|
52298
|
-
}
|
|
52299
|
-
},
|
|
52300
|
-
"required": [
|
|
52301
|
-
"encrypted_value",
|
|
52302
|
-
"key_id"
|
|
52303
|
-
]
|
|
52304
|
-
},
|
|
52305
|
-
"examples": {
|
|
52306
|
-
"default": {
|
|
52307
|
-
"value": {
|
|
52308
|
-
"encrypted_value": "c2VjcmV0",
|
|
52309
|
-
"key_id": "012345678912345678"
|
|
52310
|
-
}
|
|
52311
|
-
}
|
|
52312
|
-
}
|
|
52313
|
-
}
|
|
52314
|
-
}
|
|
52315
|
-
},
|
|
52316
|
-
"responses": {
|
|
52317
|
-
"201": {
|
|
52318
|
-
"description": "Response when creating a secret",
|
|
52319
|
-
"content": {
|
|
52320
|
-
"application/json": {
|
|
52321
|
-
"schema": {
|
|
52322
|
-
"$ref": "#/components/schemas/empty-object"
|
|
52323
|
-
},
|
|
52324
|
-
"examples": {
|
|
52325
|
-
"default": {
|
|
52326
|
-
"value": null
|
|
52327
|
-
}
|
|
52328
|
-
}
|
|
52329
|
-
}
|
|
52330
|
-
}
|
|
52331
|
-
},
|
|
52332
|
-
"204": {
|
|
52333
|
-
"description": "Response when updating a secret"
|
|
52334
|
-
}
|
|
52335
|
-
},
|
|
52336
|
-
"x-github": {
|
|
52337
|
-
"githubCloudOnly": false,
|
|
52338
|
-
"enabledForGitHubApps": true,
|
|
52339
|
-
"category": "actions",
|
|
52340
|
-
"subcategory": "secrets"
|
|
52341
|
-
},
|
|
52342
|
-
"x-octokit": {}
|
|
52343
|
-
},
|
|
52344
|
-
"delete": {
|
|
52345
|
-
"summary": "Delete an environment secret",
|
|
52346
|
-
"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.",
|
|
52347
|
-
"tags": [
|
|
52348
|
-
"actions"
|
|
52349
|
-
],
|
|
52350
|
-
"operationId": "actions/delete-environment-secret",
|
|
52351
|
-
"externalDocs": {
|
|
52352
|
-
"description": "API method documentation",
|
|
52353
|
-
"url": "https://docs.github.com/enterprise-server@3.10/rest/actions/secrets#delete-an-environment-secret"
|
|
52354
|
-
},
|
|
52355
|
-
"parameters": [
|
|
52356
|
-
{
|
|
52357
|
-
"$ref": "#/components/parameters/repository-id"
|
|
52358
|
-
},
|
|
52359
|
-
{
|
|
52360
|
-
"$ref": "#/components/parameters/environment-name"
|
|
52361
|
-
},
|
|
52362
|
-
{
|
|
52363
|
-
"$ref": "#/components/parameters/secret-name"
|
|
52364
|
-
}
|
|
52365
|
-
],
|
|
52366
|
-
"responses": {
|
|
52367
|
-
"204": {
|
|
52368
|
-
"description": "Default response"
|
|
52369
|
-
}
|
|
52370
|
-
},
|
|
52371
|
-
"x-github": {
|
|
52372
|
-
"githubCloudOnly": false,
|
|
52373
|
-
"enabledForGitHubApps": true,
|
|
52374
|
-
"category": "actions",
|
|
52375
|
-
"subcategory": "secrets"
|
|
52376
|
-
},
|
|
52377
|
-
"x-octokit": {}
|
|
52378
|
-
}
|
|
52379
|
-
},
|
|
52380
|
-
"/repositories/{repository_id}/environments/{environment_name}/variables": {
|
|
52381
|
-
"get": {
|
|
52382
|
-
"summary": "List environment variables",
|
|
52383
|
-
"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.",
|
|
52384
|
-
"tags": [
|
|
52385
|
-
"actions"
|
|
52386
|
-
],
|
|
52387
|
-
"operationId": "actions/list-environment-variables",
|
|
52388
|
-
"externalDocs": {
|
|
52389
|
-
"description": "API method documentation",
|
|
52390
|
-
"url": "https://docs.github.com/enterprise-server@3.10/rest/actions/variables#list-environment-variables"
|
|
52391
|
-
},
|
|
52392
|
-
"parameters": [
|
|
52393
|
-
{
|
|
52394
|
-
"$ref": "#/components/parameters/repository-id"
|
|
52395
|
-
},
|
|
52396
|
-
{
|
|
52397
|
-
"$ref": "#/components/parameters/environment-name"
|
|
52398
|
-
},
|
|
52399
|
-
{
|
|
52400
|
-
"$ref": "#/components/parameters/variables-per-page"
|
|
52401
|
-
},
|
|
52402
|
-
{
|
|
52403
|
-
"$ref": "#/components/parameters/page"
|
|
52404
|
-
}
|
|
52405
|
-
],
|
|
52406
|
-
"responses": {
|
|
52407
|
-
"200": {
|
|
52408
|
-
"description": "Response",
|
|
52409
|
-
"content": {
|
|
52410
|
-
"application/json": {
|
|
52411
|
-
"schema": {
|
|
52412
|
-
"type": "object",
|
|
52413
|
-
"required": [
|
|
52414
|
-
"total_count",
|
|
52415
|
-
"variables"
|
|
52416
|
-
],
|
|
52417
|
-
"properties": {
|
|
52418
|
-
"total_count": {
|
|
52419
|
-
"type": "integer"
|
|
52420
|
-
},
|
|
52421
|
-
"variables": {
|
|
52422
|
-
"type": "array",
|
|
52423
|
-
"items": {
|
|
52424
|
-
"$ref": "#/components/schemas/actions-variable"
|
|
52425
|
-
}
|
|
52426
|
-
}
|
|
52427
|
-
}
|
|
52428
|
-
},
|
|
52429
|
-
"examples": {
|
|
52430
|
-
"default": {
|
|
52431
|
-
"$ref": "#/components/examples/actions-variables-paginated"
|
|
52432
|
-
}
|
|
52433
|
-
}
|
|
52434
|
-
}
|
|
52435
|
-
},
|
|
52436
|
-
"headers": {
|
|
52437
|
-
"Link": {
|
|
52438
|
-
"$ref": "#/components/headers/link"
|
|
52439
|
-
}
|
|
52440
|
-
}
|
|
52441
|
-
}
|
|
52442
|
-
},
|
|
52443
|
-
"x-github": {
|
|
52444
|
-
"githubCloudOnly": false,
|
|
52445
|
-
"enabledForGitHubApps": true,
|
|
52446
|
-
"category": "actions",
|
|
52447
|
-
"subcategory": "variables"
|
|
52448
|
-
},
|
|
52449
|
-
"x-octokit": {}
|
|
52450
|
-
},
|
|
52451
|
-
"post": {
|
|
52452
|
-
"summary": "Create an environment variable",
|
|
52453
|
-
"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.",
|
|
52454
|
-
"tags": [
|
|
52455
|
-
"actions"
|
|
52456
|
-
],
|
|
52457
|
-
"operationId": "actions/create-environment-variable",
|
|
52458
|
-
"externalDocs": {
|
|
52459
|
-
"description": "API method documentation",
|
|
52460
|
-
"url": "https://docs.github.com/enterprise-server@3.10/rest/actions/variables#create-an-environment-variable"
|
|
52461
|
-
},
|
|
52462
|
-
"parameters": [
|
|
52463
|
-
{
|
|
52464
|
-
"$ref": "#/components/parameters/repository-id"
|
|
52465
|
-
},
|
|
52466
|
-
{
|
|
52467
|
-
"$ref": "#/components/parameters/environment-name"
|
|
52468
|
-
}
|
|
52469
|
-
],
|
|
52470
|
-
"requestBody": {
|
|
52471
|
-
"required": true,
|
|
52472
|
-
"content": {
|
|
52473
|
-
"application/json": {
|
|
52474
|
-
"schema": {
|
|
52475
|
-
"type": "object",
|
|
52476
|
-
"properties": {
|
|
52477
|
-
"name": {
|
|
52478
|
-
"type": "string",
|
|
52479
|
-
"description": "The name of the variable."
|
|
52480
|
-
},
|
|
52481
|
-
"value": {
|
|
52482
|
-
"type": "string",
|
|
52483
|
-
"description": "The value of the variable."
|
|
52484
|
-
}
|
|
52485
|
-
},
|
|
52486
|
-
"required": [
|
|
52487
|
-
"name",
|
|
52488
|
-
"value"
|
|
52489
|
-
]
|
|
52490
|
-
},
|
|
52491
|
-
"examples": {
|
|
52492
|
-
"default": {
|
|
52493
|
-
"value": {
|
|
52494
|
-
"name": "USERNAME",
|
|
52495
|
-
"value": "octocat"
|
|
52496
|
-
}
|
|
52497
|
-
}
|
|
52498
|
-
}
|
|
52499
|
-
}
|
|
52500
|
-
}
|
|
52501
|
-
},
|
|
52502
|
-
"responses": {
|
|
52503
|
-
"201": {
|
|
52504
|
-
"description": "Response",
|
|
52505
|
-
"content": {
|
|
52506
|
-
"application/json": {
|
|
52507
|
-
"schema": {
|
|
52508
|
-
"$ref": "#/components/schemas/empty-object"
|
|
52509
|
-
},
|
|
52510
|
-
"examples": {
|
|
52511
|
-
"default": {
|
|
52512
|
-
"value": null
|
|
52513
|
-
}
|
|
52514
|
-
}
|
|
52515
|
-
}
|
|
52516
|
-
}
|
|
52517
|
-
}
|
|
52518
|
-
},
|
|
52519
|
-
"x-github": {
|
|
52520
|
-
"githubCloudOnly": false,
|
|
52521
|
-
"enabledForGitHubApps": true,
|
|
52522
|
-
"category": "actions",
|
|
52523
|
-
"subcategory": "variables"
|
|
52524
|
-
},
|
|
52525
|
-
"x-octokit": {}
|
|
52526
|
-
}
|
|
52527
|
-
},
|
|
52528
|
-
"/repositories/{repository_id}/environments/{environment_name}/variables/{name}": {
|
|
52529
|
-
"get": {
|
|
52530
|
-
"summary": "Get an environment variable",
|
|
52531
|
-
"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.",
|
|
52532
|
-
"tags": [
|
|
52533
|
-
"actions"
|
|
52534
|
-
],
|
|
52535
|
-
"operationId": "actions/get-environment-variable",
|
|
52536
|
-
"externalDocs": {
|
|
52537
|
-
"description": "API method documentation",
|
|
52538
|
-
"url": "https://docs.github.com/enterprise-server@3.10/rest/actions/variables#get-an-environment-variable"
|
|
52539
|
-
},
|
|
52540
|
-
"parameters": [
|
|
52541
|
-
{
|
|
52542
|
-
"$ref": "#/components/parameters/repository-id"
|
|
52543
|
-
},
|
|
52544
|
-
{
|
|
52545
|
-
"$ref": "#/components/parameters/environment-name"
|
|
52546
|
-
},
|
|
52547
|
-
{
|
|
52548
|
-
"$ref": "#/components/parameters/variable-name"
|
|
52549
|
-
}
|
|
52550
|
-
],
|
|
52551
|
-
"responses": {
|
|
52552
|
-
"200": {
|
|
52553
|
-
"description": "Response",
|
|
52554
|
-
"content": {
|
|
52555
|
-
"application/json": {
|
|
52556
|
-
"schema": {
|
|
52557
|
-
"$ref": "#/components/schemas/actions-variable"
|
|
52558
|
-
},
|
|
52559
|
-
"examples": {
|
|
52560
|
-
"default": {
|
|
52561
|
-
"$ref": "#/components/examples/actions-variable"
|
|
52562
|
-
}
|
|
52563
|
-
}
|
|
52564
|
-
}
|
|
52565
|
-
}
|
|
52566
|
-
}
|
|
52567
|
-
},
|
|
52568
|
-
"x-github": {
|
|
52569
|
-
"githubCloudOnly": false,
|
|
52570
|
-
"enabledForGitHubApps": true,
|
|
52571
|
-
"category": "actions",
|
|
52572
|
-
"subcategory": "variables"
|
|
52573
|
-
},
|
|
52574
|
-
"x-octokit": {}
|
|
52575
|
-
},
|
|
52576
|
-
"patch": {
|
|
52577
|
-
"summary": "Update an environment variable",
|
|
52578
|
-
"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.",
|
|
52579
|
-
"tags": [
|
|
52580
|
-
"actions"
|
|
52581
|
-
],
|
|
52582
|
-
"operationId": "actions/update-environment-variable",
|
|
52583
|
-
"externalDocs": {
|
|
52584
|
-
"description": "API method documentation",
|
|
52585
|
-
"url": "https://docs.github.com/enterprise-server@3.10/rest/actions/variables#update-an-environment-variable"
|
|
52586
|
-
},
|
|
52587
|
-
"parameters": [
|
|
52588
|
-
{
|
|
52589
|
-
"$ref": "#/components/parameters/repository-id"
|
|
52590
|
-
},
|
|
52591
|
-
{
|
|
52592
|
-
"$ref": "#/components/parameters/variable-name"
|
|
52593
|
-
},
|
|
52594
|
-
{
|
|
52595
|
-
"$ref": "#/components/parameters/environment-name"
|
|
52596
|
-
}
|
|
52597
|
-
],
|
|
52598
|
-
"requestBody": {
|
|
52599
|
-
"required": true,
|
|
52600
|
-
"content": {
|
|
52601
|
-
"application/json": {
|
|
52602
|
-
"schema": {
|
|
52603
|
-
"type": "object",
|
|
52604
|
-
"properties": {
|
|
52605
|
-
"name": {
|
|
52606
|
-
"type": "string",
|
|
52607
|
-
"description": "The name of the variable."
|
|
52608
|
-
},
|
|
52609
|
-
"value": {
|
|
52610
|
-
"type": "string",
|
|
52611
|
-
"description": "The value of the variable."
|
|
52612
|
-
}
|
|
52613
|
-
}
|
|
52614
|
-
},
|
|
52615
|
-
"examples": {
|
|
52616
|
-
"default": {
|
|
52617
|
-
"value": {
|
|
52618
|
-
"name": "USERNAME",
|
|
52619
|
-
"value": "octocat"
|
|
52620
|
-
}
|
|
52621
|
-
}
|
|
52622
|
-
}
|
|
52623
|
-
}
|
|
52624
|
-
}
|
|
52625
|
-
},
|
|
52626
|
-
"responses": {
|
|
52627
|
-
"204": {
|
|
52628
|
-
"description": "Response"
|
|
52629
|
-
}
|
|
52630
|
-
},
|
|
52631
|
-
"x-github": {
|
|
52632
|
-
"githubCloudOnly": false,
|
|
52633
|
-
"enabledForGitHubApps": true,
|
|
52634
|
-
"category": "actions",
|
|
52635
|
-
"subcategory": "variables"
|
|
52636
|
-
},
|
|
52637
|
-
"x-octokit": {}
|
|
52638
|
-
},
|
|
52639
|
-
"delete": {
|
|
52640
|
-
"summary": "Delete an environment variable",
|
|
52641
|
-
"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.",
|
|
52642
|
-
"tags": [
|
|
52643
|
-
"actions"
|
|
52644
|
-
],
|
|
52645
|
-
"operationId": "actions/delete-environment-variable",
|
|
52646
|
-
"externalDocs": {
|
|
52647
|
-
"description": "API method documentation",
|
|
52648
|
-
"url": "https://docs.github.com/enterprise-server@3.10/rest/actions/variables#delete-an-environment-variable"
|
|
52649
|
-
},
|
|
52650
|
-
"parameters": [
|
|
52651
|
-
{
|
|
52652
|
-
"$ref": "#/components/parameters/repository-id"
|
|
52653
|
-
},
|
|
52654
|
-
{
|
|
52655
|
-
"$ref": "#/components/parameters/variable-name"
|
|
52656
|
-
},
|
|
52657
|
-
{
|
|
52658
|
-
"$ref": "#/components/parameters/environment-name"
|
|
52659
|
-
}
|
|
52660
|
-
],
|
|
52661
|
-
"responses": {
|
|
52662
|
-
"204": {
|
|
52663
|
-
"description": "Response"
|
|
52664
|
-
}
|
|
52665
|
-
},
|
|
52666
|
-
"x-github": {
|
|
52667
|
-
"githubCloudOnly": false,
|
|
52668
|
-
"enabledForGitHubApps": true,
|
|
52669
|
-
"category": "actions",
|
|
52670
|
-
"subcategory": "variables"
|
|
52671
|
-
},
|
|
52672
|
-
"x-octokit": {}
|
|
52673
|
-
}
|
|
52674
|
-
},
|
|
52675
|
-
"/scim/v2/Groups": {
|
|
52745
|
+
"/scim/v2/enterprises/{enterprise}/Groups": {
|
|
52676
52746
|
"get": {
|
|
52677
52747
|
"summary": "List provisioned SCIM groups for an enterprise",
|
|
52678
52748
|
"description": "**Note:** The SCIM API endpoints for enterprise accounts are currently 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.",
|
|
@@ -52711,6 +52781,9 @@
|
|
|
52711
52781
|
},
|
|
52712
52782
|
{
|
|
52713
52783
|
"$ref": "#/components/parameters/count"
|
|
52784
|
+
},
|
|
52785
|
+
{
|
|
52786
|
+
"$ref": "#/components/parameters/enterprise"
|
|
52714
52787
|
}
|
|
52715
52788
|
],
|
|
52716
52789
|
"responses": {
|
|
@@ -52764,6 +52837,11 @@
|
|
|
52764
52837
|
"description": "API method documentation",
|
|
52765
52838
|
"url": "https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/scim#provision-a-scim-enterprise-group"
|
|
52766
52839
|
},
|
|
52840
|
+
"parameters": [
|
|
52841
|
+
{
|
|
52842
|
+
"$ref": "#/components/parameters/enterprise"
|
|
52843
|
+
}
|
|
52844
|
+
],
|
|
52767
52845
|
"requestBody": {
|
|
52768
52846
|
"required": true,
|
|
52769
52847
|
"content": {
|
|
@@ -52829,7 +52907,7 @@
|
|
|
52829
52907
|
"x-octokit": {}
|
|
52830
52908
|
}
|
|
52831
52909
|
},
|
|
52832
|
-
"/scim/v2/Groups/{scim_group_id}": {
|
|
52910
|
+
"/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}": {
|
|
52833
52911
|
"get": {
|
|
52834
52912
|
"summary": "Get SCIM provisioning information for an enterprise group",
|
|
52835
52913
|
"description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nGets information about a SCIM group.",
|
|
@@ -52847,6 +52925,9 @@
|
|
|
52847
52925
|
},
|
|
52848
52926
|
{
|
|
52849
52927
|
"$ref": "#/components/parameters/excluded-attributes"
|
|
52928
|
+
},
|
|
52929
|
+
{
|
|
52930
|
+
"$ref": "#/components/parameters/enterprise"
|
|
52850
52931
|
}
|
|
52851
52932
|
],
|
|
52852
52933
|
"responses": {
|
|
@@ -52906,6 +52987,9 @@
|
|
|
52906
52987
|
"parameters": [
|
|
52907
52988
|
{
|
|
52908
52989
|
"$ref": "#/components/parameters/scim-group-id"
|
|
52990
|
+
},
|
|
52991
|
+
{
|
|
52992
|
+
"$ref": "#/components/parameters/enterprise"
|
|
52909
52993
|
}
|
|
52910
52994
|
],
|
|
52911
52995
|
"requestBody": {
|
|
@@ -53013,6 +53097,9 @@
|
|
|
53013
53097
|
"parameters": [
|
|
53014
53098
|
{
|
|
53015
53099
|
"$ref": "#/components/parameters/scim-group-id"
|
|
53100
|
+
},
|
|
53101
|
+
{
|
|
53102
|
+
"$ref": "#/components/parameters/enterprise"
|
|
53016
53103
|
}
|
|
53017
53104
|
],
|
|
53018
53105
|
"requestBody": {
|
|
@@ -53130,6 +53217,9 @@
|
|
|
53130
53217
|
"parameters": [
|
|
53131
53218
|
{
|
|
53132
53219
|
"$ref": "#/components/parameters/scim-group-id"
|
|
53220
|
+
},
|
|
53221
|
+
{
|
|
53222
|
+
"$ref": "#/components/parameters/enterprise"
|
|
53133
53223
|
}
|
|
53134
53224
|
],
|
|
53135
53225
|
"responses": {
|
|
@@ -53164,7 +53254,7 @@
|
|
|
53164
53254
|
"x-octokit": {}
|
|
53165
53255
|
}
|
|
53166
53256
|
},
|
|
53167
|
-
"/scim/v2/Users": {
|
|
53257
|
+
"/scim/v2/enterprises/{enterprise}/Users": {
|
|
53168
53258
|
"get": {
|
|
53169
53259
|
"summary": "List SCIM provisioned identities for an enterprise",
|
|
53170
53260
|
"description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nLists provisioned SCIM enterprise members.\n\nWhen a user with a SCIM-provisioned external identity is removed from an enterprise through a `patch` with `active` flag set to `false`, the account's metadata is preserved to allow the user to re-join the enterprise in the future. However, the user's account will be suspended and the user will not be able to sign-in. In order to permanently suspend the users account with no ability to re-join the enterprise in the future, use the `delete` request. Users that were not permanently deleted will be visible in the returned results.",
|
|
@@ -53199,6 +53289,9 @@
|
|
|
53199
53289
|
},
|
|
53200
53290
|
{
|
|
53201
53291
|
"$ref": "#/components/parameters/count"
|
|
53292
|
+
},
|
|
53293
|
+
{
|
|
53294
|
+
"$ref": "#/components/parameters/enterprise"
|
|
53202
53295
|
}
|
|
53203
53296
|
],
|
|
53204
53297
|
"responses": {
|
|
@@ -53252,6 +53345,11 @@
|
|
|
53252
53345
|
"description": "API method documentation",
|
|
53253
53346
|
"url": "https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/scim#provision-a-scim-enterprise-user"
|
|
53254
53347
|
},
|
|
53348
|
+
"parameters": [
|
|
53349
|
+
{
|
|
53350
|
+
"$ref": "#/components/parameters/enterprise"
|
|
53351
|
+
}
|
|
53352
|
+
],
|
|
53255
53353
|
"requestBody": {
|
|
53256
53354
|
"required": true,
|
|
53257
53355
|
"content": {
|
|
@@ -53317,7 +53415,7 @@
|
|
|
53317
53415
|
"x-octokit": {}
|
|
53318
53416
|
}
|
|
53319
53417
|
},
|
|
53320
|
-
"/scim/v2/Users/{scim_user_id}": {
|
|
53418
|
+
"/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}": {
|
|
53321
53419
|
"get": {
|
|
53322
53420
|
"summary": "Get SCIM provisioning information for an enterprise user",
|
|
53323
53421
|
"description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nGets information about a SCIM user.",
|
|
@@ -53332,6 +53430,9 @@
|
|
|
53332
53430
|
"parameters": [
|
|
53333
53431
|
{
|
|
53334
53432
|
"$ref": "#/components/parameters/scim-user-id"
|
|
53433
|
+
},
|
|
53434
|
+
{
|
|
53435
|
+
"$ref": "#/components/parameters/enterprise"
|
|
53335
53436
|
}
|
|
53336
53437
|
],
|
|
53337
53438
|
"responses": {
|
|
@@ -53391,6 +53492,9 @@
|
|
|
53391
53492
|
"parameters": [
|
|
53392
53493
|
{
|
|
53393
53494
|
"$ref": "#/components/parameters/scim-user-id"
|
|
53495
|
+
},
|
|
53496
|
+
{
|
|
53497
|
+
"$ref": "#/components/parameters/enterprise"
|
|
53394
53498
|
}
|
|
53395
53499
|
],
|
|
53396
53500
|
"requestBody": {
|
|
@@ -53468,6 +53572,9 @@
|
|
|
53468
53572
|
"parameters": [
|
|
53469
53573
|
{
|
|
53470
53574
|
"$ref": "#/components/parameters/scim-user-id"
|
|
53575
|
+
},
|
|
53576
|
+
{
|
|
53577
|
+
"$ref": "#/components/parameters/enterprise"
|
|
53471
53578
|
}
|
|
53472
53579
|
],
|
|
53473
53580
|
"requestBody": {
|
|
@@ -53603,6 +53710,9 @@
|
|
|
53603
53710
|
"parameters": [
|
|
53604
53711
|
{
|
|
53605
53712
|
"$ref": "#/components/parameters/scim-user-id"
|
|
53713
|
+
},
|
|
53714
|
+
{
|
|
53715
|
+
"$ref": "#/components/parameters/enterprise"
|
|
53606
53716
|
}
|
|
53607
53717
|
],
|
|
53608
53718
|
"responses": {
|
|
@@ -62045,7 +62155,7 @@
|
|
|
62045
62155
|
"/users/{username}/hovercard": {
|
|
62046
62156
|
"get": {
|
|
62047
62157
|
"summary": "Get contextual information for a user",
|
|
62048
|
-
"description": "Provides hovercard information. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations.\n\
|
|
62158
|
+
"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.",
|
|
62049
62159
|
"tags": [
|
|
62050
62160
|
"users"
|
|
62051
62161
|
],
|
|
@@ -101078,7 +101188,9 @@
|
|
|
101078
101188
|
"queued",
|
|
101079
101189
|
"in_progress",
|
|
101080
101190
|
"completed",
|
|
101081
|
-
"waiting"
|
|
101191
|
+
"waiting",
|
|
101192
|
+
"requested",
|
|
101193
|
+
"pending"
|
|
101082
101194
|
]
|
|
101083
101195
|
},
|
|
101084
101196
|
"conclusion": {
|
|
@@ -103549,13 +103661,16 @@
|
|
|
103549
103661
|
"nullable": true
|
|
103550
103662
|
},
|
|
103551
103663
|
"status": {
|
|
103552
|
-
"description": "The phase of the lifecycle that the check is currently in.",
|
|
103664
|
+
"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.",
|
|
103553
103665
|
"example": "queued",
|
|
103554
103666
|
"type": "string",
|
|
103555
103667
|
"enum": [
|
|
103556
103668
|
"queued",
|
|
103557
103669
|
"in_progress",
|
|
103558
|
-
"completed"
|
|
103670
|
+
"completed",
|
|
103671
|
+
"waiting",
|
|
103672
|
+
"requested",
|
|
103673
|
+
"pending"
|
|
103559
103674
|
]
|
|
103560
103675
|
},
|
|
103561
103676
|
"conclusion": {
|
|
@@ -103833,11 +103948,15 @@
|
|
|
103833
103948
|
},
|
|
103834
103949
|
"status": {
|
|
103835
103950
|
"type": "string",
|
|
103951
|
+
"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.",
|
|
103836
103952
|
"example": "completed",
|
|
103837
103953
|
"enum": [
|
|
103838
103954
|
"queued",
|
|
103839
103955
|
"in_progress",
|
|
103840
|
-
"completed"
|
|
103956
|
+
"completed",
|
|
103957
|
+
"waiting",
|
|
103958
|
+
"requested",
|
|
103959
|
+
"pending"
|
|
103841
103960
|
],
|
|
103842
103961
|
"nullable": true
|
|
103843
103962
|
},
|
|
@@ -167827,6 +167946,7 @@
|
|
|
167827
167946
|
"type": "object",
|
|
167828
167947
|
"properties": {
|
|
167829
167948
|
"permission": {
|
|
167949
|
+
"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.",
|
|
167830
167950
|
"type": "object",
|
|
167831
167951
|
"properties": {
|
|
167832
167952
|
"to": {
|
|
@@ -167841,6 +167961,18 @@
|
|
|
167841
167961
|
"required": [
|
|
167842
167962
|
"to"
|
|
167843
167963
|
]
|
|
167964
|
+
},
|
|
167965
|
+
"role_name": {
|
|
167966
|
+
"description": "The role assigned to the collaborator.",
|
|
167967
|
+
"type": "object",
|
|
167968
|
+
"properties": {
|
|
167969
|
+
"to": {
|
|
167970
|
+
"type": "string"
|
|
167971
|
+
}
|
|
167972
|
+
},
|
|
167973
|
+
"required": [
|
|
167974
|
+
"to"
|
|
167975
|
+
]
|
|
167844
167976
|
}
|
|
167845
167977
|
}
|
|
167846
167978
|
},
|
|
@@ -246387,7 +246519,7 @@
|
|
|
246387
246519
|
"type": "string"
|
|
246388
246520
|
},
|
|
246389
246521
|
"commits": {
|
|
246390
|
-
"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
|
|
246522
|
+
"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-server@3.10/rest/commits) to fetch additional commits.",
|
|
246391
246523
|
"type": "array",
|
|
246392
246524
|
"items": {
|
|
246393
246525
|
"title": "Commit",
|
|
@@ -295546,7 +295678,7 @@
|
|
|
295546
295678
|
},
|
|
295547
295679
|
"workflow-run-status": {
|
|
295548
295680
|
"name": "status",
|
|
295549
|
-
"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`.",
|
|
295681
|
+
"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`.",
|
|
295550
295682
|
"in": "query",
|
|
295551
295683
|
"required": false,
|
|
295552
295684
|
"schema": {
|
|
@@ -295800,6 +295932,17 @@
|
|
|
295800
295932
|
"type": "integer"
|
|
295801
295933
|
}
|
|
295802
295934
|
},
|
|
295935
|
+
"git-ref-only": {
|
|
295936
|
+
"name": "ref",
|
|
295937
|
+
"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.",
|
|
295938
|
+
"in": "path",
|
|
295939
|
+
"required": true,
|
|
295940
|
+
"example": "heads/feature-a",
|
|
295941
|
+
"schema": {
|
|
295942
|
+
"type": "string"
|
|
295943
|
+
},
|
|
295944
|
+
"x-multi-segment": true
|
|
295945
|
+
},
|
|
295803
295946
|
"invitation-id": {
|
|
295804
295947
|
"name": "invitation_id",
|
|
295805
295948
|
"description": "The unique identifier of the invitation.",
|