@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.11.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": {
|
|
@@ -8770,7 +8770,7 @@
|
|
|
8770
8770
|
"/feeds": {
|
|
8771
8771
|
"get": {
|
|
8772
8772
|
"summary": "Get feeds",
|
|
8773
|
-
"description": "
|
|
8773
|
+
"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.11/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.11/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.11/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens.",
|
|
8774
8774
|
"tags": [
|
|
8775
8775
|
"activity"
|
|
8776
8776
|
],
|
|
@@ -11642,7 +11642,7 @@
|
|
|
11642
11642
|
"/organizations": {
|
|
11643
11643
|
"get": {
|
|
11644
11644
|
"summary": "List organizations",
|
|
11645
|
-
"description": "Lists all organizations, in the order that they were created
|
|
11645
|
+
"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.11/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations.",
|
|
11646
11646
|
"tags": [
|
|
11647
11647
|
"orgs"
|
|
11648
11648
|
],
|
|
@@ -33601,11 +33601,14 @@
|
|
|
33601
33601
|
},
|
|
33602
33602
|
"status": {
|
|
33603
33603
|
"type": "string",
|
|
33604
|
-
"description": "The current status.",
|
|
33604
|
+
"description": "The current status of the check run. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`.",
|
|
33605
33605
|
"enum": [
|
|
33606
33606
|
"queued",
|
|
33607
33607
|
"in_progress",
|
|
33608
|
-
"completed"
|
|
33608
|
+
"completed",
|
|
33609
|
+
"waiting",
|
|
33610
|
+
"requested",
|
|
33611
|
+
"pending"
|
|
33609
33612
|
]
|
|
33610
33613
|
},
|
|
33611
33614
|
"conclusion": {
|
|
@@ -36260,6 +36263,9 @@
|
|
|
36260
36263
|
}
|
|
36261
36264
|
}
|
|
36262
36265
|
},
|
|
36266
|
+
"409": {
|
|
36267
|
+
"$ref": "#/components/responses/conflict"
|
|
36268
|
+
},
|
|
36263
36269
|
"422": {
|
|
36264
36270
|
"$ref": "#/components/responses/validation_failed"
|
|
36265
36271
|
}
|
|
@@ -36491,6 +36497,9 @@
|
|
|
36491
36497
|
"$ref": "#/components/headers/link"
|
|
36492
36498
|
}
|
|
36493
36499
|
}
|
|
36500
|
+
},
|
|
36501
|
+
"409": {
|
|
36502
|
+
"$ref": "#/components/responses/conflict"
|
|
36494
36503
|
}
|
|
36495
36504
|
},
|
|
36496
36505
|
"x-github": {
|
|
@@ -36550,6 +36559,9 @@
|
|
|
36550
36559
|
"404": {
|
|
36551
36560
|
"$ref": "#/components/responses/not_found"
|
|
36552
36561
|
},
|
|
36562
|
+
"409": {
|
|
36563
|
+
"$ref": "#/components/responses/conflict"
|
|
36564
|
+
},
|
|
36553
36565
|
"422": {
|
|
36554
36566
|
"$ref": "#/components/responses/validation_failed"
|
|
36555
36567
|
},
|
|
@@ -36887,7 +36899,7 @@
|
|
|
36887
36899
|
"/repos/{owner}/{repo}/compare/{basehead}": {
|
|
36888
36900
|
"get": {
|
|
36889
36901
|
"summary": "Compare two commits",
|
|
36890
|
-
"description": "Compares two commits against one another. You can compare branches in the same repository, or you can compare
|
|
36902
|
+
"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.11/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.11/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.11/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. |",
|
|
36891
36903
|
"tags": [
|
|
36892
36904
|
"repos"
|
|
36893
36905
|
],
|
|
@@ -39817,6 +39829,616 @@
|
|
|
39817
39829
|
"x-octokit": {}
|
|
39818
39830
|
}
|
|
39819
39831
|
},
|
|
39832
|
+
"/repos/{owner}/{repo}/environments/{environment_name}/secrets": {
|
|
39833
|
+
"get": {
|
|
39834
|
+
"summary": "List environment secrets",
|
|
39835
|
+
"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.",
|
|
39836
|
+
"tags": [
|
|
39837
|
+
"actions"
|
|
39838
|
+
],
|
|
39839
|
+
"operationId": "actions/list-environment-secrets",
|
|
39840
|
+
"externalDocs": {
|
|
39841
|
+
"description": "API method documentation",
|
|
39842
|
+
"url": "https://docs.github.com/enterprise-server@3.11/rest/actions/secrets#list-environment-secrets"
|
|
39843
|
+
},
|
|
39844
|
+
"parameters": [
|
|
39845
|
+
{
|
|
39846
|
+
"$ref": "#/components/parameters/owner"
|
|
39847
|
+
},
|
|
39848
|
+
{
|
|
39849
|
+
"$ref": "#/components/parameters/repo"
|
|
39850
|
+
},
|
|
39851
|
+
{
|
|
39852
|
+
"$ref": "#/components/parameters/environment-name"
|
|
39853
|
+
},
|
|
39854
|
+
{
|
|
39855
|
+
"$ref": "#/components/parameters/per-page"
|
|
39856
|
+
},
|
|
39857
|
+
{
|
|
39858
|
+
"$ref": "#/components/parameters/page"
|
|
39859
|
+
}
|
|
39860
|
+
],
|
|
39861
|
+
"responses": {
|
|
39862
|
+
"200": {
|
|
39863
|
+
"description": "Response",
|
|
39864
|
+
"content": {
|
|
39865
|
+
"application/json": {
|
|
39866
|
+
"schema": {
|
|
39867
|
+
"type": "object",
|
|
39868
|
+
"required": [
|
|
39869
|
+
"total_count",
|
|
39870
|
+
"secrets"
|
|
39871
|
+
],
|
|
39872
|
+
"properties": {
|
|
39873
|
+
"total_count": {
|
|
39874
|
+
"type": "integer"
|
|
39875
|
+
},
|
|
39876
|
+
"secrets": {
|
|
39877
|
+
"type": "array",
|
|
39878
|
+
"items": {
|
|
39879
|
+
"$ref": "#/components/schemas/actions-secret"
|
|
39880
|
+
}
|
|
39881
|
+
}
|
|
39882
|
+
}
|
|
39883
|
+
},
|
|
39884
|
+
"examples": {
|
|
39885
|
+
"default": {
|
|
39886
|
+
"$ref": "#/components/examples/actions-secret-paginated"
|
|
39887
|
+
}
|
|
39888
|
+
}
|
|
39889
|
+
}
|
|
39890
|
+
},
|
|
39891
|
+
"headers": {
|
|
39892
|
+
"Link": {
|
|
39893
|
+
"$ref": "#/components/headers/link"
|
|
39894
|
+
}
|
|
39895
|
+
}
|
|
39896
|
+
}
|
|
39897
|
+
},
|
|
39898
|
+
"x-github": {
|
|
39899
|
+
"githubCloudOnly": false,
|
|
39900
|
+
"enabledForGitHubApps": true,
|
|
39901
|
+
"category": "actions",
|
|
39902
|
+
"subcategory": "secrets"
|
|
39903
|
+
},
|
|
39904
|
+
"x-octokit": {}
|
|
39905
|
+
}
|
|
39906
|
+
},
|
|
39907
|
+
"/repos/{owner}/{repo}/environments/{environment_name}/secrets/public-key": {
|
|
39908
|
+
"get": {
|
|
39909
|
+
"summary": "Get an environment public key",
|
|
39910
|
+
"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.",
|
|
39911
|
+
"tags": [
|
|
39912
|
+
"actions"
|
|
39913
|
+
],
|
|
39914
|
+
"operationId": "actions/get-environment-public-key",
|
|
39915
|
+
"externalDocs": {
|
|
39916
|
+
"description": "API method documentation",
|
|
39917
|
+
"url": "https://docs.github.com/enterprise-server@3.11/rest/actions/secrets#get-an-environment-public-key"
|
|
39918
|
+
},
|
|
39919
|
+
"parameters": [
|
|
39920
|
+
{
|
|
39921
|
+
"$ref": "#/components/parameters/owner"
|
|
39922
|
+
},
|
|
39923
|
+
{
|
|
39924
|
+
"$ref": "#/components/parameters/repo"
|
|
39925
|
+
},
|
|
39926
|
+
{
|
|
39927
|
+
"$ref": "#/components/parameters/environment-name"
|
|
39928
|
+
}
|
|
39929
|
+
],
|
|
39930
|
+
"responses": {
|
|
39931
|
+
"200": {
|
|
39932
|
+
"description": "Response",
|
|
39933
|
+
"content": {
|
|
39934
|
+
"application/json": {
|
|
39935
|
+
"schema": {
|
|
39936
|
+
"$ref": "#/components/schemas/actions-public-key"
|
|
39937
|
+
},
|
|
39938
|
+
"examples": {
|
|
39939
|
+
"default": {
|
|
39940
|
+
"$ref": "#/components/examples/actions-public-key"
|
|
39941
|
+
}
|
|
39942
|
+
}
|
|
39943
|
+
}
|
|
39944
|
+
}
|
|
39945
|
+
}
|
|
39946
|
+
},
|
|
39947
|
+
"x-github": {
|
|
39948
|
+
"githubCloudOnly": false,
|
|
39949
|
+
"enabledForGitHubApps": true,
|
|
39950
|
+
"category": "actions",
|
|
39951
|
+
"subcategory": "secrets"
|
|
39952
|
+
},
|
|
39953
|
+
"x-octokit": {}
|
|
39954
|
+
}
|
|
39955
|
+
},
|
|
39956
|
+
"/repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}": {
|
|
39957
|
+
"get": {
|
|
39958
|
+
"summary": "Get an environment secret",
|
|
39959
|
+
"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.",
|
|
39960
|
+
"tags": [
|
|
39961
|
+
"actions"
|
|
39962
|
+
],
|
|
39963
|
+
"operationId": "actions/get-environment-secret",
|
|
39964
|
+
"externalDocs": {
|
|
39965
|
+
"description": "API method documentation",
|
|
39966
|
+
"url": "https://docs.github.com/enterprise-server@3.11/rest/actions/secrets#get-an-environment-secret"
|
|
39967
|
+
},
|
|
39968
|
+
"parameters": [
|
|
39969
|
+
{
|
|
39970
|
+
"$ref": "#/components/parameters/owner"
|
|
39971
|
+
},
|
|
39972
|
+
{
|
|
39973
|
+
"$ref": "#/components/parameters/repo"
|
|
39974
|
+
},
|
|
39975
|
+
{
|
|
39976
|
+
"$ref": "#/components/parameters/environment-name"
|
|
39977
|
+
},
|
|
39978
|
+
{
|
|
39979
|
+
"$ref": "#/components/parameters/secret-name"
|
|
39980
|
+
}
|
|
39981
|
+
],
|
|
39982
|
+
"responses": {
|
|
39983
|
+
"200": {
|
|
39984
|
+
"description": "Response",
|
|
39985
|
+
"content": {
|
|
39986
|
+
"application/json": {
|
|
39987
|
+
"schema": {
|
|
39988
|
+
"$ref": "#/components/schemas/actions-secret"
|
|
39989
|
+
},
|
|
39990
|
+
"examples": {
|
|
39991
|
+
"default": {
|
|
39992
|
+
"$ref": "#/components/examples/actions-secret"
|
|
39993
|
+
}
|
|
39994
|
+
}
|
|
39995
|
+
}
|
|
39996
|
+
}
|
|
39997
|
+
}
|
|
39998
|
+
},
|
|
39999
|
+
"x-github": {
|
|
40000
|
+
"githubCloudOnly": false,
|
|
40001
|
+
"enabledForGitHubApps": true,
|
|
40002
|
+
"category": "actions",
|
|
40003
|
+
"subcategory": "secrets"
|
|
40004
|
+
},
|
|
40005
|
+
"x-octokit": {}
|
|
40006
|
+
},
|
|
40007
|
+
"put": {
|
|
40008
|
+
"summary": "Create or update an environment secret",
|
|
40009
|
+
"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.11/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.",
|
|
40010
|
+
"tags": [
|
|
40011
|
+
"actions"
|
|
40012
|
+
],
|
|
40013
|
+
"operationId": "actions/create-or-update-environment-secret",
|
|
40014
|
+
"externalDocs": {
|
|
40015
|
+
"description": "API method documentation",
|
|
40016
|
+
"url": "https://docs.github.com/enterprise-server@3.11/rest/actions/secrets#create-or-update-an-environment-secret"
|
|
40017
|
+
},
|
|
40018
|
+
"parameters": [
|
|
40019
|
+
{
|
|
40020
|
+
"$ref": "#/components/parameters/owner"
|
|
40021
|
+
},
|
|
40022
|
+
{
|
|
40023
|
+
"$ref": "#/components/parameters/repo"
|
|
40024
|
+
},
|
|
40025
|
+
{
|
|
40026
|
+
"$ref": "#/components/parameters/environment-name"
|
|
40027
|
+
},
|
|
40028
|
+
{
|
|
40029
|
+
"$ref": "#/components/parameters/secret-name"
|
|
40030
|
+
}
|
|
40031
|
+
],
|
|
40032
|
+
"requestBody": {
|
|
40033
|
+
"required": true,
|
|
40034
|
+
"content": {
|
|
40035
|
+
"application/json": {
|
|
40036
|
+
"schema": {
|
|
40037
|
+
"type": "object",
|
|
40038
|
+
"properties": {
|
|
40039
|
+
"encrypted_value": {
|
|
40040
|
+
"type": "string",
|
|
40041
|
+
"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.11/rest/actions/secrets#get-an-environment-public-key) endpoint.",
|
|
40042
|
+
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$"
|
|
40043
|
+
},
|
|
40044
|
+
"key_id": {
|
|
40045
|
+
"type": "string",
|
|
40046
|
+
"description": "ID of the key you used to encrypt the secret."
|
|
40047
|
+
}
|
|
40048
|
+
},
|
|
40049
|
+
"required": [
|
|
40050
|
+
"encrypted_value",
|
|
40051
|
+
"key_id"
|
|
40052
|
+
]
|
|
40053
|
+
},
|
|
40054
|
+
"examples": {
|
|
40055
|
+
"default": {
|
|
40056
|
+
"value": {
|
|
40057
|
+
"encrypted_value": "c2VjcmV0",
|
|
40058
|
+
"key_id": "012345678912345678"
|
|
40059
|
+
}
|
|
40060
|
+
}
|
|
40061
|
+
}
|
|
40062
|
+
}
|
|
40063
|
+
}
|
|
40064
|
+
},
|
|
40065
|
+
"responses": {
|
|
40066
|
+
"201": {
|
|
40067
|
+
"description": "Response when creating a secret",
|
|
40068
|
+
"content": {
|
|
40069
|
+
"application/json": {
|
|
40070
|
+
"schema": {
|
|
40071
|
+
"$ref": "#/components/schemas/empty-object"
|
|
40072
|
+
},
|
|
40073
|
+
"examples": {
|
|
40074
|
+
"default": {
|
|
40075
|
+
"value": null
|
|
40076
|
+
}
|
|
40077
|
+
}
|
|
40078
|
+
}
|
|
40079
|
+
}
|
|
40080
|
+
},
|
|
40081
|
+
"204": {
|
|
40082
|
+
"description": "Response when updating a secret"
|
|
40083
|
+
}
|
|
40084
|
+
},
|
|
40085
|
+
"x-github": {
|
|
40086
|
+
"githubCloudOnly": false,
|
|
40087
|
+
"enabledForGitHubApps": true,
|
|
40088
|
+
"category": "actions",
|
|
40089
|
+
"subcategory": "secrets"
|
|
40090
|
+
},
|
|
40091
|
+
"x-octokit": {}
|
|
40092
|
+
},
|
|
40093
|
+
"delete": {
|
|
40094
|
+
"summary": "Delete an environment secret",
|
|
40095
|
+
"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.",
|
|
40096
|
+
"tags": [
|
|
40097
|
+
"actions"
|
|
40098
|
+
],
|
|
40099
|
+
"operationId": "actions/delete-environment-secret",
|
|
40100
|
+
"externalDocs": {
|
|
40101
|
+
"description": "API method documentation",
|
|
40102
|
+
"url": "https://docs.github.com/enterprise-server@3.11/rest/actions/secrets#delete-an-environment-secret"
|
|
40103
|
+
},
|
|
40104
|
+
"parameters": [
|
|
40105
|
+
{
|
|
40106
|
+
"$ref": "#/components/parameters/owner"
|
|
40107
|
+
},
|
|
40108
|
+
{
|
|
40109
|
+
"$ref": "#/components/parameters/repo"
|
|
40110
|
+
},
|
|
40111
|
+
{
|
|
40112
|
+
"$ref": "#/components/parameters/environment-name"
|
|
40113
|
+
},
|
|
40114
|
+
{
|
|
40115
|
+
"$ref": "#/components/parameters/secret-name"
|
|
40116
|
+
}
|
|
40117
|
+
],
|
|
40118
|
+
"responses": {
|
|
40119
|
+
"204": {
|
|
40120
|
+
"description": "Default response"
|
|
40121
|
+
}
|
|
40122
|
+
},
|
|
40123
|
+
"x-github": {
|
|
40124
|
+
"githubCloudOnly": false,
|
|
40125
|
+
"enabledForGitHubApps": true,
|
|
40126
|
+
"category": "actions",
|
|
40127
|
+
"subcategory": "secrets"
|
|
40128
|
+
},
|
|
40129
|
+
"x-octokit": {}
|
|
40130
|
+
}
|
|
40131
|
+
},
|
|
40132
|
+
"/repos/{owner}/{repo}/environments/{environment_name}/variables": {
|
|
40133
|
+
"get": {
|
|
40134
|
+
"summary": "List environment variables",
|
|
40135
|
+
"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.",
|
|
40136
|
+
"tags": [
|
|
40137
|
+
"actions"
|
|
40138
|
+
],
|
|
40139
|
+
"operationId": "actions/list-environment-variables",
|
|
40140
|
+
"externalDocs": {
|
|
40141
|
+
"description": "API method documentation",
|
|
40142
|
+
"url": "https://docs.github.com/enterprise-server@3.11/rest/actions/variables#list-environment-variables"
|
|
40143
|
+
},
|
|
40144
|
+
"parameters": [
|
|
40145
|
+
{
|
|
40146
|
+
"$ref": "#/components/parameters/owner"
|
|
40147
|
+
},
|
|
40148
|
+
{
|
|
40149
|
+
"$ref": "#/components/parameters/repo"
|
|
40150
|
+
},
|
|
40151
|
+
{
|
|
40152
|
+
"$ref": "#/components/parameters/environment-name"
|
|
40153
|
+
},
|
|
40154
|
+
{
|
|
40155
|
+
"$ref": "#/components/parameters/variables-per-page"
|
|
40156
|
+
},
|
|
40157
|
+
{
|
|
40158
|
+
"$ref": "#/components/parameters/page"
|
|
40159
|
+
}
|
|
40160
|
+
],
|
|
40161
|
+
"responses": {
|
|
40162
|
+
"200": {
|
|
40163
|
+
"description": "Response",
|
|
40164
|
+
"content": {
|
|
40165
|
+
"application/json": {
|
|
40166
|
+
"schema": {
|
|
40167
|
+
"type": "object",
|
|
40168
|
+
"required": [
|
|
40169
|
+
"total_count",
|
|
40170
|
+
"variables"
|
|
40171
|
+
],
|
|
40172
|
+
"properties": {
|
|
40173
|
+
"total_count": {
|
|
40174
|
+
"type": "integer"
|
|
40175
|
+
},
|
|
40176
|
+
"variables": {
|
|
40177
|
+
"type": "array",
|
|
40178
|
+
"items": {
|
|
40179
|
+
"$ref": "#/components/schemas/actions-variable"
|
|
40180
|
+
}
|
|
40181
|
+
}
|
|
40182
|
+
}
|
|
40183
|
+
},
|
|
40184
|
+
"examples": {
|
|
40185
|
+
"default": {
|
|
40186
|
+
"$ref": "#/components/examples/actions-variables-paginated"
|
|
40187
|
+
}
|
|
40188
|
+
}
|
|
40189
|
+
}
|
|
40190
|
+
},
|
|
40191
|
+
"headers": {
|
|
40192
|
+
"Link": {
|
|
40193
|
+
"$ref": "#/components/headers/link"
|
|
40194
|
+
}
|
|
40195
|
+
}
|
|
40196
|
+
}
|
|
40197
|
+
},
|
|
40198
|
+
"x-github": {
|
|
40199
|
+
"githubCloudOnly": false,
|
|
40200
|
+
"enabledForGitHubApps": true,
|
|
40201
|
+
"category": "actions",
|
|
40202
|
+
"subcategory": "variables"
|
|
40203
|
+
},
|
|
40204
|
+
"x-octokit": {}
|
|
40205
|
+
},
|
|
40206
|
+
"post": {
|
|
40207
|
+
"summary": "Create an environment variable",
|
|
40208
|
+
"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.",
|
|
40209
|
+
"tags": [
|
|
40210
|
+
"actions"
|
|
40211
|
+
],
|
|
40212
|
+
"operationId": "actions/create-environment-variable",
|
|
40213
|
+
"externalDocs": {
|
|
40214
|
+
"description": "API method documentation",
|
|
40215
|
+
"url": "https://docs.github.com/enterprise-server@3.11/rest/actions/variables#create-an-environment-variable"
|
|
40216
|
+
},
|
|
40217
|
+
"parameters": [
|
|
40218
|
+
{
|
|
40219
|
+
"$ref": "#/components/parameters/owner"
|
|
40220
|
+
},
|
|
40221
|
+
{
|
|
40222
|
+
"$ref": "#/components/parameters/repo"
|
|
40223
|
+
},
|
|
40224
|
+
{
|
|
40225
|
+
"$ref": "#/components/parameters/environment-name"
|
|
40226
|
+
}
|
|
40227
|
+
],
|
|
40228
|
+
"requestBody": {
|
|
40229
|
+
"required": true,
|
|
40230
|
+
"content": {
|
|
40231
|
+
"application/json": {
|
|
40232
|
+
"schema": {
|
|
40233
|
+
"type": "object",
|
|
40234
|
+
"properties": {
|
|
40235
|
+
"name": {
|
|
40236
|
+
"type": "string",
|
|
40237
|
+
"description": "The name of the variable."
|
|
40238
|
+
},
|
|
40239
|
+
"value": {
|
|
40240
|
+
"type": "string",
|
|
40241
|
+
"description": "The value of the variable."
|
|
40242
|
+
}
|
|
40243
|
+
},
|
|
40244
|
+
"required": [
|
|
40245
|
+
"name",
|
|
40246
|
+
"value"
|
|
40247
|
+
]
|
|
40248
|
+
},
|
|
40249
|
+
"examples": {
|
|
40250
|
+
"default": {
|
|
40251
|
+
"value": {
|
|
40252
|
+
"name": "USERNAME",
|
|
40253
|
+
"value": "octocat"
|
|
40254
|
+
}
|
|
40255
|
+
}
|
|
40256
|
+
}
|
|
40257
|
+
}
|
|
40258
|
+
}
|
|
40259
|
+
},
|
|
40260
|
+
"responses": {
|
|
40261
|
+
"201": {
|
|
40262
|
+
"description": "Response",
|
|
40263
|
+
"content": {
|
|
40264
|
+
"application/json": {
|
|
40265
|
+
"schema": {
|
|
40266
|
+
"$ref": "#/components/schemas/empty-object"
|
|
40267
|
+
},
|
|
40268
|
+
"examples": {
|
|
40269
|
+
"default": {
|
|
40270
|
+
"value": null
|
|
40271
|
+
}
|
|
40272
|
+
}
|
|
40273
|
+
}
|
|
40274
|
+
}
|
|
40275
|
+
}
|
|
40276
|
+
},
|
|
40277
|
+
"x-github": {
|
|
40278
|
+
"githubCloudOnly": false,
|
|
40279
|
+
"enabledForGitHubApps": true,
|
|
40280
|
+
"category": "actions",
|
|
40281
|
+
"subcategory": "variables"
|
|
40282
|
+
},
|
|
40283
|
+
"x-octokit": {}
|
|
40284
|
+
}
|
|
40285
|
+
},
|
|
40286
|
+
"/repos/{owner}/{repo}/environments/{environment_name}/variables/{name}": {
|
|
40287
|
+
"get": {
|
|
40288
|
+
"summary": "Get an environment variable",
|
|
40289
|
+
"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.",
|
|
40290
|
+
"tags": [
|
|
40291
|
+
"actions"
|
|
40292
|
+
],
|
|
40293
|
+
"operationId": "actions/get-environment-variable",
|
|
40294
|
+
"externalDocs": {
|
|
40295
|
+
"description": "API method documentation",
|
|
40296
|
+
"url": "https://docs.github.com/enterprise-server@3.11/rest/actions/variables#get-an-environment-variable"
|
|
40297
|
+
},
|
|
40298
|
+
"parameters": [
|
|
40299
|
+
{
|
|
40300
|
+
"$ref": "#/components/parameters/owner"
|
|
40301
|
+
},
|
|
40302
|
+
{
|
|
40303
|
+
"$ref": "#/components/parameters/repo"
|
|
40304
|
+
},
|
|
40305
|
+
{
|
|
40306
|
+
"$ref": "#/components/parameters/environment-name"
|
|
40307
|
+
},
|
|
40308
|
+
{
|
|
40309
|
+
"$ref": "#/components/parameters/variable-name"
|
|
40310
|
+
}
|
|
40311
|
+
],
|
|
40312
|
+
"responses": {
|
|
40313
|
+
"200": {
|
|
40314
|
+
"description": "Response",
|
|
40315
|
+
"content": {
|
|
40316
|
+
"application/json": {
|
|
40317
|
+
"schema": {
|
|
40318
|
+
"$ref": "#/components/schemas/actions-variable"
|
|
40319
|
+
},
|
|
40320
|
+
"examples": {
|
|
40321
|
+
"default": {
|
|
40322
|
+
"$ref": "#/components/examples/actions-variable"
|
|
40323
|
+
}
|
|
40324
|
+
}
|
|
40325
|
+
}
|
|
40326
|
+
}
|
|
40327
|
+
}
|
|
40328
|
+
},
|
|
40329
|
+
"x-github": {
|
|
40330
|
+
"githubCloudOnly": false,
|
|
40331
|
+
"enabledForGitHubApps": true,
|
|
40332
|
+
"category": "actions",
|
|
40333
|
+
"subcategory": "variables"
|
|
40334
|
+
},
|
|
40335
|
+
"x-octokit": {}
|
|
40336
|
+
},
|
|
40337
|
+
"patch": {
|
|
40338
|
+
"summary": "Update an environment variable",
|
|
40339
|
+
"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.",
|
|
40340
|
+
"tags": [
|
|
40341
|
+
"actions"
|
|
40342
|
+
],
|
|
40343
|
+
"operationId": "actions/update-environment-variable",
|
|
40344
|
+
"externalDocs": {
|
|
40345
|
+
"description": "API method documentation",
|
|
40346
|
+
"url": "https://docs.github.com/enterprise-server@3.11/rest/actions/variables#update-an-environment-variable"
|
|
40347
|
+
},
|
|
40348
|
+
"parameters": [
|
|
40349
|
+
{
|
|
40350
|
+
"$ref": "#/components/parameters/owner"
|
|
40351
|
+
},
|
|
40352
|
+
{
|
|
40353
|
+
"$ref": "#/components/parameters/repo"
|
|
40354
|
+
},
|
|
40355
|
+
{
|
|
40356
|
+
"$ref": "#/components/parameters/variable-name"
|
|
40357
|
+
},
|
|
40358
|
+
{
|
|
40359
|
+
"$ref": "#/components/parameters/environment-name"
|
|
40360
|
+
}
|
|
40361
|
+
],
|
|
40362
|
+
"requestBody": {
|
|
40363
|
+
"required": true,
|
|
40364
|
+
"content": {
|
|
40365
|
+
"application/json": {
|
|
40366
|
+
"schema": {
|
|
40367
|
+
"type": "object",
|
|
40368
|
+
"properties": {
|
|
40369
|
+
"name": {
|
|
40370
|
+
"type": "string",
|
|
40371
|
+
"description": "The name of the variable."
|
|
40372
|
+
},
|
|
40373
|
+
"value": {
|
|
40374
|
+
"type": "string",
|
|
40375
|
+
"description": "The value of the variable."
|
|
40376
|
+
}
|
|
40377
|
+
}
|
|
40378
|
+
},
|
|
40379
|
+
"examples": {
|
|
40380
|
+
"default": {
|
|
40381
|
+
"value": {
|
|
40382
|
+
"name": "USERNAME",
|
|
40383
|
+
"value": "octocat"
|
|
40384
|
+
}
|
|
40385
|
+
}
|
|
40386
|
+
}
|
|
40387
|
+
}
|
|
40388
|
+
}
|
|
40389
|
+
},
|
|
40390
|
+
"responses": {
|
|
40391
|
+
"204": {
|
|
40392
|
+
"description": "Response"
|
|
40393
|
+
}
|
|
40394
|
+
},
|
|
40395
|
+
"x-github": {
|
|
40396
|
+
"githubCloudOnly": false,
|
|
40397
|
+
"enabledForGitHubApps": true,
|
|
40398
|
+
"category": "actions",
|
|
40399
|
+
"subcategory": "variables"
|
|
40400
|
+
},
|
|
40401
|
+
"x-octokit": {}
|
|
40402
|
+
},
|
|
40403
|
+
"delete": {
|
|
40404
|
+
"summary": "Delete an environment variable",
|
|
40405
|
+
"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.",
|
|
40406
|
+
"tags": [
|
|
40407
|
+
"actions"
|
|
40408
|
+
],
|
|
40409
|
+
"operationId": "actions/delete-environment-variable",
|
|
40410
|
+
"externalDocs": {
|
|
40411
|
+
"description": "API method documentation",
|
|
40412
|
+
"url": "https://docs.github.com/enterprise-server@3.11/rest/actions/variables#delete-an-environment-variable"
|
|
40413
|
+
},
|
|
40414
|
+
"parameters": [
|
|
40415
|
+
{
|
|
40416
|
+
"$ref": "#/components/parameters/owner"
|
|
40417
|
+
},
|
|
40418
|
+
{
|
|
40419
|
+
"$ref": "#/components/parameters/repo"
|
|
40420
|
+
},
|
|
40421
|
+
{
|
|
40422
|
+
"$ref": "#/components/parameters/variable-name"
|
|
40423
|
+
},
|
|
40424
|
+
{
|
|
40425
|
+
"$ref": "#/components/parameters/environment-name"
|
|
40426
|
+
}
|
|
40427
|
+
],
|
|
40428
|
+
"responses": {
|
|
40429
|
+
"204": {
|
|
40430
|
+
"description": "Response"
|
|
40431
|
+
}
|
|
40432
|
+
},
|
|
40433
|
+
"x-github": {
|
|
40434
|
+
"githubCloudOnly": false,
|
|
40435
|
+
"enabledForGitHubApps": true,
|
|
40436
|
+
"category": "actions",
|
|
40437
|
+
"subcategory": "variables"
|
|
40438
|
+
},
|
|
40439
|
+
"x-octokit": {}
|
|
40440
|
+
}
|
|
40441
|
+
},
|
|
39820
40442
|
"/repos/{owner}/{repo}/events": {
|
|
39821
40443
|
"get": {
|
|
39822
40444
|
"summary": "List repository events",
|
|
@@ -40189,6 +40811,9 @@
|
|
|
40189
40811
|
"404": {
|
|
40190
40812
|
"$ref": "#/components/responses/not_found"
|
|
40191
40813
|
},
|
|
40814
|
+
"409": {
|
|
40815
|
+
"$ref": "#/components/responses/conflict"
|
|
40816
|
+
},
|
|
40192
40817
|
"422": {
|
|
40193
40818
|
"$ref": "#/components/responses/validation_failed"
|
|
40194
40819
|
}
|
|
@@ -40343,6 +40968,9 @@
|
|
|
40343
40968
|
"404": {
|
|
40344
40969
|
"$ref": "#/components/responses/not_found"
|
|
40345
40970
|
},
|
|
40971
|
+
"409": {
|
|
40972
|
+
"$ref": "#/components/responses/conflict"
|
|
40973
|
+
},
|
|
40346
40974
|
"422": {
|
|
40347
40975
|
"$ref": "#/components/responses/validation_failed"
|
|
40348
40976
|
}
|
|
@@ -40397,6 +41025,9 @@
|
|
|
40397
41025
|
},
|
|
40398
41026
|
"404": {
|
|
40399
41027
|
"$ref": "#/components/responses/not_found"
|
|
41028
|
+
},
|
|
41029
|
+
"409": {
|
|
41030
|
+
"$ref": "#/components/responses/conflict"
|
|
40400
41031
|
}
|
|
40401
41032
|
},
|
|
40402
41033
|
"x-github": {
|
|
@@ -40428,7 +41059,7 @@
|
|
|
40428
41059
|
"$ref": "#/components/parameters/repo"
|
|
40429
41060
|
},
|
|
40430
41061
|
{
|
|
40431
|
-
"$ref": "#/components/parameters/
|
|
41062
|
+
"$ref": "#/components/parameters/git-ref-only"
|
|
40432
41063
|
}
|
|
40433
41064
|
],
|
|
40434
41065
|
"responses": {
|
|
@@ -40454,6 +41085,9 @@
|
|
|
40454
41085
|
"$ref": "#/components/headers/link"
|
|
40455
41086
|
}
|
|
40456
41087
|
}
|
|
41088
|
+
},
|
|
41089
|
+
"409": {
|
|
41090
|
+
"$ref": "#/components/responses/conflict"
|
|
40457
41091
|
}
|
|
40458
41092
|
},
|
|
40459
41093
|
"x-github": {
|
|
@@ -40485,7 +41119,7 @@
|
|
|
40485
41119
|
"$ref": "#/components/parameters/repo"
|
|
40486
41120
|
},
|
|
40487
41121
|
{
|
|
40488
|
-
"$ref": "#/components/parameters/
|
|
41122
|
+
"$ref": "#/components/parameters/git-ref-only"
|
|
40489
41123
|
}
|
|
40490
41124
|
],
|
|
40491
41125
|
"responses": {
|
|
@@ -40506,6 +41140,9 @@
|
|
|
40506
41140
|
},
|
|
40507
41141
|
"404": {
|
|
40508
41142
|
"$ref": "#/components/responses/not_found"
|
|
41143
|
+
},
|
|
41144
|
+
"409": {
|
|
41145
|
+
"$ref": "#/components/responses/conflict"
|
|
40509
41146
|
}
|
|
40510
41147
|
},
|
|
40511
41148
|
"x-github": {
|
|
@@ -40593,6 +41230,9 @@
|
|
|
40593
41230
|
}
|
|
40594
41231
|
}
|
|
40595
41232
|
},
|
|
41233
|
+
"409": {
|
|
41234
|
+
"$ref": "#/components/responses/conflict"
|
|
41235
|
+
},
|
|
40596
41236
|
"422": {
|
|
40597
41237
|
"$ref": "#/components/responses/validation_failed"
|
|
40598
41238
|
}
|
|
@@ -40609,7 +41249,7 @@
|
|
|
40609
41249
|
"/repos/{owner}/{repo}/git/refs/{ref}": {
|
|
40610
41250
|
"patch": {
|
|
40611
41251
|
"summary": "Update a reference",
|
|
40612
|
-
"description": "",
|
|
41252
|
+
"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.",
|
|
40613
41253
|
"tags": [
|
|
40614
41254
|
"git"
|
|
40615
41255
|
],
|
|
@@ -40626,15 +41266,7 @@
|
|
|
40626
41266
|
"$ref": "#/components/parameters/repo"
|
|
40627
41267
|
},
|
|
40628
41268
|
{
|
|
40629
|
-
"
|
|
40630
|
-
"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.",
|
|
40631
|
-
"in": "path",
|
|
40632
|
-
"required": true,
|
|
40633
|
-
"example": "heads/featureA",
|
|
40634
|
-
"schema": {
|
|
40635
|
-
"type": "string"
|
|
40636
|
-
},
|
|
40637
|
-
"x-multi-segment": true
|
|
41269
|
+
"$ref": "#/components/parameters/git-ref-only"
|
|
40638
41270
|
}
|
|
40639
41271
|
],
|
|
40640
41272
|
"requestBody": {
|
|
@@ -40685,6 +41317,9 @@
|
|
|
40685
41317
|
}
|
|
40686
41318
|
}
|
|
40687
41319
|
},
|
|
41320
|
+
"409": {
|
|
41321
|
+
"$ref": "#/components/responses/conflict"
|
|
41322
|
+
},
|
|
40688
41323
|
"422": {
|
|
40689
41324
|
"$ref": "#/components/responses/validation_failed"
|
|
40690
41325
|
}
|
|
@@ -40699,7 +41334,7 @@
|
|
|
40699
41334
|
},
|
|
40700
41335
|
"delete": {
|
|
40701
41336
|
"summary": "Delete a reference",
|
|
40702
|
-
"description": "",
|
|
41337
|
+
"description": "Deletes the provided reference.",
|
|
40703
41338
|
"tags": [
|
|
40704
41339
|
"git"
|
|
40705
41340
|
],
|
|
@@ -40716,13 +41351,16 @@
|
|
|
40716
41351
|
"$ref": "#/components/parameters/repo"
|
|
40717
41352
|
},
|
|
40718
41353
|
{
|
|
40719
|
-
"$ref": "#/components/parameters/
|
|
41354
|
+
"$ref": "#/components/parameters/git-ref-only"
|
|
40720
41355
|
}
|
|
40721
41356
|
],
|
|
40722
41357
|
"responses": {
|
|
40723
41358
|
"204": {
|
|
40724
41359
|
"description": "Response"
|
|
40725
41360
|
},
|
|
41361
|
+
"409": {
|
|
41362
|
+
"$ref": "#/components/responses/conflict"
|
|
41363
|
+
},
|
|
40726
41364
|
"422": {
|
|
40727
41365
|
"$ref": "#/components/responses/validation_failed"
|
|
40728
41366
|
}
|
|
@@ -40857,6 +41495,9 @@
|
|
|
40857
41495
|
}
|
|
40858
41496
|
}
|
|
40859
41497
|
},
|
|
41498
|
+
"409": {
|
|
41499
|
+
"$ref": "#/components/responses/conflict"
|
|
41500
|
+
},
|
|
40860
41501
|
"422": {
|
|
40861
41502
|
"$ref": "#/components/responses/validation_failed"
|
|
40862
41503
|
}
|
|
@@ -40916,6 +41557,9 @@
|
|
|
40916
41557
|
},
|
|
40917
41558
|
"404": {
|
|
40918
41559
|
"$ref": "#/components/responses/not_found"
|
|
41560
|
+
},
|
|
41561
|
+
"409": {
|
|
41562
|
+
"$ref": "#/components/responses/conflict"
|
|
40919
41563
|
}
|
|
40920
41564
|
},
|
|
40921
41565
|
"x-github": {
|
|
@@ -41053,6 +41697,9 @@
|
|
|
41053
41697
|
"404": {
|
|
41054
41698
|
"$ref": "#/components/responses/not_found"
|
|
41055
41699
|
},
|
|
41700
|
+
"409": {
|
|
41701
|
+
"$ref": "#/components/responses/conflict"
|
|
41702
|
+
},
|
|
41056
41703
|
"422": {
|
|
41057
41704
|
"$ref": "#/components/responses/validation_failed"
|
|
41058
41705
|
}
|
|
@@ -41127,6 +41774,9 @@
|
|
|
41127
41774
|
"404": {
|
|
41128
41775
|
"$ref": "#/components/responses/not_found"
|
|
41129
41776
|
},
|
|
41777
|
+
"409": {
|
|
41778
|
+
"$ref": "#/components/responses/conflict"
|
|
41779
|
+
},
|
|
41130
41780
|
"422": {
|
|
41131
41781
|
"$ref": "#/components/responses/validation_failed"
|
|
41132
41782
|
}
|
|
@@ -53512,587 +54162,7 @@
|
|
|
53512
54162
|
"x-octokit": {}
|
|
53513
54163
|
}
|
|
53514
54164
|
},
|
|
53515
|
-
"/
|
|
53516
|
-
"get": {
|
|
53517
|
-
"summary": "List environment secrets",
|
|
53518
|
-
"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.",
|
|
53519
|
-
"tags": [
|
|
53520
|
-
"actions"
|
|
53521
|
-
],
|
|
53522
|
-
"operationId": "actions/list-environment-secrets",
|
|
53523
|
-
"externalDocs": {
|
|
53524
|
-
"description": "API method documentation",
|
|
53525
|
-
"url": "https://docs.github.com/enterprise-server@3.11/rest/actions/secrets#list-environment-secrets"
|
|
53526
|
-
},
|
|
53527
|
-
"parameters": [
|
|
53528
|
-
{
|
|
53529
|
-
"$ref": "#/components/parameters/repository-id"
|
|
53530
|
-
},
|
|
53531
|
-
{
|
|
53532
|
-
"$ref": "#/components/parameters/environment-name"
|
|
53533
|
-
},
|
|
53534
|
-
{
|
|
53535
|
-
"$ref": "#/components/parameters/per-page"
|
|
53536
|
-
},
|
|
53537
|
-
{
|
|
53538
|
-
"$ref": "#/components/parameters/page"
|
|
53539
|
-
}
|
|
53540
|
-
],
|
|
53541
|
-
"responses": {
|
|
53542
|
-
"200": {
|
|
53543
|
-
"description": "Response",
|
|
53544
|
-
"content": {
|
|
53545
|
-
"application/json": {
|
|
53546
|
-
"schema": {
|
|
53547
|
-
"type": "object",
|
|
53548
|
-
"required": [
|
|
53549
|
-
"total_count",
|
|
53550
|
-
"secrets"
|
|
53551
|
-
],
|
|
53552
|
-
"properties": {
|
|
53553
|
-
"total_count": {
|
|
53554
|
-
"type": "integer"
|
|
53555
|
-
},
|
|
53556
|
-
"secrets": {
|
|
53557
|
-
"type": "array",
|
|
53558
|
-
"items": {
|
|
53559
|
-
"$ref": "#/components/schemas/actions-secret"
|
|
53560
|
-
}
|
|
53561
|
-
}
|
|
53562
|
-
}
|
|
53563
|
-
},
|
|
53564
|
-
"examples": {
|
|
53565
|
-
"default": {
|
|
53566
|
-
"$ref": "#/components/examples/actions-secret-paginated"
|
|
53567
|
-
}
|
|
53568
|
-
}
|
|
53569
|
-
}
|
|
53570
|
-
},
|
|
53571
|
-
"headers": {
|
|
53572
|
-
"Link": {
|
|
53573
|
-
"$ref": "#/components/headers/link"
|
|
53574
|
-
}
|
|
53575
|
-
}
|
|
53576
|
-
}
|
|
53577
|
-
},
|
|
53578
|
-
"x-github": {
|
|
53579
|
-
"githubCloudOnly": false,
|
|
53580
|
-
"enabledForGitHubApps": true,
|
|
53581
|
-
"category": "actions",
|
|
53582
|
-
"subcategory": "secrets"
|
|
53583
|
-
},
|
|
53584
|
-
"x-octokit": {}
|
|
53585
|
-
}
|
|
53586
|
-
},
|
|
53587
|
-
"/repositories/{repository_id}/environments/{environment_name}/secrets/public-key": {
|
|
53588
|
-
"get": {
|
|
53589
|
-
"summary": "Get an environment public key",
|
|
53590
|
-
"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.",
|
|
53591
|
-
"tags": [
|
|
53592
|
-
"actions"
|
|
53593
|
-
],
|
|
53594
|
-
"operationId": "actions/get-environment-public-key",
|
|
53595
|
-
"externalDocs": {
|
|
53596
|
-
"description": "API method documentation",
|
|
53597
|
-
"url": "https://docs.github.com/enterprise-server@3.11/rest/actions/secrets#get-an-environment-public-key"
|
|
53598
|
-
},
|
|
53599
|
-
"parameters": [
|
|
53600
|
-
{
|
|
53601
|
-
"$ref": "#/components/parameters/repository-id"
|
|
53602
|
-
},
|
|
53603
|
-
{
|
|
53604
|
-
"$ref": "#/components/parameters/environment-name"
|
|
53605
|
-
}
|
|
53606
|
-
],
|
|
53607
|
-
"responses": {
|
|
53608
|
-
"200": {
|
|
53609
|
-
"description": "Response",
|
|
53610
|
-
"content": {
|
|
53611
|
-
"application/json": {
|
|
53612
|
-
"schema": {
|
|
53613
|
-
"$ref": "#/components/schemas/actions-public-key"
|
|
53614
|
-
},
|
|
53615
|
-
"examples": {
|
|
53616
|
-
"default": {
|
|
53617
|
-
"$ref": "#/components/examples/actions-public-key"
|
|
53618
|
-
}
|
|
53619
|
-
}
|
|
53620
|
-
}
|
|
53621
|
-
}
|
|
53622
|
-
}
|
|
53623
|
-
},
|
|
53624
|
-
"x-github": {
|
|
53625
|
-
"githubCloudOnly": false,
|
|
53626
|
-
"enabledForGitHubApps": true,
|
|
53627
|
-
"category": "actions",
|
|
53628
|
-
"subcategory": "secrets"
|
|
53629
|
-
},
|
|
53630
|
-
"x-octokit": {}
|
|
53631
|
-
}
|
|
53632
|
-
},
|
|
53633
|
-
"/repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}": {
|
|
53634
|
-
"get": {
|
|
53635
|
-
"summary": "Get an environment secret",
|
|
53636
|
-
"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.",
|
|
53637
|
-
"tags": [
|
|
53638
|
-
"actions"
|
|
53639
|
-
],
|
|
53640
|
-
"operationId": "actions/get-environment-secret",
|
|
53641
|
-
"externalDocs": {
|
|
53642
|
-
"description": "API method documentation",
|
|
53643
|
-
"url": "https://docs.github.com/enterprise-server@3.11/rest/actions/secrets#get-an-environment-secret"
|
|
53644
|
-
},
|
|
53645
|
-
"parameters": [
|
|
53646
|
-
{
|
|
53647
|
-
"$ref": "#/components/parameters/repository-id"
|
|
53648
|
-
},
|
|
53649
|
-
{
|
|
53650
|
-
"$ref": "#/components/parameters/environment-name"
|
|
53651
|
-
},
|
|
53652
|
-
{
|
|
53653
|
-
"$ref": "#/components/parameters/secret-name"
|
|
53654
|
-
}
|
|
53655
|
-
],
|
|
53656
|
-
"responses": {
|
|
53657
|
-
"200": {
|
|
53658
|
-
"description": "Response",
|
|
53659
|
-
"content": {
|
|
53660
|
-
"application/json": {
|
|
53661
|
-
"schema": {
|
|
53662
|
-
"$ref": "#/components/schemas/actions-secret"
|
|
53663
|
-
},
|
|
53664
|
-
"examples": {
|
|
53665
|
-
"default": {
|
|
53666
|
-
"$ref": "#/components/examples/actions-secret"
|
|
53667
|
-
}
|
|
53668
|
-
}
|
|
53669
|
-
}
|
|
53670
|
-
}
|
|
53671
|
-
}
|
|
53672
|
-
},
|
|
53673
|
-
"x-github": {
|
|
53674
|
-
"githubCloudOnly": false,
|
|
53675
|
-
"enabledForGitHubApps": true,
|
|
53676
|
-
"category": "actions",
|
|
53677
|
-
"subcategory": "secrets"
|
|
53678
|
-
},
|
|
53679
|
-
"x-octokit": {}
|
|
53680
|
-
},
|
|
53681
|
-
"put": {
|
|
53682
|
-
"summary": "Create or update an environment secret",
|
|
53683
|
-
"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.11/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.",
|
|
53684
|
-
"tags": [
|
|
53685
|
-
"actions"
|
|
53686
|
-
],
|
|
53687
|
-
"operationId": "actions/create-or-update-environment-secret",
|
|
53688
|
-
"externalDocs": {
|
|
53689
|
-
"description": "API method documentation",
|
|
53690
|
-
"url": "https://docs.github.com/enterprise-server@3.11/rest/actions/secrets#create-or-update-an-environment-secret"
|
|
53691
|
-
},
|
|
53692
|
-
"parameters": [
|
|
53693
|
-
{
|
|
53694
|
-
"$ref": "#/components/parameters/repository-id"
|
|
53695
|
-
},
|
|
53696
|
-
{
|
|
53697
|
-
"$ref": "#/components/parameters/environment-name"
|
|
53698
|
-
},
|
|
53699
|
-
{
|
|
53700
|
-
"$ref": "#/components/parameters/secret-name"
|
|
53701
|
-
}
|
|
53702
|
-
],
|
|
53703
|
-
"requestBody": {
|
|
53704
|
-
"required": true,
|
|
53705
|
-
"content": {
|
|
53706
|
-
"application/json": {
|
|
53707
|
-
"schema": {
|
|
53708
|
-
"type": "object",
|
|
53709
|
-
"properties": {
|
|
53710
|
-
"encrypted_value": {
|
|
53711
|
-
"type": "string",
|
|
53712
|
-
"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.11/rest/actions/secrets#get-an-environment-public-key) endpoint.",
|
|
53713
|
-
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$"
|
|
53714
|
-
},
|
|
53715
|
-
"key_id": {
|
|
53716
|
-
"type": "string",
|
|
53717
|
-
"description": "ID of the key you used to encrypt the secret."
|
|
53718
|
-
}
|
|
53719
|
-
},
|
|
53720
|
-
"required": [
|
|
53721
|
-
"encrypted_value",
|
|
53722
|
-
"key_id"
|
|
53723
|
-
]
|
|
53724
|
-
},
|
|
53725
|
-
"examples": {
|
|
53726
|
-
"default": {
|
|
53727
|
-
"value": {
|
|
53728
|
-
"encrypted_value": "c2VjcmV0",
|
|
53729
|
-
"key_id": "012345678912345678"
|
|
53730
|
-
}
|
|
53731
|
-
}
|
|
53732
|
-
}
|
|
53733
|
-
}
|
|
53734
|
-
}
|
|
53735
|
-
},
|
|
53736
|
-
"responses": {
|
|
53737
|
-
"201": {
|
|
53738
|
-
"description": "Response when creating a secret",
|
|
53739
|
-
"content": {
|
|
53740
|
-
"application/json": {
|
|
53741
|
-
"schema": {
|
|
53742
|
-
"$ref": "#/components/schemas/empty-object"
|
|
53743
|
-
},
|
|
53744
|
-
"examples": {
|
|
53745
|
-
"default": {
|
|
53746
|
-
"value": null
|
|
53747
|
-
}
|
|
53748
|
-
}
|
|
53749
|
-
}
|
|
53750
|
-
}
|
|
53751
|
-
},
|
|
53752
|
-
"204": {
|
|
53753
|
-
"description": "Response when updating a secret"
|
|
53754
|
-
}
|
|
53755
|
-
},
|
|
53756
|
-
"x-github": {
|
|
53757
|
-
"githubCloudOnly": false,
|
|
53758
|
-
"enabledForGitHubApps": true,
|
|
53759
|
-
"category": "actions",
|
|
53760
|
-
"subcategory": "secrets"
|
|
53761
|
-
},
|
|
53762
|
-
"x-octokit": {}
|
|
53763
|
-
},
|
|
53764
|
-
"delete": {
|
|
53765
|
-
"summary": "Delete an environment secret",
|
|
53766
|
-
"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.",
|
|
53767
|
-
"tags": [
|
|
53768
|
-
"actions"
|
|
53769
|
-
],
|
|
53770
|
-
"operationId": "actions/delete-environment-secret",
|
|
53771
|
-
"externalDocs": {
|
|
53772
|
-
"description": "API method documentation",
|
|
53773
|
-
"url": "https://docs.github.com/enterprise-server@3.11/rest/actions/secrets#delete-an-environment-secret"
|
|
53774
|
-
},
|
|
53775
|
-
"parameters": [
|
|
53776
|
-
{
|
|
53777
|
-
"$ref": "#/components/parameters/repository-id"
|
|
53778
|
-
},
|
|
53779
|
-
{
|
|
53780
|
-
"$ref": "#/components/parameters/environment-name"
|
|
53781
|
-
},
|
|
53782
|
-
{
|
|
53783
|
-
"$ref": "#/components/parameters/secret-name"
|
|
53784
|
-
}
|
|
53785
|
-
],
|
|
53786
|
-
"responses": {
|
|
53787
|
-
"204": {
|
|
53788
|
-
"description": "Default response"
|
|
53789
|
-
}
|
|
53790
|
-
},
|
|
53791
|
-
"x-github": {
|
|
53792
|
-
"githubCloudOnly": false,
|
|
53793
|
-
"enabledForGitHubApps": true,
|
|
53794
|
-
"category": "actions",
|
|
53795
|
-
"subcategory": "secrets"
|
|
53796
|
-
},
|
|
53797
|
-
"x-octokit": {}
|
|
53798
|
-
}
|
|
53799
|
-
},
|
|
53800
|
-
"/repositories/{repository_id}/environments/{environment_name}/variables": {
|
|
53801
|
-
"get": {
|
|
53802
|
-
"summary": "List environment variables",
|
|
53803
|
-
"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.",
|
|
53804
|
-
"tags": [
|
|
53805
|
-
"actions"
|
|
53806
|
-
],
|
|
53807
|
-
"operationId": "actions/list-environment-variables",
|
|
53808
|
-
"externalDocs": {
|
|
53809
|
-
"description": "API method documentation",
|
|
53810
|
-
"url": "https://docs.github.com/enterprise-server@3.11/rest/actions/variables#list-environment-variables"
|
|
53811
|
-
},
|
|
53812
|
-
"parameters": [
|
|
53813
|
-
{
|
|
53814
|
-
"$ref": "#/components/parameters/repository-id"
|
|
53815
|
-
},
|
|
53816
|
-
{
|
|
53817
|
-
"$ref": "#/components/parameters/environment-name"
|
|
53818
|
-
},
|
|
53819
|
-
{
|
|
53820
|
-
"$ref": "#/components/parameters/variables-per-page"
|
|
53821
|
-
},
|
|
53822
|
-
{
|
|
53823
|
-
"$ref": "#/components/parameters/page"
|
|
53824
|
-
}
|
|
53825
|
-
],
|
|
53826
|
-
"responses": {
|
|
53827
|
-
"200": {
|
|
53828
|
-
"description": "Response",
|
|
53829
|
-
"content": {
|
|
53830
|
-
"application/json": {
|
|
53831
|
-
"schema": {
|
|
53832
|
-
"type": "object",
|
|
53833
|
-
"required": [
|
|
53834
|
-
"total_count",
|
|
53835
|
-
"variables"
|
|
53836
|
-
],
|
|
53837
|
-
"properties": {
|
|
53838
|
-
"total_count": {
|
|
53839
|
-
"type": "integer"
|
|
53840
|
-
},
|
|
53841
|
-
"variables": {
|
|
53842
|
-
"type": "array",
|
|
53843
|
-
"items": {
|
|
53844
|
-
"$ref": "#/components/schemas/actions-variable"
|
|
53845
|
-
}
|
|
53846
|
-
}
|
|
53847
|
-
}
|
|
53848
|
-
},
|
|
53849
|
-
"examples": {
|
|
53850
|
-
"default": {
|
|
53851
|
-
"$ref": "#/components/examples/actions-variables-paginated"
|
|
53852
|
-
}
|
|
53853
|
-
}
|
|
53854
|
-
}
|
|
53855
|
-
},
|
|
53856
|
-
"headers": {
|
|
53857
|
-
"Link": {
|
|
53858
|
-
"$ref": "#/components/headers/link"
|
|
53859
|
-
}
|
|
53860
|
-
}
|
|
53861
|
-
}
|
|
53862
|
-
},
|
|
53863
|
-
"x-github": {
|
|
53864
|
-
"githubCloudOnly": false,
|
|
53865
|
-
"enabledForGitHubApps": true,
|
|
53866
|
-
"category": "actions",
|
|
53867
|
-
"subcategory": "variables"
|
|
53868
|
-
},
|
|
53869
|
-
"x-octokit": {}
|
|
53870
|
-
},
|
|
53871
|
-
"post": {
|
|
53872
|
-
"summary": "Create an environment variable",
|
|
53873
|
-
"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.",
|
|
53874
|
-
"tags": [
|
|
53875
|
-
"actions"
|
|
53876
|
-
],
|
|
53877
|
-
"operationId": "actions/create-environment-variable",
|
|
53878
|
-
"externalDocs": {
|
|
53879
|
-
"description": "API method documentation",
|
|
53880
|
-
"url": "https://docs.github.com/enterprise-server@3.11/rest/actions/variables#create-an-environment-variable"
|
|
53881
|
-
},
|
|
53882
|
-
"parameters": [
|
|
53883
|
-
{
|
|
53884
|
-
"$ref": "#/components/parameters/repository-id"
|
|
53885
|
-
},
|
|
53886
|
-
{
|
|
53887
|
-
"$ref": "#/components/parameters/environment-name"
|
|
53888
|
-
}
|
|
53889
|
-
],
|
|
53890
|
-
"requestBody": {
|
|
53891
|
-
"required": true,
|
|
53892
|
-
"content": {
|
|
53893
|
-
"application/json": {
|
|
53894
|
-
"schema": {
|
|
53895
|
-
"type": "object",
|
|
53896
|
-
"properties": {
|
|
53897
|
-
"name": {
|
|
53898
|
-
"type": "string",
|
|
53899
|
-
"description": "The name of the variable."
|
|
53900
|
-
},
|
|
53901
|
-
"value": {
|
|
53902
|
-
"type": "string",
|
|
53903
|
-
"description": "The value of the variable."
|
|
53904
|
-
}
|
|
53905
|
-
},
|
|
53906
|
-
"required": [
|
|
53907
|
-
"name",
|
|
53908
|
-
"value"
|
|
53909
|
-
]
|
|
53910
|
-
},
|
|
53911
|
-
"examples": {
|
|
53912
|
-
"default": {
|
|
53913
|
-
"value": {
|
|
53914
|
-
"name": "USERNAME",
|
|
53915
|
-
"value": "octocat"
|
|
53916
|
-
}
|
|
53917
|
-
}
|
|
53918
|
-
}
|
|
53919
|
-
}
|
|
53920
|
-
}
|
|
53921
|
-
},
|
|
53922
|
-
"responses": {
|
|
53923
|
-
"201": {
|
|
53924
|
-
"description": "Response",
|
|
53925
|
-
"content": {
|
|
53926
|
-
"application/json": {
|
|
53927
|
-
"schema": {
|
|
53928
|
-
"$ref": "#/components/schemas/empty-object"
|
|
53929
|
-
},
|
|
53930
|
-
"examples": {
|
|
53931
|
-
"default": {
|
|
53932
|
-
"value": null
|
|
53933
|
-
}
|
|
53934
|
-
}
|
|
53935
|
-
}
|
|
53936
|
-
}
|
|
53937
|
-
}
|
|
53938
|
-
},
|
|
53939
|
-
"x-github": {
|
|
53940
|
-
"githubCloudOnly": false,
|
|
53941
|
-
"enabledForGitHubApps": true,
|
|
53942
|
-
"category": "actions",
|
|
53943
|
-
"subcategory": "variables"
|
|
53944
|
-
},
|
|
53945
|
-
"x-octokit": {}
|
|
53946
|
-
}
|
|
53947
|
-
},
|
|
53948
|
-
"/repositories/{repository_id}/environments/{environment_name}/variables/{name}": {
|
|
53949
|
-
"get": {
|
|
53950
|
-
"summary": "Get an environment variable",
|
|
53951
|
-
"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.",
|
|
53952
|
-
"tags": [
|
|
53953
|
-
"actions"
|
|
53954
|
-
],
|
|
53955
|
-
"operationId": "actions/get-environment-variable",
|
|
53956
|
-
"externalDocs": {
|
|
53957
|
-
"description": "API method documentation",
|
|
53958
|
-
"url": "https://docs.github.com/enterprise-server@3.11/rest/actions/variables#get-an-environment-variable"
|
|
53959
|
-
},
|
|
53960
|
-
"parameters": [
|
|
53961
|
-
{
|
|
53962
|
-
"$ref": "#/components/parameters/repository-id"
|
|
53963
|
-
},
|
|
53964
|
-
{
|
|
53965
|
-
"$ref": "#/components/parameters/environment-name"
|
|
53966
|
-
},
|
|
53967
|
-
{
|
|
53968
|
-
"$ref": "#/components/parameters/variable-name"
|
|
53969
|
-
}
|
|
53970
|
-
],
|
|
53971
|
-
"responses": {
|
|
53972
|
-
"200": {
|
|
53973
|
-
"description": "Response",
|
|
53974
|
-
"content": {
|
|
53975
|
-
"application/json": {
|
|
53976
|
-
"schema": {
|
|
53977
|
-
"$ref": "#/components/schemas/actions-variable"
|
|
53978
|
-
},
|
|
53979
|
-
"examples": {
|
|
53980
|
-
"default": {
|
|
53981
|
-
"$ref": "#/components/examples/actions-variable"
|
|
53982
|
-
}
|
|
53983
|
-
}
|
|
53984
|
-
}
|
|
53985
|
-
}
|
|
53986
|
-
}
|
|
53987
|
-
},
|
|
53988
|
-
"x-github": {
|
|
53989
|
-
"githubCloudOnly": false,
|
|
53990
|
-
"enabledForGitHubApps": true,
|
|
53991
|
-
"category": "actions",
|
|
53992
|
-
"subcategory": "variables"
|
|
53993
|
-
},
|
|
53994
|
-
"x-octokit": {}
|
|
53995
|
-
},
|
|
53996
|
-
"patch": {
|
|
53997
|
-
"summary": "Update an environment variable",
|
|
53998
|
-
"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.",
|
|
53999
|
-
"tags": [
|
|
54000
|
-
"actions"
|
|
54001
|
-
],
|
|
54002
|
-
"operationId": "actions/update-environment-variable",
|
|
54003
|
-
"externalDocs": {
|
|
54004
|
-
"description": "API method documentation",
|
|
54005
|
-
"url": "https://docs.github.com/enterprise-server@3.11/rest/actions/variables#update-an-environment-variable"
|
|
54006
|
-
},
|
|
54007
|
-
"parameters": [
|
|
54008
|
-
{
|
|
54009
|
-
"$ref": "#/components/parameters/repository-id"
|
|
54010
|
-
},
|
|
54011
|
-
{
|
|
54012
|
-
"$ref": "#/components/parameters/variable-name"
|
|
54013
|
-
},
|
|
54014
|
-
{
|
|
54015
|
-
"$ref": "#/components/parameters/environment-name"
|
|
54016
|
-
}
|
|
54017
|
-
],
|
|
54018
|
-
"requestBody": {
|
|
54019
|
-
"required": true,
|
|
54020
|
-
"content": {
|
|
54021
|
-
"application/json": {
|
|
54022
|
-
"schema": {
|
|
54023
|
-
"type": "object",
|
|
54024
|
-
"properties": {
|
|
54025
|
-
"name": {
|
|
54026
|
-
"type": "string",
|
|
54027
|
-
"description": "The name of the variable."
|
|
54028
|
-
},
|
|
54029
|
-
"value": {
|
|
54030
|
-
"type": "string",
|
|
54031
|
-
"description": "The value of the variable."
|
|
54032
|
-
}
|
|
54033
|
-
}
|
|
54034
|
-
},
|
|
54035
|
-
"examples": {
|
|
54036
|
-
"default": {
|
|
54037
|
-
"value": {
|
|
54038
|
-
"name": "USERNAME",
|
|
54039
|
-
"value": "octocat"
|
|
54040
|
-
}
|
|
54041
|
-
}
|
|
54042
|
-
}
|
|
54043
|
-
}
|
|
54044
|
-
}
|
|
54045
|
-
},
|
|
54046
|
-
"responses": {
|
|
54047
|
-
"204": {
|
|
54048
|
-
"description": "Response"
|
|
54049
|
-
}
|
|
54050
|
-
},
|
|
54051
|
-
"x-github": {
|
|
54052
|
-
"githubCloudOnly": false,
|
|
54053
|
-
"enabledForGitHubApps": true,
|
|
54054
|
-
"category": "actions",
|
|
54055
|
-
"subcategory": "variables"
|
|
54056
|
-
},
|
|
54057
|
-
"x-octokit": {}
|
|
54058
|
-
},
|
|
54059
|
-
"delete": {
|
|
54060
|
-
"summary": "Delete an environment variable",
|
|
54061
|
-
"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.",
|
|
54062
|
-
"tags": [
|
|
54063
|
-
"actions"
|
|
54064
|
-
],
|
|
54065
|
-
"operationId": "actions/delete-environment-variable",
|
|
54066
|
-
"externalDocs": {
|
|
54067
|
-
"description": "API method documentation",
|
|
54068
|
-
"url": "https://docs.github.com/enterprise-server@3.11/rest/actions/variables#delete-an-environment-variable"
|
|
54069
|
-
},
|
|
54070
|
-
"parameters": [
|
|
54071
|
-
{
|
|
54072
|
-
"$ref": "#/components/parameters/repository-id"
|
|
54073
|
-
},
|
|
54074
|
-
{
|
|
54075
|
-
"$ref": "#/components/parameters/variable-name"
|
|
54076
|
-
},
|
|
54077
|
-
{
|
|
54078
|
-
"$ref": "#/components/parameters/environment-name"
|
|
54079
|
-
}
|
|
54080
|
-
],
|
|
54081
|
-
"responses": {
|
|
54082
|
-
"204": {
|
|
54083
|
-
"description": "Response"
|
|
54084
|
-
}
|
|
54085
|
-
},
|
|
54086
|
-
"x-github": {
|
|
54087
|
-
"githubCloudOnly": false,
|
|
54088
|
-
"enabledForGitHubApps": true,
|
|
54089
|
-
"category": "actions",
|
|
54090
|
-
"subcategory": "variables"
|
|
54091
|
-
},
|
|
54092
|
-
"x-octokit": {}
|
|
54093
|
-
}
|
|
54094
|
-
},
|
|
54095
|
-
"/scim/v2/Groups": {
|
|
54165
|
+
"/scim/v2/enterprises/{enterprise}/Groups": {
|
|
54096
54166
|
"get": {
|
|
54097
54167
|
"summary": "List provisioned SCIM groups for an enterprise",
|
|
54098
54168
|
"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.",
|
|
@@ -54131,6 +54201,9 @@
|
|
|
54131
54201
|
},
|
|
54132
54202
|
{
|
|
54133
54203
|
"$ref": "#/components/parameters/count"
|
|
54204
|
+
},
|
|
54205
|
+
{
|
|
54206
|
+
"$ref": "#/components/parameters/enterprise"
|
|
54134
54207
|
}
|
|
54135
54208
|
],
|
|
54136
54209
|
"responses": {
|
|
@@ -54184,6 +54257,11 @@
|
|
|
54184
54257
|
"description": "API method documentation",
|
|
54185
54258
|
"url": "https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/scim#provision-a-scim-enterprise-group"
|
|
54186
54259
|
},
|
|
54260
|
+
"parameters": [
|
|
54261
|
+
{
|
|
54262
|
+
"$ref": "#/components/parameters/enterprise"
|
|
54263
|
+
}
|
|
54264
|
+
],
|
|
54187
54265
|
"requestBody": {
|
|
54188
54266
|
"required": true,
|
|
54189
54267
|
"content": {
|
|
@@ -54249,7 +54327,7 @@
|
|
|
54249
54327
|
"x-octokit": {}
|
|
54250
54328
|
}
|
|
54251
54329
|
},
|
|
54252
|
-
"/scim/v2/Groups/{scim_group_id}": {
|
|
54330
|
+
"/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}": {
|
|
54253
54331
|
"get": {
|
|
54254
54332
|
"summary": "Get SCIM provisioning information for an enterprise group",
|
|
54255
54333
|
"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.",
|
|
@@ -54267,6 +54345,9 @@
|
|
|
54267
54345
|
},
|
|
54268
54346
|
{
|
|
54269
54347
|
"$ref": "#/components/parameters/excluded-attributes"
|
|
54348
|
+
},
|
|
54349
|
+
{
|
|
54350
|
+
"$ref": "#/components/parameters/enterprise"
|
|
54270
54351
|
}
|
|
54271
54352
|
],
|
|
54272
54353
|
"responses": {
|
|
@@ -54326,6 +54407,9 @@
|
|
|
54326
54407
|
"parameters": [
|
|
54327
54408
|
{
|
|
54328
54409
|
"$ref": "#/components/parameters/scim-group-id"
|
|
54410
|
+
},
|
|
54411
|
+
{
|
|
54412
|
+
"$ref": "#/components/parameters/enterprise"
|
|
54329
54413
|
}
|
|
54330
54414
|
],
|
|
54331
54415
|
"requestBody": {
|
|
@@ -54433,6 +54517,9 @@
|
|
|
54433
54517
|
"parameters": [
|
|
54434
54518
|
{
|
|
54435
54519
|
"$ref": "#/components/parameters/scim-group-id"
|
|
54520
|
+
},
|
|
54521
|
+
{
|
|
54522
|
+
"$ref": "#/components/parameters/enterprise"
|
|
54436
54523
|
}
|
|
54437
54524
|
],
|
|
54438
54525
|
"requestBody": {
|
|
@@ -54550,6 +54637,9 @@
|
|
|
54550
54637
|
"parameters": [
|
|
54551
54638
|
{
|
|
54552
54639
|
"$ref": "#/components/parameters/scim-group-id"
|
|
54640
|
+
},
|
|
54641
|
+
{
|
|
54642
|
+
"$ref": "#/components/parameters/enterprise"
|
|
54553
54643
|
}
|
|
54554
54644
|
],
|
|
54555
54645
|
"responses": {
|
|
@@ -54584,7 +54674,7 @@
|
|
|
54584
54674
|
"x-octokit": {}
|
|
54585
54675
|
}
|
|
54586
54676
|
},
|
|
54587
|
-
"/scim/v2/Users": {
|
|
54677
|
+
"/scim/v2/enterprises/{enterprise}/Users": {
|
|
54588
54678
|
"get": {
|
|
54589
54679
|
"summary": "List SCIM provisioned identities for an enterprise",
|
|
54590
54680
|
"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.",
|
|
@@ -54619,6 +54709,9 @@
|
|
|
54619
54709
|
},
|
|
54620
54710
|
{
|
|
54621
54711
|
"$ref": "#/components/parameters/count"
|
|
54712
|
+
},
|
|
54713
|
+
{
|
|
54714
|
+
"$ref": "#/components/parameters/enterprise"
|
|
54622
54715
|
}
|
|
54623
54716
|
],
|
|
54624
54717
|
"responses": {
|
|
@@ -54672,6 +54765,11 @@
|
|
|
54672
54765
|
"description": "API method documentation",
|
|
54673
54766
|
"url": "https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/scim#provision-a-scim-enterprise-user"
|
|
54674
54767
|
},
|
|
54768
|
+
"parameters": [
|
|
54769
|
+
{
|
|
54770
|
+
"$ref": "#/components/parameters/enterprise"
|
|
54771
|
+
}
|
|
54772
|
+
],
|
|
54675
54773
|
"requestBody": {
|
|
54676
54774
|
"required": true,
|
|
54677
54775
|
"content": {
|
|
@@ -54737,7 +54835,7 @@
|
|
|
54737
54835
|
"x-octokit": {}
|
|
54738
54836
|
}
|
|
54739
54837
|
},
|
|
54740
|
-
"/scim/v2/Users/{scim_user_id}": {
|
|
54838
|
+
"/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}": {
|
|
54741
54839
|
"get": {
|
|
54742
54840
|
"summary": "Get SCIM provisioning information for an enterprise user",
|
|
54743
54841
|
"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.",
|
|
@@ -54752,6 +54850,9 @@
|
|
|
54752
54850
|
"parameters": [
|
|
54753
54851
|
{
|
|
54754
54852
|
"$ref": "#/components/parameters/scim-user-id"
|
|
54853
|
+
},
|
|
54854
|
+
{
|
|
54855
|
+
"$ref": "#/components/parameters/enterprise"
|
|
54755
54856
|
}
|
|
54756
54857
|
],
|
|
54757
54858
|
"responses": {
|
|
@@ -54811,6 +54912,9 @@
|
|
|
54811
54912
|
"parameters": [
|
|
54812
54913
|
{
|
|
54813
54914
|
"$ref": "#/components/parameters/scim-user-id"
|
|
54915
|
+
},
|
|
54916
|
+
{
|
|
54917
|
+
"$ref": "#/components/parameters/enterprise"
|
|
54814
54918
|
}
|
|
54815
54919
|
],
|
|
54816
54920
|
"requestBody": {
|
|
@@ -54888,6 +54992,9 @@
|
|
|
54888
54992
|
"parameters": [
|
|
54889
54993
|
{
|
|
54890
54994
|
"$ref": "#/components/parameters/scim-user-id"
|
|
54995
|
+
},
|
|
54996
|
+
{
|
|
54997
|
+
"$ref": "#/components/parameters/enterprise"
|
|
54891
54998
|
}
|
|
54892
54999
|
],
|
|
54893
55000
|
"requestBody": {
|
|
@@ -55023,6 +55130,9 @@
|
|
|
55023
55130
|
"parameters": [
|
|
55024
55131
|
{
|
|
55025
55132
|
"$ref": "#/components/parameters/scim-user-id"
|
|
55133
|
+
},
|
|
55134
|
+
{
|
|
55135
|
+
"$ref": "#/components/parameters/enterprise"
|
|
55026
55136
|
}
|
|
55027
55137
|
],
|
|
55028
55138
|
"responses": {
|
|
@@ -63465,7 +63575,7 @@
|
|
|
63465
63575
|
"/users/{username}/hovercard": {
|
|
63466
63576
|
"get": {
|
|
63467
63577
|
"summary": "Get contextual information for a user",
|
|
63468
|
-
"description": "Provides hovercard information. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations.\n\
|
|
63578
|
+
"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.",
|
|
63469
63579
|
"tags": [
|
|
63470
63580
|
"users"
|
|
63471
63581
|
],
|
|
@@ -102061,6 +102171,38 @@
|
|
|
102061
102171
|
}
|
|
102062
102172
|
}
|
|
102063
102173
|
},
|
|
102174
|
+
"repository-rule-params-thresholds": {
|
|
102175
|
+
"title": "Thresholds",
|
|
102176
|
+
"description": "This setting will not take effect unless at least one code scanning status check is enabled.",
|
|
102177
|
+
"type": "object",
|
|
102178
|
+
"properties": {
|
|
102179
|
+
"code_scanning_alert_threshold": {
|
|
102180
|
+
"type": "string",
|
|
102181
|
+
"description": "Code scanning alert threshold",
|
|
102182
|
+
"enum": [
|
|
102183
|
+
"none",
|
|
102184
|
+
"errors",
|
|
102185
|
+
"errors_and_warnings",
|
|
102186
|
+
"all"
|
|
102187
|
+
]
|
|
102188
|
+
},
|
|
102189
|
+
"code_scanning_security_alert_threshold": {
|
|
102190
|
+
"type": "string",
|
|
102191
|
+
"description": "Code scanning security alert threshold.",
|
|
102192
|
+
"enum": [
|
|
102193
|
+
"none",
|
|
102194
|
+
"critical",
|
|
102195
|
+
"high_or_higher",
|
|
102196
|
+
"medium_or_higher",
|
|
102197
|
+
"all"
|
|
102198
|
+
]
|
|
102199
|
+
}
|
|
102200
|
+
},
|
|
102201
|
+
"required": [
|
|
102202
|
+
"code_scanning_alert_threshold",
|
|
102203
|
+
"code_scanning_security_alert_threshold"
|
|
102204
|
+
]
|
|
102205
|
+
},
|
|
102064
102206
|
"repository-rule": {
|
|
102065
102207
|
"title": "Repository Rule",
|
|
102066
102208
|
"type": "object",
|
|
@@ -104166,7 +104308,9 @@
|
|
|
104166
104308
|
"queued",
|
|
104167
104309
|
"in_progress",
|
|
104168
104310
|
"completed",
|
|
104169
|
-
"waiting"
|
|
104311
|
+
"waiting",
|
|
104312
|
+
"requested",
|
|
104313
|
+
"pending"
|
|
104170
104314
|
]
|
|
104171
104315
|
},
|
|
104172
104316
|
"conclusion": {
|
|
@@ -106699,13 +106843,16 @@
|
|
|
106699
106843
|
"nullable": true
|
|
106700
106844
|
},
|
|
106701
106845
|
"status": {
|
|
106702
|
-
"description": "The phase of the lifecycle that the check is currently in.",
|
|
106846
|
+
"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.",
|
|
106703
106847
|
"example": "queued",
|
|
106704
106848
|
"type": "string",
|
|
106705
106849
|
"enum": [
|
|
106706
106850
|
"queued",
|
|
106707
106851
|
"in_progress",
|
|
106708
|
-
"completed"
|
|
106852
|
+
"completed",
|
|
106853
|
+
"waiting",
|
|
106854
|
+
"requested",
|
|
106855
|
+
"pending"
|
|
106709
106856
|
]
|
|
106710
106857
|
},
|
|
106711
106858
|
"conclusion": {
|
|
@@ -106983,11 +107130,15 @@
|
|
|
106983
107130
|
},
|
|
106984
107131
|
"status": {
|
|
106985
107132
|
"type": "string",
|
|
107133
|
+
"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.",
|
|
106986
107134
|
"example": "completed",
|
|
106987
107135
|
"enum": [
|
|
106988
107136
|
"queued",
|
|
106989
107137
|
"in_progress",
|
|
106990
|
-
"completed"
|
|
107138
|
+
"completed",
|
|
107139
|
+
"waiting",
|
|
107140
|
+
"requested",
|
|
107141
|
+
"pending"
|
|
106991
107142
|
],
|
|
106992
107143
|
"nullable": true
|
|
106993
107144
|
},
|
|
@@ -171241,6 +171392,7 @@
|
|
|
171241
171392
|
"type": "object",
|
|
171242
171393
|
"properties": {
|
|
171243
171394
|
"permission": {
|
|
171395
|
+
"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.",
|
|
171244
171396
|
"type": "object",
|
|
171245
171397
|
"properties": {
|
|
171246
171398
|
"to": {
|
|
@@ -171255,6 +171407,18 @@
|
|
|
171255
171407
|
"required": [
|
|
171256
171408
|
"to"
|
|
171257
171409
|
]
|
|
171410
|
+
},
|
|
171411
|
+
"role_name": {
|
|
171412
|
+
"description": "The role assigned to the collaborator.",
|
|
171413
|
+
"type": "object",
|
|
171414
|
+
"properties": {
|
|
171415
|
+
"to": {
|
|
171416
|
+
"type": "string"
|
|
171417
|
+
}
|
|
171418
|
+
},
|
|
171419
|
+
"required": [
|
|
171420
|
+
"to"
|
|
171421
|
+
]
|
|
171258
171422
|
}
|
|
171259
171423
|
}
|
|
171260
171424
|
},
|
|
@@ -249801,7 +249965,7 @@
|
|
|
249801
249965
|
"type": "string"
|
|
249802
249966
|
},
|
|
249803
249967
|
"commits": {
|
|
249804
|
-
"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
|
|
249968
|
+
"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.11/rest/commits) to fetch additional commits.",
|
|
249805
249969
|
"type": "array",
|
|
249806
249970
|
"items": {
|
|
249807
249971
|
"title": "Commit",
|
|
@@ -299632,7 +299796,7 @@
|
|
|
299632
299796
|
},
|
|
299633
299797
|
"workflow-run-status": {
|
|
299634
299798
|
"name": "status",
|
|
299635
|
-
"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`.",
|
|
299799
|
+
"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`.",
|
|
299636
299800
|
"in": "query",
|
|
299637
299801
|
"required": false,
|
|
299638
299802
|
"schema": {
|
|
@@ -299886,6 +300050,17 @@
|
|
|
299886
300050
|
"type": "integer"
|
|
299887
300051
|
}
|
|
299888
300052
|
},
|
|
300053
|
+
"git-ref-only": {
|
|
300054
|
+
"name": "ref",
|
|
300055
|
+
"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.",
|
|
300056
|
+
"in": "path",
|
|
300057
|
+
"required": true,
|
|
300058
|
+
"example": "heads/feature-a",
|
|
300059
|
+
"schema": {
|
|
300060
|
+
"type": "string"
|
|
300061
|
+
},
|
|
300062
|
+
"x-multi-segment": true
|
|
300063
|
+
},
|
|
299889
300064
|
"invitation-id": {
|
|
299890
300065
|
"name": "invitation_id",
|
|
299891
300066
|
"description": "The unique identifier of the invitation.",
|