@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.8.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": {
|
|
@@ -8344,7 +8344,7 @@
|
|
|
8344
8344
|
"/feeds": {
|
|
8345
8345
|
"get": {
|
|
8346
8346
|
"summary": "Get feeds",
|
|
8347
|
-
"description": "
|
|
8347
|
+
"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.8/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.8/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.8/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens.",
|
|
8348
8348
|
"tags": [
|
|
8349
8349
|
"activity"
|
|
8350
8350
|
],
|
|
@@ -10863,7 +10863,7 @@
|
|
|
10863
10863
|
"/organizations": {
|
|
10864
10864
|
"get": {
|
|
10865
10865
|
"summary": "List organizations",
|
|
10866
|
-
"description": "Lists all organizations, in the order that they were created
|
|
10866
|
+
"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.8/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations.",
|
|
10867
10867
|
"tags": [
|
|
10868
10868
|
"orgs"
|
|
10869
10869
|
],
|
|
@@ -30198,11 +30198,14 @@
|
|
|
30198
30198
|
},
|
|
30199
30199
|
"status": {
|
|
30200
30200
|
"type": "string",
|
|
30201
|
-
"description": "The current status.",
|
|
30201
|
+
"description": "The current status of the check run. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`.",
|
|
30202
30202
|
"enum": [
|
|
30203
30203
|
"queued",
|
|
30204
30204
|
"in_progress",
|
|
30205
|
-
"completed"
|
|
30205
|
+
"completed",
|
|
30206
|
+
"waiting",
|
|
30207
|
+
"requested",
|
|
30208
|
+
"pending"
|
|
30206
30209
|
]
|
|
30207
30210
|
},
|
|
30208
30211
|
"conclusion": {
|
|
@@ -32708,6 +32711,9 @@
|
|
|
32708
32711
|
}
|
|
32709
32712
|
}
|
|
32710
32713
|
},
|
|
32714
|
+
"409": {
|
|
32715
|
+
"$ref": "#/components/responses/conflict"
|
|
32716
|
+
},
|
|
32711
32717
|
"422": {
|
|
32712
32718
|
"$ref": "#/components/responses/validation_failed"
|
|
32713
32719
|
}
|
|
@@ -32939,6 +32945,9 @@
|
|
|
32939
32945
|
"$ref": "#/components/headers/link"
|
|
32940
32946
|
}
|
|
32941
32947
|
}
|
|
32948
|
+
},
|
|
32949
|
+
"409": {
|
|
32950
|
+
"$ref": "#/components/responses/conflict"
|
|
32942
32951
|
}
|
|
32943
32952
|
},
|
|
32944
32953
|
"x-github": {
|
|
@@ -32998,6 +33007,9 @@
|
|
|
32998
33007
|
"404": {
|
|
32999
33008
|
"$ref": "#/components/responses/not_found"
|
|
33000
33009
|
},
|
|
33010
|
+
"409": {
|
|
33011
|
+
"$ref": "#/components/responses/conflict"
|
|
33012
|
+
},
|
|
33001
33013
|
"422": {
|
|
33002
33014
|
"$ref": "#/components/responses/validation_failed"
|
|
33003
33015
|
},
|
|
@@ -33335,7 +33347,7 @@
|
|
|
33335
33347
|
"/repos/{owner}/{repo}/compare/{basehead}": {
|
|
33336
33348
|
"get": {
|
|
33337
33349
|
"summary": "Compare two commits",
|
|
33338
|
-
"description": "Compares two commits against one another. You can compare branches in the same repository, or you can compare
|
|
33350
|
+
"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.8/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.8/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.8/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. |",
|
|
33339
33351
|
"tags": [
|
|
33340
33352
|
"repos"
|
|
33341
33353
|
],
|
|
@@ -35886,6 +35898,616 @@
|
|
|
35886
35898
|
"x-octokit": {}
|
|
35887
35899
|
}
|
|
35888
35900
|
},
|
|
35901
|
+
"/repos/{owner}/{repo}/environments/{environment_name}/secrets": {
|
|
35902
|
+
"get": {
|
|
35903
|
+
"summary": "List environment secrets",
|
|
35904
|
+
"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.",
|
|
35905
|
+
"tags": [
|
|
35906
|
+
"actions"
|
|
35907
|
+
],
|
|
35908
|
+
"operationId": "actions/list-environment-secrets",
|
|
35909
|
+
"externalDocs": {
|
|
35910
|
+
"description": "API method documentation",
|
|
35911
|
+
"url": "https://docs.github.com/enterprise-server@3.8/rest/actions/secrets#list-environment-secrets"
|
|
35912
|
+
},
|
|
35913
|
+
"parameters": [
|
|
35914
|
+
{
|
|
35915
|
+
"$ref": "#/components/parameters/owner"
|
|
35916
|
+
},
|
|
35917
|
+
{
|
|
35918
|
+
"$ref": "#/components/parameters/repo"
|
|
35919
|
+
},
|
|
35920
|
+
{
|
|
35921
|
+
"$ref": "#/components/parameters/environment-name"
|
|
35922
|
+
},
|
|
35923
|
+
{
|
|
35924
|
+
"$ref": "#/components/parameters/per-page"
|
|
35925
|
+
},
|
|
35926
|
+
{
|
|
35927
|
+
"$ref": "#/components/parameters/page"
|
|
35928
|
+
}
|
|
35929
|
+
],
|
|
35930
|
+
"responses": {
|
|
35931
|
+
"200": {
|
|
35932
|
+
"description": "Response",
|
|
35933
|
+
"content": {
|
|
35934
|
+
"application/json": {
|
|
35935
|
+
"schema": {
|
|
35936
|
+
"type": "object",
|
|
35937
|
+
"required": [
|
|
35938
|
+
"total_count",
|
|
35939
|
+
"secrets"
|
|
35940
|
+
],
|
|
35941
|
+
"properties": {
|
|
35942
|
+
"total_count": {
|
|
35943
|
+
"type": "integer"
|
|
35944
|
+
},
|
|
35945
|
+
"secrets": {
|
|
35946
|
+
"type": "array",
|
|
35947
|
+
"items": {
|
|
35948
|
+
"$ref": "#/components/schemas/actions-secret"
|
|
35949
|
+
}
|
|
35950
|
+
}
|
|
35951
|
+
}
|
|
35952
|
+
},
|
|
35953
|
+
"examples": {
|
|
35954
|
+
"default": {
|
|
35955
|
+
"$ref": "#/components/examples/actions-secret-paginated"
|
|
35956
|
+
}
|
|
35957
|
+
}
|
|
35958
|
+
}
|
|
35959
|
+
},
|
|
35960
|
+
"headers": {
|
|
35961
|
+
"Link": {
|
|
35962
|
+
"$ref": "#/components/headers/link"
|
|
35963
|
+
}
|
|
35964
|
+
}
|
|
35965
|
+
}
|
|
35966
|
+
},
|
|
35967
|
+
"x-github": {
|
|
35968
|
+
"githubCloudOnly": false,
|
|
35969
|
+
"enabledForGitHubApps": true,
|
|
35970
|
+
"category": "actions",
|
|
35971
|
+
"subcategory": "secrets"
|
|
35972
|
+
},
|
|
35973
|
+
"x-octokit": {}
|
|
35974
|
+
}
|
|
35975
|
+
},
|
|
35976
|
+
"/repos/{owner}/{repo}/environments/{environment_name}/secrets/public-key": {
|
|
35977
|
+
"get": {
|
|
35978
|
+
"summary": "Get an environment public key",
|
|
35979
|
+
"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.",
|
|
35980
|
+
"tags": [
|
|
35981
|
+
"actions"
|
|
35982
|
+
],
|
|
35983
|
+
"operationId": "actions/get-environment-public-key",
|
|
35984
|
+
"externalDocs": {
|
|
35985
|
+
"description": "API method documentation",
|
|
35986
|
+
"url": "https://docs.github.com/enterprise-server@3.8/rest/actions/secrets#get-an-environment-public-key"
|
|
35987
|
+
},
|
|
35988
|
+
"parameters": [
|
|
35989
|
+
{
|
|
35990
|
+
"$ref": "#/components/parameters/owner"
|
|
35991
|
+
},
|
|
35992
|
+
{
|
|
35993
|
+
"$ref": "#/components/parameters/repo"
|
|
35994
|
+
},
|
|
35995
|
+
{
|
|
35996
|
+
"$ref": "#/components/parameters/environment-name"
|
|
35997
|
+
}
|
|
35998
|
+
],
|
|
35999
|
+
"responses": {
|
|
36000
|
+
"200": {
|
|
36001
|
+
"description": "Response",
|
|
36002
|
+
"content": {
|
|
36003
|
+
"application/json": {
|
|
36004
|
+
"schema": {
|
|
36005
|
+
"$ref": "#/components/schemas/actions-public-key"
|
|
36006
|
+
},
|
|
36007
|
+
"examples": {
|
|
36008
|
+
"default": {
|
|
36009
|
+
"$ref": "#/components/examples/actions-public-key"
|
|
36010
|
+
}
|
|
36011
|
+
}
|
|
36012
|
+
}
|
|
36013
|
+
}
|
|
36014
|
+
}
|
|
36015
|
+
},
|
|
36016
|
+
"x-github": {
|
|
36017
|
+
"githubCloudOnly": false,
|
|
36018
|
+
"enabledForGitHubApps": true,
|
|
36019
|
+
"category": "actions",
|
|
36020
|
+
"subcategory": "secrets"
|
|
36021
|
+
},
|
|
36022
|
+
"x-octokit": {}
|
|
36023
|
+
}
|
|
36024
|
+
},
|
|
36025
|
+
"/repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}": {
|
|
36026
|
+
"get": {
|
|
36027
|
+
"summary": "Get an environment secret",
|
|
36028
|
+
"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.",
|
|
36029
|
+
"tags": [
|
|
36030
|
+
"actions"
|
|
36031
|
+
],
|
|
36032
|
+
"operationId": "actions/get-environment-secret",
|
|
36033
|
+
"externalDocs": {
|
|
36034
|
+
"description": "API method documentation",
|
|
36035
|
+
"url": "https://docs.github.com/enterprise-server@3.8/rest/actions/secrets#get-an-environment-secret"
|
|
36036
|
+
},
|
|
36037
|
+
"parameters": [
|
|
36038
|
+
{
|
|
36039
|
+
"$ref": "#/components/parameters/owner"
|
|
36040
|
+
},
|
|
36041
|
+
{
|
|
36042
|
+
"$ref": "#/components/parameters/repo"
|
|
36043
|
+
},
|
|
36044
|
+
{
|
|
36045
|
+
"$ref": "#/components/parameters/environment-name"
|
|
36046
|
+
},
|
|
36047
|
+
{
|
|
36048
|
+
"$ref": "#/components/parameters/secret-name"
|
|
36049
|
+
}
|
|
36050
|
+
],
|
|
36051
|
+
"responses": {
|
|
36052
|
+
"200": {
|
|
36053
|
+
"description": "Response",
|
|
36054
|
+
"content": {
|
|
36055
|
+
"application/json": {
|
|
36056
|
+
"schema": {
|
|
36057
|
+
"$ref": "#/components/schemas/actions-secret"
|
|
36058
|
+
},
|
|
36059
|
+
"examples": {
|
|
36060
|
+
"default": {
|
|
36061
|
+
"$ref": "#/components/examples/actions-secret"
|
|
36062
|
+
}
|
|
36063
|
+
}
|
|
36064
|
+
}
|
|
36065
|
+
}
|
|
36066
|
+
}
|
|
36067
|
+
},
|
|
36068
|
+
"x-github": {
|
|
36069
|
+
"githubCloudOnly": false,
|
|
36070
|
+
"enabledForGitHubApps": true,
|
|
36071
|
+
"category": "actions",
|
|
36072
|
+
"subcategory": "secrets"
|
|
36073
|
+
},
|
|
36074
|
+
"x-octokit": {}
|
|
36075
|
+
},
|
|
36076
|
+
"put": {
|
|
36077
|
+
"summary": "Create or update an environment secret",
|
|
36078
|
+
"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.8/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.",
|
|
36079
|
+
"tags": [
|
|
36080
|
+
"actions"
|
|
36081
|
+
],
|
|
36082
|
+
"operationId": "actions/create-or-update-environment-secret",
|
|
36083
|
+
"externalDocs": {
|
|
36084
|
+
"description": "API method documentation",
|
|
36085
|
+
"url": "https://docs.github.com/enterprise-server@3.8/rest/actions/secrets#create-or-update-an-environment-secret"
|
|
36086
|
+
},
|
|
36087
|
+
"parameters": [
|
|
36088
|
+
{
|
|
36089
|
+
"$ref": "#/components/parameters/owner"
|
|
36090
|
+
},
|
|
36091
|
+
{
|
|
36092
|
+
"$ref": "#/components/parameters/repo"
|
|
36093
|
+
},
|
|
36094
|
+
{
|
|
36095
|
+
"$ref": "#/components/parameters/environment-name"
|
|
36096
|
+
},
|
|
36097
|
+
{
|
|
36098
|
+
"$ref": "#/components/parameters/secret-name"
|
|
36099
|
+
}
|
|
36100
|
+
],
|
|
36101
|
+
"requestBody": {
|
|
36102
|
+
"required": true,
|
|
36103
|
+
"content": {
|
|
36104
|
+
"application/json": {
|
|
36105
|
+
"schema": {
|
|
36106
|
+
"type": "object",
|
|
36107
|
+
"properties": {
|
|
36108
|
+
"encrypted_value": {
|
|
36109
|
+
"type": "string",
|
|
36110
|
+
"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.8/rest/actions/secrets#get-an-environment-public-key) endpoint.",
|
|
36111
|
+
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$"
|
|
36112
|
+
},
|
|
36113
|
+
"key_id": {
|
|
36114
|
+
"type": "string",
|
|
36115
|
+
"description": "ID of the key you used to encrypt the secret."
|
|
36116
|
+
}
|
|
36117
|
+
},
|
|
36118
|
+
"required": [
|
|
36119
|
+
"encrypted_value",
|
|
36120
|
+
"key_id"
|
|
36121
|
+
]
|
|
36122
|
+
},
|
|
36123
|
+
"examples": {
|
|
36124
|
+
"default": {
|
|
36125
|
+
"value": {
|
|
36126
|
+
"encrypted_value": "c2VjcmV0",
|
|
36127
|
+
"key_id": "012345678912345678"
|
|
36128
|
+
}
|
|
36129
|
+
}
|
|
36130
|
+
}
|
|
36131
|
+
}
|
|
36132
|
+
}
|
|
36133
|
+
},
|
|
36134
|
+
"responses": {
|
|
36135
|
+
"201": {
|
|
36136
|
+
"description": "Response when creating a secret",
|
|
36137
|
+
"content": {
|
|
36138
|
+
"application/json": {
|
|
36139
|
+
"schema": {
|
|
36140
|
+
"$ref": "#/components/schemas/empty-object"
|
|
36141
|
+
},
|
|
36142
|
+
"examples": {
|
|
36143
|
+
"default": {
|
|
36144
|
+
"value": null
|
|
36145
|
+
}
|
|
36146
|
+
}
|
|
36147
|
+
}
|
|
36148
|
+
}
|
|
36149
|
+
},
|
|
36150
|
+
"204": {
|
|
36151
|
+
"description": "Response when updating a secret"
|
|
36152
|
+
}
|
|
36153
|
+
},
|
|
36154
|
+
"x-github": {
|
|
36155
|
+
"githubCloudOnly": false,
|
|
36156
|
+
"enabledForGitHubApps": true,
|
|
36157
|
+
"category": "actions",
|
|
36158
|
+
"subcategory": "secrets"
|
|
36159
|
+
},
|
|
36160
|
+
"x-octokit": {}
|
|
36161
|
+
},
|
|
36162
|
+
"delete": {
|
|
36163
|
+
"summary": "Delete an environment secret",
|
|
36164
|
+
"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.",
|
|
36165
|
+
"tags": [
|
|
36166
|
+
"actions"
|
|
36167
|
+
],
|
|
36168
|
+
"operationId": "actions/delete-environment-secret",
|
|
36169
|
+
"externalDocs": {
|
|
36170
|
+
"description": "API method documentation",
|
|
36171
|
+
"url": "https://docs.github.com/enterprise-server@3.8/rest/actions/secrets#delete-an-environment-secret"
|
|
36172
|
+
},
|
|
36173
|
+
"parameters": [
|
|
36174
|
+
{
|
|
36175
|
+
"$ref": "#/components/parameters/owner"
|
|
36176
|
+
},
|
|
36177
|
+
{
|
|
36178
|
+
"$ref": "#/components/parameters/repo"
|
|
36179
|
+
},
|
|
36180
|
+
{
|
|
36181
|
+
"$ref": "#/components/parameters/environment-name"
|
|
36182
|
+
},
|
|
36183
|
+
{
|
|
36184
|
+
"$ref": "#/components/parameters/secret-name"
|
|
36185
|
+
}
|
|
36186
|
+
],
|
|
36187
|
+
"responses": {
|
|
36188
|
+
"204": {
|
|
36189
|
+
"description": "Default response"
|
|
36190
|
+
}
|
|
36191
|
+
},
|
|
36192
|
+
"x-github": {
|
|
36193
|
+
"githubCloudOnly": false,
|
|
36194
|
+
"enabledForGitHubApps": true,
|
|
36195
|
+
"category": "actions",
|
|
36196
|
+
"subcategory": "secrets"
|
|
36197
|
+
},
|
|
36198
|
+
"x-octokit": {}
|
|
36199
|
+
}
|
|
36200
|
+
},
|
|
36201
|
+
"/repos/{owner}/{repo}/environments/{environment_name}/variables": {
|
|
36202
|
+
"get": {
|
|
36203
|
+
"summary": "List environment variables",
|
|
36204
|
+
"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.",
|
|
36205
|
+
"tags": [
|
|
36206
|
+
"actions"
|
|
36207
|
+
],
|
|
36208
|
+
"operationId": "actions/list-environment-variables",
|
|
36209
|
+
"externalDocs": {
|
|
36210
|
+
"description": "API method documentation",
|
|
36211
|
+
"url": "https://docs.github.com/enterprise-server@3.8/rest/actions/variables#list-environment-variables"
|
|
36212
|
+
},
|
|
36213
|
+
"parameters": [
|
|
36214
|
+
{
|
|
36215
|
+
"$ref": "#/components/parameters/owner"
|
|
36216
|
+
},
|
|
36217
|
+
{
|
|
36218
|
+
"$ref": "#/components/parameters/repo"
|
|
36219
|
+
},
|
|
36220
|
+
{
|
|
36221
|
+
"$ref": "#/components/parameters/environment-name"
|
|
36222
|
+
},
|
|
36223
|
+
{
|
|
36224
|
+
"$ref": "#/components/parameters/variables-per-page"
|
|
36225
|
+
},
|
|
36226
|
+
{
|
|
36227
|
+
"$ref": "#/components/parameters/page"
|
|
36228
|
+
}
|
|
36229
|
+
],
|
|
36230
|
+
"responses": {
|
|
36231
|
+
"200": {
|
|
36232
|
+
"description": "Response",
|
|
36233
|
+
"content": {
|
|
36234
|
+
"application/json": {
|
|
36235
|
+
"schema": {
|
|
36236
|
+
"type": "object",
|
|
36237
|
+
"required": [
|
|
36238
|
+
"total_count",
|
|
36239
|
+
"variables"
|
|
36240
|
+
],
|
|
36241
|
+
"properties": {
|
|
36242
|
+
"total_count": {
|
|
36243
|
+
"type": "integer"
|
|
36244
|
+
},
|
|
36245
|
+
"variables": {
|
|
36246
|
+
"type": "array",
|
|
36247
|
+
"items": {
|
|
36248
|
+
"$ref": "#/components/schemas/actions-variable"
|
|
36249
|
+
}
|
|
36250
|
+
}
|
|
36251
|
+
}
|
|
36252
|
+
},
|
|
36253
|
+
"examples": {
|
|
36254
|
+
"default": {
|
|
36255
|
+
"$ref": "#/components/examples/actions-variables-paginated"
|
|
36256
|
+
}
|
|
36257
|
+
}
|
|
36258
|
+
}
|
|
36259
|
+
},
|
|
36260
|
+
"headers": {
|
|
36261
|
+
"Link": {
|
|
36262
|
+
"$ref": "#/components/headers/link"
|
|
36263
|
+
}
|
|
36264
|
+
}
|
|
36265
|
+
}
|
|
36266
|
+
},
|
|
36267
|
+
"x-github": {
|
|
36268
|
+
"githubCloudOnly": false,
|
|
36269
|
+
"enabledForGitHubApps": true,
|
|
36270
|
+
"category": "actions",
|
|
36271
|
+
"subcategory": "variables"
|
|
36272
|
+
},
|
|
36273
|
+
"x-octokit": {}
|
|
36274
|
+
},
|
|
36275
|
+
"post": {
|
|
36276
|
+
"summary": "Create an environment variable",
|
|
36277
|
+
"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.",
|
|
36278
|
+
"tags": [
|
|
36279
|
+
"actions"
|
|
36280
|
+
],
|
|
36281
|
+
"operationId": "actions/create-environment-variable",
|
|
36282
|
+
"externalDocs": {
|
|
36283
|
+
"description": "API method documentation",
|
|
36284
|
+
"url": "https://docs.github.com/enterprise-server@3.8/rest/actions/variables#create-an-environment-variable"
|
|
36285
|
+
},
|
|
36286
|
+
"parameters": [
|
|
36287
|
+
{
|
|
36288
|
+
"$ref": "#/components/parameters/owner"
|
|
36289
|
+
},
|
|
36290
|
+
{
|
|
36291
|
+
"$ref": "#/components/parameters/repo"
|
|
36292
|
+
},
|
|
36293
|
+
{
|
|
36294
|
+
"$ref": "#/components/parameters/environment-name"
|
|
36295
|
+
}
|
|
36296
|
+
],
|
|
36297
|
+
"requestBody": {
|
|
36298
|
+
"required": true,
|
|
36299
|
+
"content": {
|
|
36300
|
+
"application/json": {
|
|
36301
|
+
"schema": {
|
|
36302
|
+
"type": "object",
|
|
36303
|
+
"properties": {
|
|
36304
|
+
"name": {
|
|
36305
|
+
"type": "string",
|
|
36306
|
+
"description": "The name of the variable."
|
|
36307
|
+
},
|
|
36308
|
+
"value": {
|
|
36309
|
+
"type": "string",
|
|
36310
|
+
"description": "The value of the variable."
|
|
36311
|
+
}
|
|
36312
|
+
},
|
|
36313
|
+
"required": [
|
|
36314
|
+
"name",
|
|
36315
|
+
"value"
|
|
36316
|
+
]
|
|
36317
|
+
},
|
|
36318
|
+
"examples": {
|
|
36319
|
+
"default": {
|
|
36320
|
+
"value": {
|
|
36321
|
+
"name": "USERNAME",
|
|
36322
|
+
"value": "octocat"
|
|
36323
|
+
}
|
|
36324
|
+
}
|
|
36325
|
+
}
|
|
36326
|
+
}
|
|
36327
|
+
}
|
|
36328
|
+
},
|
|
36329
|
+
"responses": {
|
|
36330
|
+
"201": {
|
|
36331
|
+
"description": "Response",
|
|
36332
|
+
"content": {
|
|
36333
|
+
"application/json": {
|
|
36334
|
+
"schema": {
|
|
36335
|
+
"$ref": "#/components/schemas/empty-object"
|
|
36336
|
+
},
|
|
36337
|
+
"examples": {
|
|
36338
|
+
"default": {
|
|
36339
|
+
"value": null
|
|
36340
|
+
}
|
|
36341
|
+
}
|
|
36342
|
+
}
|
|
36343
|
+
}
|
|
36344
|
+
}
|
|
36345
|
+
},
|
|
36346
|
+
"x-github": {
|
|
36347
|
+
"githubCloudOnly": false,
|
|
36348
|
+
"enabledForGitHubApps": true,
|
|
36349
|
+
"category": "actions",
|
|
36350
|
+
"subcategory": "variables"
|
|
36351
|
+
},
|
|
36352
|
+
"x-octokit": {}
|
|
36353
|
+
}
|
|
36354
|
+
},
|
|
36355
|
+
"/repos/{owner}/{repo}/environments/{environment_name}/variables/{name}": {
|
|
36356
|
+
"get": {
|
|
36357
|
+
"summary": "Get an environment variable",
|
|
36358
|
+
"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.",
|
|
36359
|
+
"tags": [
|
|
36360
|
+
"actions"
|
|
36361
|
+
],
|
|
36362
|
+
"operationId": "actions/get-environment-variable",
|
|
36363
|
+
"externalDocs": {
|
|
36364
|
+
"description": "API method documentation",
|
|
36365
|
+
"url": "https://docs.github.com/enterprise-server@3.8/rest/actions/variables#get-an-environment-variable"
|
|
36366
|
+
},
|
|
36367
|
+
"parameters": [
|
|
36368
|
+
{
|
|
36369
|
+
"$ref": "#/components/parameters/owner"
|
|
36370
|
+
},
|
|
36371
|
+
{
|
|
36372
|
+
"$ref": "#/components/parameters/repo"
|
|
36373
|
+
},
|
|
36374
|
+
{
|
|
36375
|
+
"$ref": "#/components/parameters/environment-name"
|
|
36376
|
+
},
|
|
36377
|
+
{
|
|
36378
|
+
"$ref": "#/components/parameters/variable-name"
|
|
36379
|
+
}
|
|
36380
|
+
],
|
|
36381
|
+
"responses": {
|
|
36382
|
+
"200": {
|
|
36383
|
+
"description": "Response",
|
|
36384
|
+
"content": {
|
|
36385
|
+
"application/json": {
|
|
36386
|
+
"schema": {
|
|
36387
|
+
"$ref": "#/components/schemas/actions-variable"
|
|
36388
|
+
},
|
|
36389
|
+
"examples": {
|
|
36390
|
+
"default": {
|
|
36391
|
+
"$ref": "#/components/examples/actions-variable"
|
|
36392
|
+
}
|
|
36393
|
+
}
|
|
36394
|
+
}
|
|
36395
|
+
}
|
|
36396
|
+
}
|
|
36397
|
+
},
|
|
36398
|
+
"x-github": {
|
|
36399
|
+
"githubCloudOnly": false,
|
|
36400
|
+
"enabledForGitHubApps": true,
|
|
36401
|
+
"category": "actions",
|
|
36402
|
+
"subcategory": "variables"
|
|
36403
|
+
},
|
|
36404
|
+
"x-octokit": {}
|
|
36405
|
+
},
|
|
36406
|
+
"patch": {
|
|
36407
|
+
"summary": "Update an environment variable",
|
|
36408
|
+
"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.",
|
|
36409
|
+
"tags": [
|
|
36410
|
+
"actions"
|
|
36411
|
+
],
|
|
36412
|
+
"operationId": "actions/update-environment-variable",
|
|
36413
|
+
"externalDocs": {
|
|
36414
|
+
"description": "API method documentation",
|
|
36415
|
+
"url": "https://docs.github.com/enterprise-server@3.8/rest/actions/variables#update-an-environment-variable"
|
|
36416
|
+
},
|
|
36417
|
+
"parameters": [
|
|
36418
|
+
{
|
|
36419
|
+
"$ref": "#/components/parameters/owner"
|
|
36420
|
+
},
|
|
36421
|
+
{
|
|
36422
|
+
"$ref": "#/components/parameters/repo"
|
|
36423
|
+
},
|
|
36424
|
+
{
|
|
36425
|
+
"$ref": "#/components/parameters/variable-name"
|
|
36426
|
+
},
|
|
36427
|
+
{
|
|
36428
|
+
"$ref": "#/components/parameters/environment-name"
|
|
36429
|
+
}
|
|
36430
|
+
],
|
|
36431
|
+
"requestBody": {
|
|
36432
|
+
"required": true,
|
|
36433
|
+
"content": {
|
|
36434
|
+
"application/json": {
|
|
36435
|
+
"schema": {
|
|
36436
|
+
"type": "object",
|
|
36437
|
+
"properties": {
|
|
36438
|
+
"name": {
|
|
36439
|
+
"type": "string",
|
|
36440
|
+
"description": "The name of the variable."
|
|
36441
|
+
},
|
|
36442
|
+
"value": {
|
|
36443
|
+
"type": "string",
|
|
36444
|
+
"description": "The value of the variable."
|
|
36445
|
+
}
|
|
36446
|
+
}
|
|
36447
|
+
},
|
|
36448
|
+
"examples": {
|
|
36449
|
+
"default": {
|
|
36450
|
+
"value": {
|
|
36451
|
+
"name": "USERNAME",
|
|
36452
|
+
"value": "octocat"
|
|
36453
|
+
}
|
|
36454
|
+
}
|
|
36455
|
+
}
|
|
36456
|
+
}
|
|
36457
|
+
}
|
|
36458
|
+
},
|
|
36459
|
+
"responses": {
|
|
36460
|
+
"204": {
|
|
36461
|
+
"description": "Response"
|
|
36462
|
+
}
|
|
36463
|
+
},
|
|
36464
|
+
"x-github": {
|
|
36465
|
+
"githubCloudOnly": false,
|
|
36466
|
+
"enabledForGitHubApps": true,
|
|
36467
|
+
"category": "actions",
|
|
36468
|
+
"subcategory": "variables"
|
|
36469
|
+
},
|
|
36470
|
+
"x-octokit": {}
|
|
36471
|
+
},
|
|
36472
|
+
"delete": {
|
|
36473
|
+
"summary": "Delete an environment variable",
|
|
36474
|
+
"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.",
|
|
36475
|
+
"tags": [
|
|
36476
|
+
"actions"
|
|
36477
|
+
],
|
|
36478
|
+
"operationId": "actions/delete-environment-variable",
|
|
36479
|
+
"externalDocs": {
|
|
36480
|
+
"description": "API method documentation",
|
|
36481
|
+
"url": "https://docs.github.com/enterprise-server@3.8/rest/actions/variables#delete-an-environment-variable"
|
|
36482
|
+
},
|
|
36483
|
+
"parameters": [
|
|
36484
|
+
{
|
|
36485
|
+
"$ref": "#/components/parameters/owner"
|
|
36486
|
+
},
|
|
36487
|
+
{
|
|
36488
|
+
"$ref": "#/components/parameters/repo"
|
|
36489
|
+
},
|
|
36490
|
+
{
|
|
36491
|
+
"$ref": "#/components/parameters/variable-name"
|
|
36492
|
+
},
|
|
36493
|
+
{
|
|
36494
|
+
"$ref": "#/components/parameters/environment-name"
|
|
36495
|
+
}
|
|
36496
|
+
],
|
|
36497
|
+
"responses": {
|
|
36498
|
+
"204": {
|
|
36499
|
+
"description": "Response"
|
|
36500
|
+
}
|
|
36501
|
+
},
|
|
36502
|
+
"x-github": {
|
|
36503
|
+
"githubCloudOnly": false,
|
|
36504
|
+
"enabledForGitHubApps": true,
|
|
36505
|
+
"category": "actions",
|
|
36506
|
+
"subcategory": "variables"
|
|
36507
|
+
},
|
|
36508
|
+
"x-octokit": {}
|
|
36509
|
+
}
|
|
36510
|
+
},
|
|
35889
36511
|
"/repos/{owner}/{repo}/events": {
|
|
35890
36512
|
"get": {
|
|
35891
36513
|
"summary": "List repository events",
|
|
@@ -36258,6 +36880,9 @@
|
|
|
36258
36880
|
"404": {
|
|
36259
36881
|
"$ref": "#/components/responses/not_found"
|
|
36260
36882
|
},
|
|
36883
|
+
"409": {
|
|
36884
|
+
"$ref": "#/components/responses/conflict"
|
|
36885
|
+
},
|
|
36261
36886
|
"422": {
|
|
36262
36887
|
"$ref": "#/components/responses/validation_failed"
|
|
36263
36888
|
}
|
|
@@ -36412,6 +37037,9 @@
|
|
|
36412
37037
|
"404": {
|
|
36413
37038
|
"$ref": "#/components/responses/not_found"
|
|
36414
37039
|
},
|
|
37040
|
+
"409": {
|
|
37041
|
+
"$ref": "#/components/responses/conflict"
|
|
37042
|
+
},
|
|
36415
37043
|
"422": {
|
|
36416
37044
|
"$ref": "#/components/responses/validation_failed"
|
|
36417
37045
|
}
|
|
@@ -36466,6 +37094,9 @@
|
|
|
36466
37094
|
},
|
|
36467
37095
|
"404": {
|
|
36468
37096
|
"$ref": "#/components/responses/not_found"
|
|
37097
|
+
},
|
|
37098
|
+
"409": {
|
|
37099
|
+
"$ref": "#/components/responses/conflict"
|
|
36469
37100
|
}
|
|
36470
37101
|
},
|
|
36471
37102
|
"x-github": {
|
|
@@ -36497,7 +37128,7 @@
|
|
|
36497
37128
|
"$ref": "#/components/parameters/repo"
|
|
36498
37129
|
},
|
|
36499
37130
|
{
|
|
36500
|
-
"$ref": "#/components/parameters/
|
|
37131
|
+
"$ref": "#/components/parameters/git-ref-only"
|
|
36501
37132
|
}
|
|
36502
37133
|
],
|
|
36503
37134
|
"responses": {
|
|
@@ -36523,6 +37154,9 @@
|
|
|
36523
37154
|
"$ref": "#/components/headers/link"
|
|
36524
37155
|
}
|
|
36525
37156
|
}
|
|
37157
|
+
},
|
|
37158
|
+
"409": {
|
|
37159
|
+
"$ref": "#/components/responses/conflict"
|
|
36526
37160
|
}
|
|
36527
37161
|
},
|
|
36528
37162
|
"x-github": {
|
|
@@ -36554,7 +37188,7 @@
|
|
|
36554
37188
|
"$ref": "#/components/parameters/repo"
|
|
36555
37189
|
},
|
|
36556
37190
|
{
|
|
36557
|
-
"$ref": "#/components/parameters/
|
|
37191
|
+
"$ref": "#/components/parameters/git-ref-only"
|
|
36558
37192
|
}
|
|
36559
37193
|
],
|
|
36560
37194
|
"responses": {
|
|
@@ -36575,6 +37209,9 @@
|
|
|
36575
37209
|
},
|
|
36576
37210
|
"404": {
|
|
36577
37211
|
"$ref": "#/components/responses/not_found"
|
|
37212
|
+
},
|
|
37213
|
+
"409": {
|
|
37214
|
+
"$ref": "#/components/responses/conflict"
|
|
36578
37215
|
}
|
|
36579
37216
|
},
|
|
36580
37217
|
"x-github": {
|
|
@@ -36662,6 +37299,9 @@
|
|
|
36662
37299
|
}
|
|
36663
37300
|
}
|
|
36664
37301
|
},
|
|
37302
|
+
"409": {
|
|
37303
|
+
"$ref": "#/components/responses/conflict"
|
|
37304
|
+
},
|
|
36665
37305
|
"422": {
|
|
36666
37306
|
"$ref": "#/components/responses/validation_failed"
|
|
36667
37307
|
}
|
|
@@ -36678,7 +37318,7 @@
|
|
|
36678
37318
|
"/repos/{owner}/{repo}/git/refs/{ref}": {
|
|
36679
37319
|
"patch": {
|
|
36680
37320
|
"summary": "Update a reference",
|
|
36681
|
-
"description": "",
|
|
37321
|
+
"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.",
|
|
36682
37322
|
"tags": [
|
|
36683
37323
|
"git"
|
|
36684
37324
|
],
|
|
@@ -36695,15 +37335,7 @@
|
|
|
36695
37335
|
"$ref": "#/components/parameters/repo"
|
|
36696
37336
|
},
|
|
36697
37337
|
{
|
|
36698
|
-
"
|
|
36699
|
-
"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.",
|
|
36700
|
-
"in": "path",
|
|
36701
|
-
"required": true,
|
|
36702
|
-
"example": "heads/featureA",
|
|
36703
|
-
"schema": {
|
|
36704
|
-
"type": "string"
|
|
36705
|
-
},
|
|
36706
|
-
"x-multi-segment": true
|
|
37338
|
+
"$ref": "#/components/parameters/git-ref-only"
|
|
36707
37339
|
}
|
|
36708
37340
|
],
|
|
36709
37341
|
"requestBody": {
|
|
@@ -36754,6 +37386,9 @@
|
|
|
36754
37386
|
}
|
|
36755
37387
|
}
|
|
36756
37388
|
},
|
|
37389
|
+
"409": {
|
|
37390
|
+
"$ref": "#/components/responses/conflict"
|
|
37391
|
+
},
|
|
36757
37392
|
"422": {
|
|
36758
37393
|
"$ref": "#/components/responses/validation_failed"
|
|
36759
37394
|
}
|
|
@@ -36768,7 +37403,7 @@
|
|
|
36768
37403
|
},
|
|
36769
37404
|
"delete": {
|
|
36770
37405
|
"summary": "Delete a reference",
|
|
36771
|
-
"description": "",
|
|
37406
|
+
"description": "Deletes the provided reference.",
|
|
36772
37407
|
"tags": [
|
|
36773
37408
|
"git"
|
|
36774
37409
|
],
|
|
@@ -36785,13 +37420,16 @@
|
|
|
36785
37420
|
"$ref": "#/components/parameters/repo"
|
|
36786
37421
|
},
|
|
36787
37422
|
{
|
|
36788
|
-
"$ref": "#/components/parameters/
|
|
37423
|
+
"$ref": "#/components/parameters/git-ref-only"
|
|
36789
37424
|
}
|
|
36790
37425
|
],
|
|
36791
37426
|
"responses": {
|
|
36792
37427
|
"204": {
|
|
36793
37428
|
"description": "Response"
|
|
36794
37429
|
},
|
|
37430
|
+
"409": {
|
|
37431
|
+
"$ref": "#/components/responses/conflict"
|
|
37432
|
+
},
|
|
36795
37433
|
"422": {
|
|
36796
37434
|
"$ref": "#/components/responses/validation_failed"
|
|
36797
37435
|
}
|
|
@@ -36926,6 +37564,9 @@
|
|
|
36926
37564
|
}
|
|
36927
37565
|
}
|
|
36928
37566
|
},
|
|
37567
|
+
"409": {
|
|
37568
|
+
"$ref": "#/components/responses/conflict"
|
|
37569
|
+
},
|
|
36929
37570
|
"422": {
|
|
36930
37571
|
"$ref": "#/components/responses/validation_failed"
|
|
36931
37572
|
}
|
|
@@ -36985,6 +37626,9 @@
|
|
|
36985
37626
|
},
|
|
36986
37627
|
"404": {
|
|
36987
37628
|
"$ref": "#/components/responses/not_found"
|
|
37629
|
+
},
|
|
37630
|
+
"409": {
|
|
37631
|
+
"$ref": "#/components/responses/conflict"
|
|
36988
37632
|
}
|
|
36989
37633
|
},
|
|
36990
37634
|
"x-github": {
|
|
@@ -37122,6 +37766,9 @@
|
|
|
37122
37766
|
"404": {
|
|
37123
37767
|
"$ref": "#/components/responses/not_found"
|
|
37124
37768
|
},
|
|
37769
|
+
"409": {
|
|
37770
|
+
"$ref": "#/components/responses/conflict"
|
|
37771
|
+
},
|
|
37125
37772
|
"422": {
|
|
37126
37773
|
"$ref": "#/components/responses/validation_failed"
|
|
37127
37774
|
}
|
|
@@ -37196,6 +37843,9 @@
|
|
|
37196
37843
|
"404": {
|
|
37197
37844
|
"$ref": "#/components/responses/not_found"
|
|
37198
37845
|
},
|
|
37846
|
+
"409": {
|
|
37847
|
+
"$ref": "#/components/responses/conflict"
|
|
37848
|
+
},
|
|
37199
37849
|
"422": {
|
|
37200
37850
|
"$ref": "#/components/responses/validation_failed"
|
|
37201
37851
|
}
|
|
@@ -48950,587 +49600,7 @@
|
|
|
48950
49600
|
"x-octokit": {}
|
|
48951
49601
|
}
|
|
48952
49602
|
},
|
|
48953
|
-
"/
|
|
48954
|
-
"get": {
|
|
48955
|
-
"summary": "List environment secrets",
|
|
48956
|
-
"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.",
|
|
48957
|
-
"tags": [
|
|
48958
|
-
"actions"
|
|
48959
|
-
],
|
|
48960
|
-
"operationId": "actions/list-environment-secrets",
|
|
48961
|
-
"externalDocs": {
|
|
48962
|
-
"description": "API method documentation",
|
|
48963
|
-
"url": "https://docs.github.com/enterprise-server@3.8/rest/actions/secrets#list-environment-secrets"
|
|
48964
|
-
},
|
|
48965
|
-
"parameters": [
|
|
48966
|
-
{
|
|
48967
|
-
"$ref": "#/components/parameters/repository-id"
|
|
48968
|
-
},
|
|
48969
|
-
{
|
|
48970
|
-
"$ref": "#/components/parameters/environment-name"
|
|
48971
|
-
},
|
|
48972
|
-
{
|
|
48973
|
-
"$ref": "#/components/parameters/per-page"
|
|
48974
|
-
},
|
|
48975
|
-
{
|
|
48976
|
-
"$ref": "#/components/parameters/page"
|
|
48977
|
-
}
|
|
48978
|
-
],
|
|
48979
|
-
"responses": {
|
|
48980
|
-
"200": {
|
|
48981
|
-
"description": "Response",
|
|
48982
|
-
"content": {
|
|
48983
|
-
"application/json": {
|
|
48984
|
-
"schema": {
|
|
48985
|
-
"type": "object",
|
|
48986
|
-
"required": [
|
|
48987
|
-
"total_count",
|
|
48988
|
-
"secrets"
|
|
48989
|
-
],
|
|
48990
|
-
"properties": {
|
|
48991
|
-
"total_count": {
|
|
48992
|
-
"type": "integer"
|
|
48993
|
-
},
|
|
48994
|
-
"secrets": {
|
|
48995
|
-
"type": "array",
|
|
48996
|
-
"items": {
|
|
48997
|
-
"$ref": "#/components/schemas/actions-secret"
|
|
48998
|
-
}
|
|
48999
|
-
}
|
|
49000
|
-
}
|
|
49001
|
-
},
|
|
49002
|
-
"examples": {
|
|
49003
|
-
"default": {
|
|
49004
|
-
"$ref": "#/components/examples/actions-secret-paginated"
|
|
49005
|
-
}
|
|
49006
|
-
}
|
|
49007
|
-
}
|
|
49008
|
-
},
|
|
49009
|
-
"headers": {
|
|
49010
|
-
"Link": {
|
|
49011
|
-
"$ref": "#/components/headers/link"
|
|
49012
|
-
}
|
|
49013
|
-
}
|
|
49014
|
-
}
|
|
49015
|
-
},
|
|
49016
|
-
"x-github": {
|
|
49017
|
-
"githubCloudOnly": false,
|
|
49018
|
-
"enabledForGitHubApps": true,
|
|
49019
|
-
"category": "actions",
|
|
49020
|
-
"subcategory": "secrets"
|
|
49021
|
-
},
|
|
49022
|
-
"x-octokit": {}
|
|
49023
|
-
}
|
|
49024
|
-
},
|
|
49025
|
-
"/repositories/{repository_id}/environments/{environment_name}/secrets/public-key": {
|
|
49026
|
-
"get": {
|
|
49027
|
-
"summary": "Get an environment public key",
|
|
49028
|
-
"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.",
|
|
49029
|
-
"tags": [
|
|
49030
|
-
"actions"
|
|
49031
|
-
],
|
|
49032
|
-
"operationId": "actions/get-environment-public-key",
|
|
49033
|
-
"externalDocs": {
|
|
49034
|
-
"description": "API method documentation",
|
|
49035
|
-
"url": "https://docs.github.com/enterprise-server@3.8/rest/actions/secrets#get-an-environment-public-key"
|
|
49036
|
-
},
|
|
49037
|
-
"parameters": [
|
|
49038
|
-
{
|
|
49039
|
-
"$ref": "#/components/parameters/repository-id"
|
|
49040
|
-
},
|
|
49041
|
-
{
|
|
49042
|
-
"$ref": "#/components/parameters/environment-name"
|
|
49043
|
-
}
|
|
49044
|
-
],
|
|
49045
|
-
"responses": {
|
|
49046
|
-
"200": {
|
|
49047
|
-
"description": "Response",
|
|
49048
|
-
"content": {
|
|
49049
|
-
"application/json": {
|
|
49050
|
-
"schema": {
|
|
49051
|
-
"$ref": "#/components/schemas/actions-public-key"
|
|
49052
|
-
},
|
|
49053
|
-
"examples": {
|
|
49054
|
-
"default": {
|
|
49055
|
-
"$ref": "#/components/examples/actions-public-key"
|
|
49056
|
-
}
|
|
49057
|
-
}
|
|
49058
|
-
}
|
|
49059
|
-
}
|
|
49060
|
-
}
|
|
49061
|
-
},
|
|
49062
|
-
"x-github": {
|
|
49063
|
-
"githubCloudOnly": false,
|
|
49064
|
-
"enabledForGitHubApps": true,
|
|
49065
|
-
"category": "actions",
|
|
49066
|
-
"subcategory": "secrets"
|
|
49067
|
-
},
|
|
49068
|
-
"x-octokit": {}
|
|
49069
|
-
}
|
|
49070
|
-
},
|
|
49071
|
-
"/repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}": {
|
|
49072
|
-
"get": {
|
|
49073
|
-
"summary": "Get an environment secret",
|
|
49074
|
-
"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.",
|
|
49075
|
-
"tags": [
|
|
49076
|
-
"actions"
|
|
49077
|
-
],
|
|
49078
|
-
"operationId": "actions/get-environment-secret",
|
|
49079
|
-
"externalDocs": {
|
|
49080
|
-
"description": "API method documentation",
|
|
49081
|
-
"url": "https://docs.github.com/enterprise-server@3.8/rest/actions/secrets#get-an-environment-secret"
|
|
49082
|
-
},
|
|
49083
|
-
"parameters": [
|
|
49084
|
-
{
|
|
49085
|
-
"$ref": "#/components/parameters/repository-id"
|
|
49086
|
-
},
|
|
49087
|
-
{
|
|
49088
|
-
"$ref": "#/components/parameters/environment-name"
|
|
49089
|
-
},
|
|
49090
|
-
{
|
|
49091
|
-
"$ref": "#/components/parameters/secret-name"
|
|
49092
|
-
}
|
|
49093
|
-
],
|
|
49094
|
-
"responses": {
|
|
49095
|
-
"200": {
|
|
49096
|
-
"description": "Response",
|
|
49097
|
-
"content": {
|
|
49098
|
-
"application/json": {
|
|
49099
|
-
"schema": {
|
|
49100
|
-
"$ref": "#/components/schemas/actions-secret"
|
|
49101
|
-
},
|
|
49102
|
-
"examples": {
|
|
49103
|
-
"default": {
|
|
49104
|
-
"$ref": "#/components/examples/actions-secret"
|
|
49105
|
-
}
|
|
49106
|
-
}
|
|
49107
|
-
}
|
|
49108
|
-
}
|
|
49109
|
-
}
|
|
49110
|
-
},
|
|
49111
|
-
"x-github": {
|
|
49112
|
-
"githubCloudOnly": false,
|
|
49113
|
-
"enabledForGitHubApps": true,
|
|
49114
|
-
"category": "actions",
|
|
49115
|
-
"subcategory": "secrets"
|
|
49116
|
-
},
|
|
49117
|
-
"x-octokit": {}
|
|
49118
|
-
},
|
|
49119
|
-
"put": {
|
|
49120
|
-
"summary": "Create or update an environment secret",
|
|
49121
|
-
"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.8/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.",
|
|
49122
|
-
"tags": [
|
|
49123
|
-
"actions"
|
|
49124
|
-
],
|
|
49125
|
-
"operationId": "actions/create-or-update-environment-secret",
|
|
49126
|
-
"externalDocs": {
|
|
49127
|
-
"description": "API method documentation",
|
|
49128
|
-
"url": "https://docs.github.com/enterprise-server@3.8/rest/actions/secrets#create-or-update-an-environment-secret"
|
|
49129
|
-
},
|
|
49130
|
-
"parameters": [
|
|
49131
|
-
{
|
|
49132
|
-
"$ref": "#/components/parameters/repository-id"
|
|
49133
|
-
},
|
|
49134
|
-
{
|
|
49135
|
-
"$ref": "#/components/parameters/environment-name"
|
|
49136
|
-
},
|
|
49137
|
-
{
|
|
49138
|
-
"$ref": "#/components/parameters/secret-name"
|
|
49139
|
-
}
|
|
49140
|
-
],
|
|
49141
|
-
"requestBody": {
|
|
49142
|
-
"required": true,
|
|
49143
|
-
"content": {
|
|
49144
|
-
"application/json": {
|
|
49145
|
-
"schema": {
|
|
49146
|
-
"type": "object",
|
|
49147
|
-
"properties": {
|
|
49148
|
-
"encrypted_value": {
|
|
49149
|
-
"type": "string",
|
|
49150
|
-
"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.8/rest/actions/secrets#get-an-environment-public-key) endpoint.",
|
|
49151
|
-
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$"
|
|
49152
|
-
},
|
|
49153
|
-
"key_id": {
|
|
49154
|
-
"type": "string",
|
|
49155
|
-
"description": "ID of the key you used to encrypt the secret."
|
|
49156
|
-
}
|
|
49157
|
-
},
|
|
49158
|
-
"required": [
|
|
49159
|
-
"encrypted_value",
|
|
49160
|
-
"key_id"
|
|
49161
|
-
]
|
|
49162
|
-
},
|
|
49163
|
-
"examples": {
|
|
49164
|
-
"default": {
|
|
49165
|
-
"value": {
|
|
49166
|
-
"encrypted_value": "c2VjcmV0",
|
|
49167
|
-
"key_id": "012345678912345678"
|
|
49168
|
-
}
|
|
49169
|
-
}
|
|
49170
|
-
}
|
|
49171
|
-
}
|
|
49172
|
-
}
|
|
49173
|
-
},
|
|
49174
|
-
"responses": {
|
|
49175
|
-
"201": {
|
|
49176
|
-
"description": "Response when creating a secret",
|
|
49177
|
-
"content": {
|
|
49178
|
-
"application/json": {
|
|
49179
|
-
"schema": {
|
|
49180
|
-
"$ref": "#/components/schemas/empty-object"
|
|
49181
|
-
},
|
|
49182
|
-
"examples": {
|
|
49183
|
-
"default": {
|
|
49184
|
-
"value": null
|
|
49185
|
-
}
|
|
49186
|
-
}
|
|
49187
|
-
}
|
|
49188
|
-
}
|
|
49189
|
-
},
|
|
49190
|
-
"204": {
|
|
49191
|
-
"description": "Response when updating a secret"
|
|
49192
|
-
}
|
|
49193
|
-
},
|
|
49194
|
-
"x-github": {
|
|
49195
|
-
"githubCloudOnly": false,
|
|
49196
|
-
"enabledForGitHubApps": true,
|
|
49197
|
-
"category": "actions",
|
|
49198
|
-
"subcategory": "secrets"
|
|
49199
|
-
},
|
|
49200
|
-
"x-octokit": {}
|
|
49201
|
-
},
|
|
49202
|
-
"delete": {
|
|
49203
|
-
"summary": "Delete an environment secret",
|
|
49204
|
-
"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.",
|
|
49205
|
-
"tags": [
|
|
49206
|
-
"actions"
|
|
49207
|
-
],
|
|
49208
|
-
"operationId": "actions/delete-environment-secret",
|
|
49209
|
-
"externalDocs": {
|
|
49210
|
-
"description": "API method documentation",
|
|
49211
|
-
"url": "https://docs.github.com/enterprise-server@3.8/rest/actions/secrets#delete-an-environment-secret"
|
|
49212
|
-
},
|
|
49213
|
-
"parameters": [
|
|
49214
|
-
{
|
|
49215
|
-
"$ref": "#/components/parameters/repository-id"
|
|
49216
|
-
},
|
|
49217
|
-
{
|
|
49218
|
-
"$ref": "#/components/parameters/environment-name"
|
|
49219
|
-
},
|
|
49220
|
-
{
|
|
49221
|
-
"$ref": "#/components/parameters/secret-name"
|
|
49222
|
-
}
|
|
49223
|
-
],
|
|
49224
|
-
"responses": {
|
|
49225
|
-
"204": {
|
|
49226
|
-
"description": "Default response"
|
|
49227
|
-
}
|
|
49228
|
-
},
|
|
49229
|
-
"x-github": {
|
|
49230
|
-
"githubCloudOnly": false,
|
|
49231
|
-
"enabledForGitHubApps": true,
|
|
49232
|
-
"category": "actions",
|
|
49233
|
-
"subcategory": "secrets"
|
|
49234
|
-
},
|
|
49235
|
-
"x-octokit": {}
|
|
49236
|
-
}
|
|
49237
|
-
},
|
|
49238
|
-
"/repositories/{repository_id}/environments/{environment_name}/variables": {
|
|
49239
|
-
"get": {
|
|
49240
|
-
"summary": "List environment variables",
|
|
49241
|
-
"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.",
|
|
49242
|
-
"tags": [
|
|
49243
|
-
"actions"
|
|
49244
|
-
],
|
|
49245
|
-
"operationId": "actions/list-environment-variables",
|
|
49246
|
-
"externalDocs": {
|
|
49247
|
-
"description": "API method documentation",
|
|
49248
|
-
"url": "https://docs.github.com/enterprise-server@3.8/rest/actions/variables#list-environment-variables"
|
|
49249
|
-
},
|
|
49250
|
-
"parameters": [
|
|
49251
|
-
{
|
|
49252
|
-
"$ref": "#/components/parameters/repository-id"
|
|
49253
|
-
},
|
|
49254
|
-
{
|
|
49255
|
-
"$ref": "#/components/parameters/environment-name"
|
|
49256
|
-
},
|
|
49257
|
-
{
|
|
49258
|
-
"$ref": "#/components/parameters/variables-per-page"
|
|
49259
|
-
},
|
|
49260
|
-
{
|
|
49261
|
-
"$ref": "#/components/parameters/page"
|
|
49262
|
-
}
|
|
49263
|
-
],
|
|
49264
|
-
"responses": {
|
|
49265
|
-
"200": {
|
|
49266
|
-
"description": "Response",
|
|
49267
|
-
"content": {
|
|
49268
|
-
"application/json": {
|
|
49269
|
-
"schema": {
|
|
49270
|
-
"type": "object",
|
|
49271
|
-
"required": [
|
|
49272
|
-
"total_count",
|
|
49273
|
-
"variables"
|
|
49274
|
-
],
|
|
49275
|
-
"properties": {
|
|
49276
|
-
"total_count": {
|
|
49277
|
-
"type": "integer"
|
|
49278
|
-
},
|
|
49279
|
-
"variables": {
|
|
49280
|
-
"type": "array",
|
|
49281
|
-
"items": {
|
|
49282
|
-
"$ref": "#/components/schemas/actions-variable"
|
|
49283
|
-
}
|
|
49284
|
-
}
|
|
49285
|
-
}
|
|
49286
|
-
},
|
|
49287
|
-
"examples": {
|
|
49288
|
-
"default": {
|
|
49289
|
-
"$ref": "#/components/examples/actions-variables-paginated"
|
|
49290
|
-
}
|
|
49291
|
-
}
|
|
49292
|
-
}
|
|
49293
|
-
},
|
|
49294
|
-
"headers": {
|
|
49295
|
-
"Link": {
|
|
49296
|
-
"$ref": "#/components/headers/link"
|
|
49297
|
-
}
|
|
49298
|
-
}
|
|
49299
|
-
}
|
|
49300
|
-
},
|
|
49301
|
-
"x-github": {
|
|
49302
|
-
"githubCloudOnly": false,
|
|
49303
|
-
"enabledForGitHubApps": true,
|
|
49304
|
-
"category": "actions",
|
|
49305
|
-
"subcategory": "variables"
|
|
49306
|
-
},
|
|
49307
|
-
"x-octokit": {}
|
|
49308
|
-
},
|
|
49309
|
-
"post": {
|
|
49310
|
-
"summary": "Create an environment variable",
|
|
49311
|
-
"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.",
|
|
49312
|
-
"tags": [
|
|
49313
|
-
"actions"
|
|
49314
|
-
],
|
|
49315
|
-
"operationId": "actions/create-environment-variable",
|
|
49316
|
-
"externalDocs": {
|
|
49317
|
-
"description": "API method documentation",
|
|
49318
|
-
"url": "https://docs.github.com/enterprise-server@3.8/rest/actions/variables#create-an-environment-variable"
|
|
49319
|
-
},
|
|
49320
|
-
"parameters": [
|
|
49321
|
-
{
|
|
49322
|
-
"$ref": "#/components/parameters/repository-id"
|
|
49323
|
-
},
|
|
49324
|
-
{
|
|
49325
|
-
"$ref": "#/components/parameters/environment-name"
|
|
49326
|
-
}
|
|
49327
|
-
],
|
|
49328
|
-
"requestBody": {
|
|
49329
|
-
"required": true,
|
|
49330
|
-
"content": {
|
|
49331
|
-
"application/json": {
|
|
49332
|
-
"schema": {
|
|
49333
|
-
"type": "object",
|
|
49334
|
-
"properties": {
|
|
49335
|
-
"name": {
|
|
49336
|
-
"type": "string",
|
|
49337
|
-
"description": "The name of the variable."
|
|
49338
|
-
},
|
|
49339
|
-
"value": {
|
|
49340
|
-
"type": "string",
|
|
49341
|
-
"description": "The value of the variable."
|
|
49342
|
-
}
|
|
49343
|
-
},
|
|
49344
|
-
"required": [
|
|
49345
|
-
"name",
|
|
49346
|
-
"value"
|
|
49347
|
-
]
|
|
49348
|
-
},
|
|
49349
|
-
"examples": {
|
|
49350
|
-
"default": {
|
|
49351
|
-
"value": {
|
|
49352
|
-
"name": "USERNAME",
|
|
49353
|
-
"value": "octocat"
|
|
49354
|
-
}
|
|
49355
|
-
}
|
|
49356
|
-
}
|
|
49357
|
-
}
|
|
49358
|
-
}
|
|
49359
|
-
},
|
|
49360
|
-
"responses": {
|
|
49361
|
-
"201": {
|
|
49362
|
-
"description": "Response",
|
|
49363
|
-
"content": {
|
|
49364
|
-
"application/json": {
|
|
49365
|
-
"schema": {
|
|
49366
|
-
"$ref": "#/components/schemas/empty-object"
|
|
49367
|
-
},
|
|
49368
|
-
"examples": {
|
|
49369
|
-
"default": {
|
|
49370
|
-
"value": null
|
|
49371
|
-
}
|
|
49372
|
-
}
|
|
49373
|
-
}
|
|
49374
|
-
}
|
|
49375
|
-
}
|
|
49376
|
-
},
|
|
49377
|
-
"x-github": {
|
|
49378
|
-
"githubCloudOnly": false,
|
|
49379
|
-
"enabledForGitHubApps": true,
|
|
49380
|
-
"category": "actions",
|
|
49381
|
-
"subcategory": "variables"
|
|
49382
|
-
},
|
|
49383
|
-
"x-octokit": {}
|
|
49384
|
-
}
|
|
49385
|
-
},
|
|
49386
|
-
"/repositories/{repository_id}/environments/{environment_name}/variables/{name}": {
|
|
49387
|
-
"get": {
|
|
49388
|
-
"summary": "Get an environment variable",
|
|
49389
|
-
"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.",
|
|
49390
|
-
"tags": [
|
|
49391
|
-
"actions"
|
|
49392
|
-
],
|
|
49393
|
-
"operationId": "actions/get-environment-variable",
|
|
49394
|
-
"externalDocs": {
|
|
49395
|
-
"description": "API method documentation",
|
|
49396
|
-
"url": "https://docs.github.com/enterprise-server@3.8/rest/actions/variables#get-an-environment-variable"
|
|
49397
|
-
},
|
|
49398
|
-
"parameters": [
|
|
49399
|
-
{
|
|
49400
|
-
"$ref": "#/components/parameters/repository-id"
|
|
49401
|
-
},
|
|
49402
|
-
{
|
|
49403
|
-
"$ref": "#/components/parameters/environment-name"
|
|
49404
|
-
},
|
|
49405
|
-
{
|
|
49406
|
-
"$ref": "#/components/parameters/variable-name"
|
|
49407
|
-
}
|
|
49408
|
-
],
|
|
49409
|
-
"responses": {
|
|
49410
|
-
"200": {
|
|
49411
|
-
"description": "Response",
|
|
49412
|
-
"content": {
|
|
49413
|
-
"application/json": {
|
|
49414
|
-
"schema": {
|
|
49415
|
-
"$ref": "#/components/schemas/actions-variable"
|
|
49416
|
-
},
|
|
49417
|
-
"examples": {
|
|
49418
|
-
"default": {
|
|
49419
|
-
"$ref": "#/components/examples/actions-variable"
|
|
49420
|
-
}
|
|
49421
|
-
}
|
|
49422
|
-
}
|
|
49423
|
-
}
|
|
49424
|
-
}
|
|
49425
|
-
},
|
|
49426
|
-
"x-github": {
|
|
49427
|
-
"githubCloudOnly": false,
|
|
49428
|
-
"enabledForGitHubApps": true,
|
|
49429
|
-
"category": "actions",
|
|
49430
|
-
"subcategory": "variables"
|
|
49431
|
-
},
|
|
49432
|
-
"x-octokit": {}
|
|
49433
|
-
},
|
|
49434
|
-
"patch": {
|
|
49435
|
-
"summary": "Update an environment variable",
|
|
49436
|
-
"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.",
|
|
49437
|
-
"tags": [
|
|
49438
|
-
"actions"
|
|
49439
|
-
],
|
|
49440
|
-
"operationId": "actions/update-environment-variable",
|
|
49441
|
-
"externalDocs": {
|
|
49442
|
-
"description": "API method documentation",
|
|
49443
|
-
"url": "https://docs.github.com/enterprise-server@3.8/rest/actions/variables#update-an-environment-variable"
|
|
49444
|
-
},
|
|
49445
|
-
"parameters": [
|
|
49446
|
-
{
|
|
49447
|
-
"$ref": "#/components/parameters/repository-id"
|
|
49448
|
-
},
|
|
49449
|
-
{
|
|
49450
|
-
"$ref": "#/components/parameters/variable-name"
|
|
49451
|
-
},
|
|
49452
|
-
{
|
|
49453
|
-
"$ref": "#/components/parameters/environment-name"
|
|
49454
|
-
}
|
|
49455
|
-
],
|
|
49456
|
-
"requestBody": {
|
|
49457
|
-
"required": true,
|
|
49458
|
-
"content": {
|
|
49459
|
-
"application/json": {
|
|
49460
|
-
"schema": {
|
|
49461
|
-
"type": "object",
|
|
49462
|
-
"properties": {
|
|
49463
|
-
"name": {
|
|
49464
|
-
"type": "string",
|
|
49465
|
-
"description": "The name of the variable."
|
|
49466
|
-
},
|
|
49467
|
-
"value": {
|
|
49468
|
-
"type": "string",
|
|
49469
|
-
"description": "The value of the variable."
|
|
49470
|
-
}
|
|
49471
|
-
}
|
|
49472
|
-
},
|
|
49473
|
-
"examples": {
|
|
49474
|
-
"default": {
|
|
49475
|
-
"value": {
|
|
49476
|
-
"name": "USERNAME",
|
|
49477
|
-
"value": "octocat"
|
|
49478
|
-
}
|
|
49479
|
-
}
|
|
49480
|
-
}
|
|
49481
|
-
}
|
|
49482
|
-
}
|
|
49483
|
-
},
|
|
49484
|
-
"responses": {
|
|
49485
|
-
"204": {
|
|
49486
|
-
"description": "Response"
|
|
49487
|
-
}
|
|
49488
|
-
},
|
|
49489
|
-
"x-github": {
|
|
49490
|
-
"githubCloudOnly": false,
|
|
49491
|
-
"enabledForGitHubApps": true,
|
|
49492
|
-
"category": "actions",
|
|
49493
|
-
"subcategory": "variables"
|
|
49494
|
-
},
|
|
49495
|
-
"x-octokit": {}
|
|
49496
|
-
},
|
|
49497
|
-
"delete": {
|
|
49498
|
-
"summary": "Delete an environment variable",
|
|
49499
|
-
"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.",
|
|
49500
|
-
"tags": [
|
|
49501
|
-
"actions"
|
|
49502
|
-
],
|
|
49503
|
-
"operationId": "actions/delete-environment-variable",
|
|
49504
|
-
"externalDocs": {
|
|
49505
|
-
"description": "API method documentation",
|
|
49506
|
-
"url": "https://docs.github.com/enterprise-server@3.8/rest/actions/variables#delete-an-environment-variable"
|
|
49507
|
-
},
|
|
49508
|
-
"parameters": [
|
|
49509
|
-
{
|
|
49510
|
-
"$ref": "#/components/parameters/repository-id"
|
|
49511
|
-
},
|
|
49512
|
-
{
|
|
49513
|
-
"$ref": "#/components/parameters/variable-name"
|
|
49514
|
-
},
|
|
49515
|
-
{
|
|
49516
|
-
"$ref": "#/components/parameters/environment-name"
|
|
49517
|
-
}
|
|
49518
|
-
],
|
|
49519
|
-
"responses": {
|
|
49520
|
-
"204": {
|
|
49521
|
-
"description": "Response"
|
|
49522
|
-
}
|
|
49523
|
-
},
|
|
49524
|
-
"x-github": {
|
|
49525
|
-
"githubCloudOnly": false,
|
|
49526
|
-
"enabledForGitHubApps": true,
|
|
49527
|
-
"category": "actions",
|
|
49528
|
-
"subcategory": "variables"
|
|
49529
|
-
},
|
|
49530
|
-
"x-octokit": {}
|
|
49531
|
-
}
|
|
49532
|
-
},
|
|
49533
|
-
"/scim/v2/Groups": {
|
|
49603
|
+
"/scim/v2/enterprises/{enterprise}/Groups": {
|
|
49534
49604
|
"get": {
|
|
49535
49605
|
"summary": "List provisioned SCIM groups for an enterprise",
|
|
49536
49606
|
"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.",
|
|
@@ -49569,6 +49639,9 @@
|
|
|
49569
49639
|
},
|
|
49570
49640
|
{
|
|
49571
49641
|
"$ref": "#/components/parameters/count"
|
|
49642
|
+
},
|
|
49643
|
+
{
|
|
49644
|
+
"$ref": "#/components/parameters/enterprise"
|
|
49572
49645
|
}
|
|
49573
49646
|
],
|
|
49574
49647
|
"responses": {
|
|
@@ -49622,6 +49695,11 @@
|
|
|
49622
49695
|
"description": "API method documentation",
|
|
49623
49696
|
"url": "https://docs.github.com/enterprise-server@3.8/rest/enterprise-admin/scim#provision-a-scim-enterprise-group"
|
|
49624
49697
|
},
|
|
49698
|
+
"parameters": [
|
|
49699
|
+
{
|
|
49700
|
+
"$ref": "#/components/parameters/enterprise"
|
|
49701
|
+
}
|
|
49702
|
+
],
|
|
49625
49703
|
"requestBody": {
|
|
49626
49704
|
"required": true,
|
|
49627
49705
|
"content": {
|
|
@@ -49687,7 +49765,7 @@
|
|
|
49687
49765
|
"x-octokit": {}
|
|
49688
49766
|
}
|
|
49689
49767
|
},
|
|
49690
|
-
"/scim/v2/Groups/{scim_group_id}": {
|
|
49768
|
+
"/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}": {
|
|
49691
49769
|
"get": {
|
|
49692
49770
|
"summary": "Get SCIM provisioning information for an enterprise group",
|
|
49693
49771
|
"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.",
|
|
@@ -49705,6 +49783,9 @@
|
|
|
49705
49783
|
},
|
|
49706
49784
|
{
|
|
49707
49785
|
"$ref": "#/components/parameters/excluded-attributes"
|
|
49786
|
+
},
|
|
49787
|
+
{
|
|
49788
|
+
"$ref": "#/components/parameters/enterprise"
|
|
49708
49789
|
}
|
|
49709
49790
|
],
|
|
49710
49791
|
"responses": {
|
|
@@ -49764,6 +49845,9 @@
|
|
|
49764
49845
|
"parameters": [
|
|
49765
49846
|
{
|
|
49766
49847
|
"$ref": "#/components/parameters/scim-group-id"
|
|
49848
|
+
},
|
|
49849
|
+
{
|
|
49850
|
+
"$ref": "#/components/parameters/enterprise"
|
|
49767
49851
|
}
|
|
49768
49852
|
],
|
|
49769
49853
|
"requestBody": {
|
|
@@ -49871,6 +49955,9 @@
|
|
|
49871
49955
|
"parameters": [
|
|
49872
49956
|
{
|
|
49873
49957
|
"$ref": "#/components/parameters/scim-group-id"
|
|
49958
|
+
},
|
|
49959
|
+
{
|
|
49960
|
+
"$ref": "#/components/parameters/enterprise"
|
|
49874
49961
|
}
|
|
49875
49962
|
],
|
|
49876
49963
|
"requestBody": {
|
|
@@ -49988,6 +50075,9 @@
|
|
|
49988
50075
|
"parameters": [
|
|
49989
50076
|
{
|
|
49990
50077
|
"$ref": "#/components/parameters/scim-group-id"
|
|
50078
|
+
},
|
|
50079
|
+
{
|
|
50080
|
+
"$ref": "#/components/parameters/enterprise"
|
|
49991
50081
|
}
|
|
49992
50082
|
],
|
|
49993
50083
|
"responses": {
|
|
@@ -50022,7 +50112,7 @@
|
|
|
50022
50112
|
"x-octokit": {}
|
|
50023
50113
|
}
|
|
50024
50114
|
},
|
|
50025
|
-
"/scim/v2/Users": {
|
|
50115
|
+
"/scim/v2/enterprises/{enterprise}/Users": {
|
|
50026
50116
|
"get": {
|
|
50027
50117
|
"summary": "List SCIM provisioned identities for an enterprise",
|
|
50028
50118
|
"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.",
|
|
@@ -50057,6 +50147,9 @@
|
|
|
50057
50147
|
},
|
|
50058
50148
|
{
|
|
50059
50149
|
"$ref": "#/components/parameters/count"
|
|
50150
|
+
},
|
|
50151
|
+
{
|
|
50152
|
+
"$ref": "#/components/parameters/enterprise"
|
|
50060
50153
|
}
|
|
50061
50154
|
],
|
|
50062
50155
|
"responses": {
|
|
@@ -50110,6 +50203,11 @@
|
|
|
50110
50203
|
"description": "API method documentation",
|
|
50111
50204
|
"url": "https://docs.github.com/enterprise-server@3.8/rest/enterprise-admin/scim#provision-a-scim-enterprise-user"
|
|
50112
50205
|
},
|
|
50206
|
+
"parameters": [
|
|
50207
|
+
{
|
|
50208
|
+
"$ref": "#/components/parameters/enterprise"
|
|
50209
|
+
}
|
|
50210
|
+
],
|
|
50113
50211
|
"requestBody": {
|
|
50114
50212
|
"required": true,
|
|
50115
50213
|
"content": {
|
|
@@ -50175,7 +50273,7 @@
|
|
|
50175
50273
|
"x-octokit": {}
|
|
50176
50274
|
}
|
|
50177
50275
|
},
|
|
50178
|
-
"/scim/v2/Users/{scim_user_id}": {
|
|
50276
|
+
"/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}": {
|
|
50179
50277
|
"get": {
|
|
50180
50278
|
"summary": "Get SCIM provisioning information for an enterprise user",
|
|
50181
50279
|
"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.",
|
|
@@ -50190,6 +50288,9 @@
|
|
|
50190
50288
|
"parameters": [
|
|
50191
50289
|
{
|
|
50192
50290
|
"$ref": "#/components/parameters/scim-user-id"
|
|
50291
|
+
},
|
|
50292
|
+
{
|
|
50293
|
+
"$ref": "#/components/parameters/enterprise"
|
|
50193
50294
|
}
|
|
50194
50295
|
],
|
|
50195
50296
|
"responses": {
|
|
@@ -50249,6 +50350,9 @@
|
|
|
50249
50350
|
"parameters": [
|
|
50250
50351
|
{
|
|
50251
50352
|
"$ref": "#/components/parameters/scim-user-id"
|
|
50353
|
+
},
|
|
50354
|
+
{
|
|
50355
|
+
"$ref": "#/components/parameters/enterprise"
|
|
50252
50356
|
}
|
|
50253
50357
|
],
|
|
50254
50358
|
"requestBody": {
|
|
@@ -50326,6 +50430,9 @@
|
|
|
50326
50430
|
"parameters": [
|
|
50327
50431
|
{
|
|
50328
50432
|
"$ref": "#/components/parameters/scim-user-id"
|
|
50433
|
+
},
|
|
50434
|
+
{
|
|
50435
|
+
"$ref": "#/components/parameters/enterprise"
|
|
50329
50436
|
}
|
|
50330
50437
|
],
|
|
50331
50438
|
"requestBody": {
|
|
@@ -50461,6 +50568,9 @@
|
|
|
50461
50568
|
"parameters": [
|
|
50462
50569
|
{
|
|
50463
50570
|
"$ref": "#/components/parameters/scim-user-id"
|
|
50571
|
+
},
|
|
50572
|
+
{
|
|
50573
|
+
"$ref": "#/components/parameters/enterprise"
|
|
50464
50574
|
}
|
|
50465
50575
|
],
|
|
50466
50576
|
"responses": {
|
|
@@ -58117,7 +58227,7 @@
|
|
|
58117
58227
|
"/users/{username}/hovercard": {
|
|
58118
58228
|
"get": {
|
|
58119
58229
|
"summary": "Get contextual information for a user",
|
|
58120
|
-
"description": "Provides hovercard information. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations.\n\
|
|
58230
|
+
"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.",
|
|
58121
58231
|
"tags": [
|
|
58122
58232
|
"users"
|
|
58123
58233
|
],
|
|
@@ -94137,7 +94247,9 @@
|
|
|
94137
94247
|
"queued",
|
|
94138
94248
|
"in_progress",
|
|
94139
94249
|
"completed",
|
|
94140
|
-
"waiting"
|
|
94250
|
+
"waiting",
|
|
94251
|
+
"requested",
|
|
94252
|
+
"pending"
|
|
94141
94253
|
]
|
|
94142
94254
|
},
|
|
94143
94255
|
"conclusion": {
|
|
@@ -96535,13 +96647,16 @@
|
|
|
96535
96647
|
"nullable": true
|
|
96536
96648
|
},
|
|
96537
96649
|
"status": {
|
|
96538
|
-
"description": "The phase of the lifecycle that the check is currently in.",
|
|
96650
|
+
"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.",
|
|
96539
96651
|
"example": "queued",
|
|
96540
96652
|
"type": "string",
|
|
96541
96653
|
"enum": [
|
|
96542
96654
|
"queued",
|
|
96543
96655
|
"in_progress",
|
|
96544
|
-
"completed"
|
|
96656
|
+
"completed",
|
|
96657
|
+
"waiting",
|
|
96658
|
+
"requested",
|
|
96659
|
+
"pending"
|
|
96545
96660
|
]
|
|
96546
96661
|
},
|
|
96547
96662
|
"conclusion": {
|
|
@@ -96819,11 +96934,15 @@
|
|
|
96819
96934
|
},
|
|
96820
96935
|
"status": {
|
|
96821
96936
|
"type": "string",
|
|
96937
|
+
"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.",
|
|
96822
96938
|
"example": "completed",
|
|
96823
96939
|
"enum": [
|
|
96824
96940
|
"queued",
|
|
96825
96941
|
"in_progress",
|
|
96826
|
-
"completed"
|
|
96942
|
+
"completed",
|
|
96943
|
+
"waiting",
|
|
96944
|
+
"requested",
|
|
96945
|
+
"pending"
|
|
96827
96946
|
],
|
|
96828
96947
|
"nullable": true
|
|
96829
96948
|
},
|
|
@@ -160086,6 +160205,7 @@
|
|
|
160086
160205
|
"type": "object",
|
|
160087
160206
|
"properties": {
|
|
160088
160207
|
"permission": {
|
|
160208
|
+
"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.",
|
|
160089
160209
|
"type": "object",
|
|
160090
160210
|
"properties": {
|
|
160091
160211
|
"to": {
|
|
@@ -160100,6 +160220,18 @@
|
|
|
160100
160220
|
"required": [
|
|
160101
160221
|
"to"
|
|
160102
160222
|
]
|
|
160223
|
+
},
|
|
160224
|
+
"role_name": {
|
|
160225
|
+
"description": "The role assigned to the collaborator.",
|
|
160226
|
+
"type": "object",
|
|
160227
|
+
"properties": {
|
|
160228
|
+
"to": {
|
|
160229
|
+
"type": "string"
|
|
160230
|
+
}
|
|
160231
|
+
},
|
|
160232
|
+
"required": [
|
|
160233
|
+
"to"
|
|
160234
|
+
]
|
|
160103
160235
|
}
|
|
160104
160236
|
}
|
|
160105
160237
|
},
|
|
@@ -238286,7 +238418,7 @@
|
|
|
238286
238418
|
"type": "string"
|
|
238287
238419
|
},
|
|
238288
238420
|
"commits": {
|
|
238289
|
-
"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
|
|
238421
|
+
"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.8/rest/commits) to fetch additional commits.",
|
|
238290
238422
|
"type": "array",
|
|
238291
238423
|
"items": {
|
|
238292
238424
|
"title": "Commit",
|
|
@@ -286199,7 +286331,7 @@
|
|
|
286199
286331
|
},
|
|
286200
286332
|
"workflow-run-status": {
|
|
286201
286333
|
"name": "status",
|
|
286202
|
-
"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`.",
|
|
286334
|
+
"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`.",
|
|
286203
286335
|
"in": "query",
|
|
286204
286336
|
"required": false,
|
|
286205
286337
|
"schema": {
|
|
@@ -286444,6 +286576,17 @@
|
|
|
286444
286576
|
"type": "integer"
|
|
286445
286577
|
}
|
|
286446
286578
|
},
|
|
286579
|
+
"git-ref-only": {
|
|
286580
|
+
"name": "ref",
|
|
286581
|
+
"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.",
|
|
286582
|
+
"in": "path",
|
|
286583
|
+
"required": true,
|
|
286584
|
+
"example": "heads/feature-a",
|
|
286585
|
+
"schema": {
|
|
286586
|
+
"type": "string"
|
|
286587
|
+
},
|
|
286588
|
+
"x-multi-segment": true
|
|
286589
|
+
},
|
|
286447
286590
|
"invitation-id": {
|
|
286448
286591
|
"name": "invitation_id",
|
|
286449
286592
|
"description": "The unique identifier of the invitation.",
|