@octokit/openapi 14.0.0 → 15.0.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 +2715 -1866
- package/generated/api.github.com.json +923 -647
- package/generated/ghec.deref.json +4039 -3120
- package/generated/ghec.json +999 -679
- package/generated/ghes-3.10.deref.json +3422 -2714
- package/generated/ghes-3.10.json +802 -632
- package/generated/ghes-3.11.deref.json +3433 -2723
- package/generated/ghes-3.11.json +840 -647
- package/generated/ghes-3.12.deref.json +3433 -2723
- package/generated/ghes-3.12.json +840 -647
- package/generated/ghes-3.8.deref.json +3153 -2445
- package/generated/ghes-3.8.json +802 -632
- package/generated/ghes-3.9.deref.json +3153 -2445
- package/generated/ghes-3.9.json +802 -632
- 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": "
|
|
4
|
+
"version": "15.0.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": {
|
|
@@ -7981,7 +7981,6 @@
|
|
|
7981
7981
|
"default": {
|
|
7982
7982
|
"value": {
|
|
7983
7983
|
"advanced_security_enabled_for_new_repositories": true,
|
|
7984
|
-
"advanced_security_enabled_new_user_namespace_repos": true,
|
|
7985
7984
|
"dependabot_alerts_enabled_for_new_repositories": true,
|
|
7986
7985
|
"secret_scanning_enabled_for_new_repositories": true,
|
|
7987
7986
|
"secret_scanning_push_protection_enabled_for_new_repositories": true,
|
|
@@ -8344,7 +8343,7 @@
|
|
|
8344
8343
|
"/feeds": {
|
|
8345
8344
|
"get": {
|
|
8346
8345
|
"summary": "Get feeds",
|
|
8347
|
-
"description": "
|
|
8346
|
+
"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
8347
|
"tags": [
|
|
8349
8348
|
"activity"
|
|
8350
8349
|
],
|
|
@@ -10863,7 +10862,7 @@
|
|
|
10863
10862
|
"/organizations": {
|
|
10864
10863
|
"get": {
|
|
10865
10864
|
"summary": "List organizations",
|
|
10866
|
-
"description": "Lists all organizations, in the order that they were created
|
|
10865
|
+
"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
10866
|
"tags": [
|
|
10868
10867
|
"orgs"
|
|
10869
10868
|
],
|
|
@@ -15401,7 +15400,7 @@
|
|
|
15401
15400
|
"/orgs/{org}/hooks": {
|
|
15402
15401
|
"get": {
|
|
15403
15402
|
"summary": "List organization webhooks",
|
|
15404
|
-
"description": "",
|
|
15403
|
+
"description": "You must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.",
|
|
15405
15404
|
"tags": [
|
|
15406
15405
|
"orgs"
|
|
15407
15406
|
],
|
|
@@ -15459,7 +15458,7 @@
|
|
|
15459
15458
|
},
|
|
15460
15459
|
"post": {
|
|
15461
15460
|
"summary": "Create an organization webhook",
|
|
15462
|
-
"description": "
|
|
15461
|
+
"description": "Create a hook that posts payloads in JSON format.\n\nYou must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or \nedit webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.",
|
|
15463
15462
|
"tags": [
|
|
15464
15463
|
"orgs"
|
|
15465
15464
|
],
|
|
@@ -15596,7 +15595,7 @@
|
|
|
15596
15595
|
"/orgs/{org}/hooks/{hook_id}": {
|
|
15597
15596
|
"get": {
|
|
15598
15597
|
"summary": "Get an organization webhook",
|
|
15599
|
-
"description": "Returns a webhook configured in an organization. To get only the webhook
|
|
15598
|
+
"description": "Returns a webhook configured in an organization. To get only the webhook\n`config` properties, see \"[Get a webhook configuration for an organization](/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization). \n\nYou must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.",
|
|
15600
15599
|
"tags": [
|
|
15601
15600
|
"orgs"
|
|
15602
15601
|
],
|
|
@@ -15643,7 +15642,7 @@
|
|
|
15643
15642
|
},
|
|
15644
15643
|
"patch": {
|
|
15645
15644
|
"summary": "Update an organization webhook",
|
|
15646
|
-
"description": "Updates a webhook configured in an organization. When you update a webhook
|
|
15645
|
+
"description": "Updates a webhook configured in an organization. When you update a webhook,\nthe `secret` will be overwritten. If you previously had a `secret` set, you must\nprovide the same `secret` or set a new `secret` or the secret will be removed. If\nyou are only updating individual webhook `config` properties, use \"[Update a webhook\nconfiguration for an organization](/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization)\". \n\nYou must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.",
|
|
15647
15646
|
"tags": [
|
|
15648
15647
|
"orgs"
|
|
15649
15648
|
],
|
|
@@ -15755,7 +15754,7 @@
|
|
|
15755
15754
|
},
|
|
15756
15755
|
"delete": {
|
|
15757
15756
|
"summary": "Delete an organization webhook",
|
|
15758
|
-
"description": "",
|
|
15757
|
+
"description": "You must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.",
|
|
15759
15758
|
"tags": [
|
|
15760
15759
|
"orgs"
|
|
15761
15760
|
],
|
|
@@ -15792,7 +15791,7 @@
|
|
|
15792
15791
|
"/orgs/{org}/hooks/{hook_id}/config": {
|
|
15793
15792
|
"get": {
|
|
15794
15793
|
"summary": "Get a webhook configuration for an organization",
|
|
15795
|
-
"description": "Returns the webhook configuration for an organization. To get more information about the webhook, including the `active` state and `events`, use \"[Get an organization webhook ](/rest/orgs/webhooks#get-an-organization-webhook).\"\n\nOAuth app tokens and personal access tokens (classic) need
|
|
15794
|
+
"description": "Returns the webhook configuration for an organization. To get more information about the webhook, including the `active` state and `events`, use \"[Get an organization webhook ](/rest/orgs/webhooks#get-an-organization-webhook).\"\n\nYou must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.",
|
|
15796
15795
|
"tags": [
|
|
15797
15796
|
"orgs"
|
|
15798
15797
|
],
|
|
@@ -15836,7 +15835,7 @@
|
|
|
15836
15835
|
},
|
|
15837
15836
|
"patch": {
|
|
15838
15837
|
"summary": "Update a webhook configuration for an organization",
|
|
15839
|
-
"description": "Updates the webhook configuration for an organization. To update more information about the webhook, including the `active` state and `events`, use \"[Update an organization webhook ](/rest/orgs/webhooks#update-an-organization-webhook).\"\n\nOAuth app tokens and personal access tokens (classic) need
|
|
15838
|
+
"description": "Updates the webhook configuration for an organization. To update more information about the webhook, including the `active` state and `events`, use \"[Update an organization webhook ](/rest/orgs/webhooks#update-an-organization-webhook).\"\n\nYou must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.",
|
|
15840
15839
|
"tags": [
|
|
15841
15840
|
"orgs"
|
|
15842
15841
|
],
|
|
@@ -15917,7 +15916,7 @@
|
|
|
15917
15916
|
"/orgs/{org}/hooks/{hook_id}/deliveries": {
|
|
15918
15917
|
"get": {
|
|
15919
15918
|
"summary": "List deliveries for an organization webhook",
|
|
15920
|
-
"description": "Returns a list of webhook deliveries for a webhook configured in an organization.",
|
|
15919
|
+
"description": "Returns a list of webhook deliveries for a webhook configured in an organization.\n\nYou must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.",
|
|
15921
15920
|
"tags": [
|
|
15922
15921
|
"orgs"
|
|
15923
15922
|
],
|
|
@@ -15986,7 +15985,7 @@
|
|
|
15986
15985
|
"/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}": {
|
|
15987
15986
|
"get": {
|
|
15988
15987
|
"summary": "Get a webhook delivery for an organization webhook",
|
|
15989
|
-
"description": "Returns a delivery for a webhook configured in an organization.",
|
|
15988
|
+
"description": "Returns a delivery for a webhook configured in an organization.\n\nYou must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.",
|
|
15990
15989
|
"tags": [
|
|
15991
15990
|
"orgs"
|
|
15992
15991
|
],
|
|
@@ -16041,7 +16040,7 @@
|
|
|
16041
16040
|
"/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts": {
|
|
16042
16041
|
"post": {
|
|
16043
16042
|
"summary": "Redeliver a delivery for an organization webhook",
|
|
16044
|
-
"description": "Redeliver a delivery for a webhook configured in an organization.",
|
|
16043
|
+
"description": "Redeliver a delivery for a webhook configured in an organization.\n\nYou must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.",
|
|
16045
16044
|
"tags": [
|
|
16046
16045
|
"orgs"
|
|
16047
16046
|
],
|
|
@@ -16084,7 +16083,7 @@
|
|
|
16084
16083
|
"/orgs/{org}/hooks/{hook_id}/pings": {
|
|
16085
16084
|
"post": {
|
|
16086
16085
|
"summary": "Ping an organization webhook",
|
|
16087
|
-
"description": "This will trigger a [ping event](https://docs.github.com/enterprise-server@3.8/webhooks/#ping-event)
|
|
16086
|
+
"description": "This will trigger a [ping event](https://docs.github.com/enterprise-server@3.8/webhooks/#ping-event)\nto be sent to the hook.\n\nYou must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.",
|
|
16088
16087
|
"tags": [
|
|
16089
16088
|
"orgs"
|
|
16090
16089
|
],
|
|
@@ -24645,7 +24644,7 @@
|
|
|
24645
24644
|
"/repos/{owner}/{repo}/actions/runs": {
|
|
24646
24645
|
"get": {
|
|
24647
24646
|
"summary": "List workflow runs for a repository",
|
|
24648
|
-
"description": "Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.8/rest/guides/getting-started-with-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository
|
|
24647
|
+
"description": "Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.8/rest/guides/getting-started-with-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.\n\nThis API will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`.",
|
|
24649
24648
|
"tags": [
|
|
24650
24649
|
"actions"
|
|
24651
24650
|
],
|
|
@@ -30198,11 +30197,14 @@
|
|
|
30198
30197
|
},
|
|
30199
30198
|
"status": {
|
|
30200
30199
|
"type": "string",
|
|
30201
|
-
"description": "The current status.",
|
|
30200
|
+
"description": "The current status of the check run. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`.",
|
|
30202
30201
|
"enum": [
|
|
30203
30202
|
"queued",
|
|
30204
30203
|
"in_progress",
|
|
30205
|
-
"completed"
|
|
30204
|
+
"completed",
|
|
30205
|
+
"waiting",
|
|
30206
|
+
"requested",
|
|
30207
|
+
"pending"
|
|
30206
30208
|
]
|
|
30207
30209
|
},
|
|
30208
30210
|
"conclusion": {
|
|
@@ -32708,6 +32710,9 @@
|
|
|
32708
32710
|
}
|
|
32709
32711
|
}
|
|
32710
32712
|
},
|
|
32713
|
+
"409": {
|
|
32714
|
+
"$ref": "#/components/responses/conflict"
|
|
32715
|
+
},
|
|
32711
32716
|
"422": {
|
|
32712
32717
|
"$ref": "#/components/responses/validation_failed"
|
|
32713
32718
|
}
|
|
@@ -32939,6 +32944,9 @@
|
|
|
32939
32944
|
"$ref": "#/components/headers/link"
|
|
32940
32945
|
}
|
|
32941
32946
|
}
|
|
32947
|
+
},
|
|
32948
|
+
"409": {
|
|
32949
|
+
"$ref": "#/components/responses/conflict"
|
|
32942
32950
|
}
|
|
32943
32951
|
},
|
|
32944
32952
|
"x-github": {
|
|
@@ -32998,6 +33006,9 @@
|
|
|
32998
33006
|
"404": {
|
|
32999
33007
|
"$ref": "#/components/responses/not_found"
|
|
33000
33008
|
},
|
|
33009
|
+
"409": {
|
|
33010
|
+
"$ref": "#/components/responses/conflict"
|
|
33011
|
+
},
|
|
33001
33012
|
"422": {
|
|
33002
33013
|
"$ref": "#/components/responses/validation_failed"
|
|
33003
33014
|
},
|
|
@@ -33335,7 +33346,7 @@
|
|
|
33335
33346
|
"/repos/{owner}/{repo}/compare/{basehead}": {
|
|
33336
33347
|
"get": {
|
|
33337
33348
|
"summary": "Compare two commits",
|
|
33338
|
-
"description": "Compares two commits against one another. You can compare branches in the same repository, or you can compare
|
|
33349
|
+
"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
33350
|
"tags": [
|
|
33340
33351
|
"repos"
|
|
33341
33352
|
],
|
|
@@ -35299,6 +35310,9 @@
|
|
|
35299
35310
|
"204": {
|
|
35300
35311
|
"description": "Response"
|
|
35301
35312
|
},
|
|
35313
|
+
"404": {
|
|
35314
|
+
"$ref": "#/components/responses/not_found"
|
|
35315
|
+
},
|
|
35302
35316
|
"422": {
|
|
35303
35317
|
"$ref": "#/components/responses/validation_failed"
|
|
35304
35318
|
}
|
|
@@ -35886,6 +35900,616 @@
|
|
|
35886
35900
|
"x-octokit": {}
|
|
35887
35901
|
}
|
|
35888
35902
|
},
|
|
35903
|
+
"/repos/{owner}/{repo}/environments/{environment_name}/secrets": {
|
|
35904
|
+
"get": {
|
|
35905
|
+
"summary": "List environment secrets",
|
|
35906
|
+
"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.",
|
|
35907
|
+
"tags": [
|
|
35908
|
+
"actions"
|
|
35909
|
+
],
|
|
35910
|
+
"operationId": "actions/list-environment-secrets",
|
|
35911
|
+
"externalDocs": {
|
|
35912
|
+
"description": "API method documentation",
|
|
35913
|
+
"url": "https://docs.github.com/enterprise-server@3.8/rest/actions/secrets#list-environment-secrets"
|
|
35914
|
+
},
|
|
35915
|
+
"parameters": [
|
|
35916
|
+
{
|
|
35917
|
+
"$ref": "#/components/parameters/owner"
|
|
35918
|
+
},
|
|
35919
|
+
{
|
|
35920
|
+
"$ref": "#/components/parameters/repo"
|
|
35921
|
+
},
|
|
35922
|
+
{
|
|
35923
|
+
"$ref": "#/components/parameters/environment-name"
|
|
35924
|
+
},
|
|
35925
|
+
{
|
|
35926
|
+
"$ref": "#/components/parameters/per-page"
|
|
35927
|
+
},
|
|
35928
|
+
{
|
|
35929
|
+
"$ref": "#/components/parameters/page"
|
|
35930
|
+
}
|
|
35931
|
+
],
|
|
35932
|
+
"responses": {
|
|
35933
|
+
"200": {
|
|
35934
|
+
"description": "Response",
|
|
35935
|
+
"content": {
|
|
35936
|
+
"application/json": {
|
|
35937
|
+
"schema": {
|
|
35938
|
+
"type": "object",
|
|
35939
|
+
"required": [
|
|
35940
|
+
"total_count",
|
|
35941
|
+
"secrets"
|
|
35942
|
+
],
|
|
35943
|
+
"properties": {
|
|
35944
|
+
"total_count": {
|
|
35945
|
+
"type": "integer"
|
|
35946
|
+
},
|
|
35947
|
+
"secrets": {
|
|
35948
|
+
"type": "array",
|
|
35949
|
+
"items": {
|
|
35950
|
+
"$ref": "#/components/schemas/actions-secret"
|
|
35951
|
+
}
|
|
35952
|
+
}
|
|
35953
|
+
}
|
|
35954
|
+
},
|
|
35955
|
+
"examples": {
|
|
35956
|
+
"default": {
|
|
35957
|
+
"$ref": "#/components/examples/actions-secret-paginated"
|
|
35958
|
+
}
|
|
35959
|
+
}
|
|
35960
|
+
}
|
|
35961
|
+
},
|
|
35962
|
+
"headers": {
|
|
35963
|
+
"Link": {
|
|
35964
|
+
"$ref": "#/components/headers/link"
|
|
35965
|
+
}
|
|
35966
|
+
}
|
|
35967
|
+
}
|
|
35968
|
+
},
|
|
35969
|
+
"x-github": {
|
|
35970
|
+
"githubCloudOnly": false,
|
|
35971
|
+
"enabledForGitHubApps": true,
|
|
35972
|
+
"category": "actions",
|
|
35973
|
+
"subcategory": "secrets"
|
|
35974
|
+
},
|
|
35975
|
+
"x-octokit": {}
|
|
35976
|
+
}
|
|
35977
|
+
},
|
|
35978
|
+
"/repos/{owner}/{repo}/environments/{environment_name}/secrets/public-key": {
|
|
35979
|
+
"get": {
|
|
35980
|
+
"summary": "Get an environment public key",
|
|
35981
|
+
"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.",
|
|
35982
|
+
"tags": [
|
|
35983
|
+
"actions"
|
|
35984
|
+
],
|
|
35985
|
+
"operationId": "actions/get-environment-public-key",
|
|
35986
|
+
"externalDocs": {
|
|
35987
|
+
"description": "API method documentation",
|
|
35988
|
+
"url": "https://docs.github.com/enterprise-server@3.8/rest/actions/secrets#get-an-environment-public-key"
|
|
35989
|
+
},
|
|
35990
|
+
"parameters": [
|
|
35991
|
+
{
|
|
35992
|
+
"$ref": "#/components/parameters/owner"
|
|
35993
|
+
},
|
|
35994
|
+
{
|
|
35995
|
+
"$ref": "#/components/parameters/repo"
|
|
35996
|
+
},
|
|
35997
|
+
{
|
|
35998
|
+
"$ref": "#/components/parameters/environment-name"
|
|
35999
|
+
}
|
|
36000
|
+
],
|
|
36001
|
+
"responses": {
|
|
36002
|
+
"200": {
|
|
36003
|
+
"description": "Response",
|
|
36004
|
+
"content": {
|
|
36005
|
+
"application/json": {
|
|
36006
|
+
"schema": {
|
|
36007
|
+
"$ref": "#/components/schemas/actions-public-key"
|
|
36008
|
+
},
|
|
36009
|
+
"examples": {
|
|
36010
|
+
"default": {
|
|
36011
|
+
"$ref": "#/components/examples/actions-public-key"
|
|
36012
|
+
}
|
|
36013
|
+
}
|
|
36014
|
+
}
|
|
36015
|
+
}
|
|
36016
|
+
}
|
|
36017
|
+
},
|
|
36018
|
+
"x-github": {
|
|
36019
|
+
"githubCloudOnly": false,
|
|
36020
|
+
"enabledForGitHubApps": true,
|
|
36021
|
+
"category": "actions",
|
|
36022
|
+
"subcategory": "secrets"
|
|
36023
|
+
},
|
|
36024
|
+
"x-octokit": {}
|
|
36025
|
+
}
|
|
36026
|
+
},
|
|
36027
|
+
"/repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}": {
|
|
36028
|
+
"get": {
|
|
36029
|
+
"summary": "Get an environment secret",
|
|
36030
|
+
"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.",
|
|
36031
|
+
"tags": [
|
|
36032
|
+
"actions"
|
|
36033
|
+
],
|
|
36034
|
+
"operationId": "actions/get-environment-secret",
|
|
36035
|
+
"externalDocs": {
|
|
36036
|
+
"description": "API method documentation",
|
|
36037
|
+
"url": "https://docs.github.com/enterprise-server@3.8/rest/actions/secrets#get-an-environment-secret"
|
|
36038
|
+
},
|
|
36039
|
+
"parameters": [
|
|
36040
|
+
{
|
|
36041
|
+
"$ref": "#/components/parameters/owner"
|
|
36042
|
+
},
|
|
36043
|
+
{
|
|
36044
|
+
"$ref": "#/components/parameters/repo"
|
|
36045
|
+
},
|
|
36046
|
+
{
|
|
36047
|
+
"$ref": "#/components/parameters/environment-name"
|
|
36048
|
+
},
|
|
36049
|
+
{
|
|
36050
|
+
"$ref": "#/components/parameters/secret-name"
|
|
36051
|
+
}
|
|
36052
|
+
],
|
|
36053
|
+
"responses": {
|
|
36054
|
+
"200": {
|
|
36055
|
+
"description": "Response",
|
|
36056
|
+
"content": {
|
|
36057
|
+
"application/json": {
|
|
36058
|
+
"schema": {
|
|
36059
|
+
"$ref": "#/components/schemas/actions-secret"
|
|
36060
|
+
},
|
|
36061
|
+
"examples": {
|
|
36062
|
+
"default": {
|
|
36063
|
+
"$ref": "#/components/examples/actions-secret"
|
|
36064
|
+
}
|
|
36065
|
+
}
|
|
36066
|
+
}
|
|
36067
|
+
}
|
|
36068
|
+
}
|
|
36069
|
+
},
|
|
36070
|
+
"x-github": {
|
|
36071
|
+
"githubCloudOnly": false,
|
|
36072
|
+
"enabledForGitHubApps": true,
|
|
36073
|
+
"category": "actions",
|
|
36074
|
+
"subcategory": "secrets"
|
|
36075
|
+
},
|
|
36076
|
+
"x-octokit": {}
|
|
36077
|
+
},
|
|
36078
|
+
"put": {
|
|
36079
|
+
"summary": "Create or update an environment secret",
|
|
36080
|
+
"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.",
|
|
36081
|
+
"tags": [
|
|
36082
|
+
"actions"
|
|
36083
|
+
],
|
|
36084
|
+
"operationId": "actions/create-or-update-environment-secret",
|
|
36085
|
+
"externalDocs": {
|
|
36086
|
+
"description": "API method documentation",
|
|
36087
|
+
"url": "https://docs.github.com/enterprise-server@3.8/rest/actions/secrets#create-or-update-an-environment-secret"
|
|
36088
|
+
},
|
|
36089
|
+
"parameters": [
|
|
36090
|
+
{
|
|
36091
|
+
"$ref": "#/components/parameters/owner"
|
|
36092
|
+
},
|
|
36093
|
+
{
|
|
36094
|
+
"$ref": "#/components/parameters/repo"
|
|
36095
|
+
},
|
|
36096
|
+
{
|
|
36097
|
+
"$ref": "#/components/parameters/environment-name"
|
|
36098
|
+
},
|
|
36099
|
+
{
|
|
36100
|
+
"$ref": "#/components/parameters/secret-name"
|
|
36101
|
+
}
|
|
36102
|
+
],
|
|
36103
|
+
"requestBody": {
|
|
36104
|
+
"required": true,
|
|
36105
|
+
"content": {
|
|
36106
|
+
"application/json": {
|
|
36107
|
+
"schema": {
|
|
36108
|
+
"type": "object",
|
|
36109
|
+
"properties": {
|
|
36110
|
+
"encrypted_value": {
|
|
36111
|
+
"type": "string",
|
|
36112
|
+
"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.",
|
|
36113
|
+
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$"
|
|
36114
|
+
},
|
|
36115
|
+
"key_id": {
|
|
36116
|
+
"type": "string",
|
|
36117
|
+
"description": "ID of the key you used to encrypt the secret."
|
|
36118
|
+
}
|
|
36119
|
+
},
|
|
36120
|
+
"required": [
|
|
36121
|
+
"encrypted_value",
|
|
36122
|
+
"key_id"
|
|
36123
|
+
]
|
|
36124
|
+
},
|
|
36125
|
+
"examples": {
|
|
36126
|
+
"default": {
|
|
36127
|
+
"value": {
|
|
36128
|
+
"encrypted_value": "c2VjcmV0",
|
|
36129
|
+
"key_id": "012345678912345678"
|
|
36130
|
+
}
|
|
36131
|
+
}
|
|
36132
|
+
}
|
|
36133
|
+
}
|
|
36134
|
+
}
|
|
36135
|
+
},
|
|
36136
|
+
"responses": {
|
|
36137
|
+
"201": {
|
|
36138
|
+
"description": "Response when creating a secret",
|
|
36139
|
+
"content": {
|
|
36140
|
+
"application/json": {
|
|
36141
|
+
"schema": {
|
|
36142
|
+
"$ref": "#/components/schemas/empty-object"
|
|
36143
|
+
},
|
|
36144
|
+
"examples": {
|
|
36145
|
+
"default": {
|
|
36146
|
+
"value": null
|
|
36147
|
+
}
|
|
36148
|
+
}
|
|
36149
|
+
}
|
|
36150
|
+
}
|
|
36151
|
+
},
|
|
36152
|
+
"204": {
|
|
36153
|
+
"description": "Response when updating a secret"
|
|
36154
|
+
}
|
|
36155
|
+
},
|
|
36156
|
+
"x-github": {
|
|
36157
|
+
"githubCloudOnly": false,
|
|
36158
|
+
"enabledForGitHubApps": true,
|
|
36159
|
+
"category": "actions",
|
|
36160
|
+
"subcategory": "secrets"
|
|
36161
|
+
},
|
|
36162
|
+
"x-octokit": {}
|
|
36163
|
+
},
|
|
36164
|
+
"delete": {
|
|
36165
|
+
"summary": "Delete an environment secret",
|
|
36166
|
+
"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.",
|
|
36167
|
+
"tags": [
|
|
36168
|
+
"actions"
|
|
36169
|
+
],
|
|
36170
|
+
"operationId": "actions/delete-environment-secret",
|
|
36171
|
+
"externalDocs": {
|
|
36172
|
+
"description": "API method documentation",
|
|
36173
|
+
"url": "https://docs.github.com/enterprise-server@3.8/rest/actions/secrets#delete-an-environment-secret"
|
|
36174
|
+
},
|
|
36175
|
+
"parameters": [
|
|
36176
|
+
{
|
|
36177
|
+
"$ref": "#/components/parameters/owner"
|
|
36178
|
+
},
|
|
36179
|
+
{
|
|
36180
|
+
"$ref": "#/components/parameters/repo"
|
|
36181
|
+
},
|
|
36182
|
+
{
|
|
36183
|
+
"$ref": "#/components/parameters/environment-name"
|
|
36184
|
+
},
|
|
36185
|
+
{
|
|
36186
|
+
"$ref": "#/components/parameters/secret-name"
|
|
36187
|
+
}
|
|
36188
|
+
],
|
|
36189
|
+
"responses": {
|
|
36190
|
+
"204": {
|
|
36191
|
+
"description": "Default response"
|
|
36192
|
+
}
|
|
36193
|
+
},
|
|
36194
|
+
"x-github": {
|
|
36195
|
+
"githubCloudOnly": false,
|
|
36196
|
+
"enabledForGitHubApps": true,
|
|
36197
|
+
"category": "actions",
|
|
36198
|
+
"subcategory": "secrets"
|
|
36199
|
+
},
|
|
36200
|
+
"x-octokit": {}
|
|
36201
|
+
}
|
|
36202
|
+
},
|
|
36203
|
+
"/repos/{owner}/{repo}/environments/{environment_name}/variables": {
|
|
36204
|
+
"get": {
|
|
36205
|
+
"summary": "List environment variables",
|
|
36206
|
+
"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.",
|
|
36207
|
+
"tags": [
|
|
36208
|
+
"actions"
|
|
36209
|
+
],
|
|
36210
|
+
"operationId": "actions/list-environment-variables",
|
|
36211
|
+
"externalDocs": {
|
|
36212
|
+
"description": "API method documentation",
|
|
36213
|
+
"url": "https://docs.github.com/enterprise-server@3.8/rest/actions/variables#list-environment-variables"
|
|
36214
|
+
},
|
|
36215
|
+
"parameters": [
|
|
36216
|
+
{
|
|
36217
|
+
"$ref": "#/components/parameters/owner"
|
|
36218
|
+
},
|
|
36219
|
+
{
|
|
36220
|
+
"$ref": "#/components/parameters/repo"
|
|
36221
|
+
},
|
|
36222
|
+
{
|
|
36223
|
+
"$ref": "#/components/parameters/environment-name"
|
|
36224
|
+
},
|
|
36225
|
+
{
|
|
36226
|
+
"$ref": "#/components/parameters/variables-per-page"
|
|
36227
|
+
},
|
|
36228
|
+
{
|
|
36229
|
+
"$ref": "#/components/parameters/page"
|
|
36230
|
+
}
|
|
36231
|
+
],
|
|
36232
|
+
"responses": {
|
|
36233
|
+
"200": {
|
|
36234
|
+
"description": "Response",
|
|
36235
|
+
"content": {
|
|
36236
|
+
"application/json": {
|
|
36237
|
+
"schema": {
|
|
36238
|
+
"type": "object",
|
|
36239
|
+
"required": [
|
|
36240
|
+
"total_count",
|
|
36241
|
+
"variables"
|
|
36242
|
+
],
|
|
36243
|
+
"properties": {
|
|
36244
|
+
"total_count": {
|
|
36245
|
+
"type": "integer"
|
|
36246
|
+
},
|
|
36247
|
+
"variables": {
|
|
36248
|
+
"type": "array",
|
|
36249
|
+
"items": {
|
|
36250
|
+
"$ref": "#/components/schemas/actions-variable"
|
|
36251
|
+
}
|
|
36252
|
+
}
|
|
36253
|
+
}
|
|
36254
|
+
},
|
|
36255
|
+
"examples": {
|
|
36256
|
+
"default": {
|
|
36257
|
+
"$ref": "#/components/examples/actions-variables-paginated"
|
|
36258
|
+
}
|
|
36259
|
+
}
|
|
36260
|
+
}
|
|
36261
|
+
},
|
|
36262
|
+
"headers": {
|
|
36263
|
+
"Link": {
|
|
36264
|
+
"$ref": "#/components/headers/link"
|
|
36265
|
+
}
|
|
36266
|
+
}
|
|
36267
|
+
}
|
|
36268
|
+
},
|
|
36269
|
+
"x-github": {
|
|
36270
|
+
"githubCloudOnly": false,
|
|
36271
|
+
"enabledForGitHubApps": true,
|
|
36272
|
+
"category": "actions",
|
|
36273
|
+
"subcategory": "variables"
|
|
36274
|
+
},
|
|
36275
|
+
"x-octokit": {}
|
|
36276
|
+
},
|
|
36277
|
+
"post": {
|
|
36278
|
+
"summary": "Create an environment variable",
|
|
36279
|
+
"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.",
|
|
36280
|
+
"tags": [
|
|
36281
|
+
"actions"
|
|
36282
|
+
],
|
|
36283
|
+
"operationId": "actions/create-environment-variable",
|
|
36284
|
+
"externalDocs": {
|
|
36285
|
+
"description": "API method documentation",
|
|
36286
|
+
"url": "https://docs.github.com/enterprise-server@3.8/rest/actions/variables#create-an-environment-variable"
|
|
36287
|
+
},
|
|
36288
|
+
"parameters": [
|
|
36289
|
+
{
|
|
36290
|
+
"$ref": "#/components/parameters/owner"
|
|
36291
|
+
},
|
|
36292
|
+
{
|
|
36293
|
+
"$ref": "#/components/parameters/repo"
|
|
36294
|
+
},
|
|
36295
|
+
{
|
|
36296
|
+
"$ref": "#/components/parameters/environment-name"
|
|
36297
|
+
}
|
|
36298
|
+
],
|
|
36299
|
+
"requestBody": {
|
|
36300
|
+
"required": true,
|
|
36301
|
+
"content": {
|
|
36302
|
+
"application/json": {
|
|
36303
|
+
"schema": {
|
|
36304
|
+
"type": "object",
|
|
36305
|
+
"properties": {
|
|
36306
|
+
"name": {
|
|
36307
|
+
"type": "string",
|
|
36308
|
+
"description": "The name of the variable."
|
|
36309
|
+
},
|
|
36310
|
+
"value": {
|
|
36311
|
+
"type": "string",
|
|
36312
|
+
"description": "The value of the variable."
|
|
36313
|
+
}
|
|
36314
|
+
},
|
|
36315
|
+
"required": [
|
|
36316
|
+
"name",
|
|
36317
|
+
"value"
|
|
36318
|
+
]
|
|
36319
|
+
},
|
|
36320
|
+
"examples": {
|
|
36321
|
+
"default": {
|
|
36322
|
+
"value": {
|
|
36323
|
+
"name": "USERNAME",
|
|
36324
|
+
"value": "octocat"
|
|
36325
|
+
}
|
|
36326
|
+
}
|
|
36327
|
+
}
|
|
36328
|
+
}
|
|
36329
|
+
}
|
|
36330
|
+
},
|
|
36331
|
+
"responses": {
|
|
36332
|
+
"201": {
|
|
36333
|
+
"description": "Response",
|
|
36334
|
+
"content": {
|
|
36335
|
+
"application/json": {
|
|
36336
|
+
"schema": {
|
|
36337
|
+
"$ref": "#/components/schemas/empty-object"
|
|
36338
|
+
},
|
|
36339
|
+
"examples": {
|
|
36340
|
+
"default": {
|
|
36341
|
+
"value": null
|
|
36342
|
+
}
|
|
36343
|
+
}
|
|
36344
|
+
}
|
|
36345
|
+
}
|
|
36346
|
+
}
|
|
36347
|
+
},
|
|
36348
|
+
"x-github": {
|
|
36349
|
+
"githubCloudOnly": false,
|
|
36350
|
+
"enabledForGitHubApps": true,
|
|
36351
|
+
"category": "actions",
|
|
36352
|
+
"subcategory": "variables"
|
|
36353
|
+
},
|
|
36354
|
+
"x-octokit": {}
|
|
36355
|
+
}
|
|
36356
|
+
},
|
|
36357
|
+
"/repos/{owner}/{repo}/environments/{environment_name}/variables/{name}": {
|
|
36358
|
+
"get": {
|
|
36359
|
+
"summary": "Get an environment variable",
|
|
36360
|
+
"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.",
|
|
36361
|
+
"tags": [
|
|
36362
|
+
"actions"
|
|
36363
|
+
],
|
|
36364
|
+
"operationId": "actions/get-environment-variable",
|
|
36365
|
+
"externalDocs": {
|
|
36366
|
+
"description": "API method documentation",
|
|
36367
|
+
"url": "https://docs.github.com/enterprise-server@3.8/rest/actions/variables#get-an-environment-variable"
|
|
36368
|
+
},
|
|
36369
|
+
"parameters": [
|
|
36370
|
+
{
|
|
36371
|
+
"$ref": "#/components/parameters/owner"
|
|
36372
|
+
},
|
|
36373
|
+
{
|
|
36374
|
+
"$ref": "#/components/parameters/repo"
|
|
36375
|
+
},
|
|
36376
|
+
{
|
|
36377
|
+
"$ref": "#/components/parameters/environment-name"
|
|
36378
|
+
},
|
|
36379
|
+
{
|
|
36380
|
+
"$ref": "#/components/parameters/variable-name"
|
|
36381
|
+
}
|
|
36382
|
+
],
|
|
36383
|
+
"responses": {
|
|
36384
|
+
"200": {
|
|
36385
|
+
"description": "Response",
|
|
36386
|
+
"content": {
|
|
36387
|
+
"application/json": {
|
|
36388
|
+
"schema": {
|
|
36389
|
+
"$ref": "#/components/schemas/actions-variable"
|
|
36390
|
+
},
|
|
36391
|
+
"examples": {
|
|
36392
|
+
"default": {
|
|
36393
|
+
"$ref": "#/components/examples/actions-variable"
|
|
36394
|
+
}
|
|
36395
|
+
}
|
|
36396
|
+
}
|
|
36397
|
+
}
|
|
36398
|
+
}
|
|
36399
|
+
},
|
|
36400
|
+
"x-github": {
|
|
36401
|
+
"githubCloudOnly": false,
|
|
36402
|
+
"enabledForGitHubApps": true,
|
|
36403
|
+
"category": "actions",
|
|
36404
|
+
"subcategory": "variables"
|
|
36405
|
+
},
|
|
36406
|
+
"x-octokit": {}
|
|
36407
|
+
},
|
|
36408
|
+
"patch": {
|
|
36409
|
+
"summary": "Update an environment variable",
|
|
36410
|
+
"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.",
|
|
36411
|
+
"tags": [
|
|
36412
|
+
"actions"
|
|
36413
|
+
],
|
|
36414
|
+
"operationId": "actions/update-environment-variable",
|
|
36415
|
+
"externalDocs": {
|
|
36416
|
+
"description": "API method documentation",
|
|
36417
|
+
"url": "https://docs.github.com/enterprise-server@3.8/rest/actions/variables#update-an-environment-variable"
|
|
36418
|
+
},
|
|
36419
|
+
"parameters": [
|
|
36420
|
+
{
|
|
36421
|
+
"$ref": "#/components/parameters/owner"
|
|
36422
|
+
},
|
|
36423
|
+
{
|
|
36424
|
+
"$ref": "#/components/parameters/repo"
|
|
36425
|
+
},
|
|
36426
|
+
{
|
|
36427
|
+
"$ref": "#/components/parameters/variable-name"
|
|
36428
|
+
},
|
|
36429
|
+
{
|
|
36430
|
+
"$ref": "#/components/parameters/environment-name"
|
|
36431
|
+
}
|
|
36432
|
+
],
|
|
36433
|
+
"requestBody": {
|
|
36434
|
+
"required": true,
|
|
36435
|
+
"content": {
|
|
36436
|
+
"application/json": {
|
|
36437
|
+
"schema": {
|
|
36438
|
+
"type": "object",
|
|
36439
|
+
"properties": {
|
|
36440
|
+
"name": {
|
|
36441
|
+
"type": "string",
|
|
36442
|
+
"description": "The name of the variable."
|
|
36443
|
+
},
|
|
36444
|
+
"value": {
|
|
36445
|
+
"type": "string",
|
|
36446
|
+
"description": "The value of the variable."
|
|
36447
|
+
}
|
|
36448
|
+
}
|
|
36449
|
+
},
|
|
36450
|
+
"examples": {
|
|
36451
|
+
"default": {
|
|
36452
|
+
"value": {
|
|
36453
|
+
"name": "USERNAME",
|
|
36454
|
+
"value": "octocat"
|
|
36455
|
+
}
|
|
36456
|
+
}
|
|
36457
|
+
}
|
|
36458
|
+
}
|
|
36459
|
+
}
|
|
36460
|
+
},
|
|
36461
|
+
"responses": {
|
|
36462
|
+
"204": {
|
|
36463
|
+
"description": "Response"
|
|
36464
|
+
}
|
|
36465
|
+
},
|
|
36466
|
+
"x-github": {
|
|
36467
|
+
"githubCloudOnly": false,
|
|
36468
|
+
"enabledForGitHubApps": true,
|
|
36469
|
+
"category": "actions",
|
|
36470
|
+
"subcategory": "variables"
|
|
36471
|
+
},
|
|
36472
|
+
"x-octokit": {}
|
|
36473
|
+
},
|
|
36474
|
+
"delete": {
|
|
36475
|
+
"summary": "Delete an environment variable",
|
|
36476
|
+
"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.",
|
|
36477
|
+
"tags": [
|
|
36478
|
+
"actions"
|
|
36479
|
+
],
|
|
36480
|
+
"operationId": "actions/delete-environment-variable",
|
|
36481
|
+
"externalDocs": {
|
|
36482
|
+
"description": "API method documentation",
|
|
36483
|
+
"url": "https://docs.github.com/enterprise-server@3.8/rest/actions/variables#delete-an-environment-variable"
|
|
36484
|
+
},
|
|
36485
|
+
"parameters": [
|
|
36486
|
+
{
|
|
36487
|
+
"$ref": "#/components/parameters/owner"
|
|
36488
|
+
},
|
|
36489
|
+
{
|
|
36490
|
+
"$ref": "#/components/parameters/repo"
|
|
36491
|
+
},
|
|
36492
|
+
{
|
|
36493
|
+
"$ref": "#/components/parameters/variable-name"
|
|
36494
|
+
},
|
|
36495
|
+
{
|
|
36496
|
+
"$ref": "#/components/parameters/environment-name"
|
|
36497
|
+
}
|
|
36498
|
+
],
|
|
36499
|
+
"responses": {
|
|
36500
|
+
"204": {
|
|
36501
|
+
"description": "Response"
|
|
36502
|
+
}
|
|
36503
|
+
},
|
|
36504
|
+
"x-github": {
|
|
36505
|
+
"githubCloudOnly": false,
|
|
36506
|
+
"enabledForGitHubApps": true,
|
|
36507
|
+
"category": "actions",
|
|
36508
|
+
"subcategory": "variables"
|
|
36509
|
+
},
|
|
36510
|
+
"x-octokit": {}
|
|
36511
|
+
}
|
|
36512
|
+
},
|
|
35889
36513
|
"/repos/{owner}/{repo}/events": {
|
|
35890
36514
|
"get": {
|
|
35891
36515
|
"summary": "List repository events",
|
|
@@ -36258,6 +36882,9 @@
|
|
|
36258
36882
|
"404": {
|
|
36259
36883
|
"$ref": "#/components/responses/not_found"
|
|
36260
36884
|
},
|
|
36885
|
+
"409": {
|
|
36886
|
+
"$ref": "#/components/responses/conflict"
|
|
36887
|
+
},
|
|
36261
36888
|
"422": {
|
|
36262
36889
|
"$ref": "#/components/responses/validation_failed"
|
|
36263
36890
|
}
|
|
@@ -36412,6 +37039,9 @@
|
|
|
36412
37039
|
"404": {
|
|
36413
37040
|
"$ref": "#/components/responses/not_found"
|
|
36414
37041
|
},
|
|
37042
|
+
"409": {
|
|
37043
|
+
"$ref": "#/components/responses/conflict"
|
|
37044
|
+
},
|
|
36415
37045
|
"422": {
|
|
36416
37046
|
"$ref": "#/components/responses/validation_failed"
|
|
36417
37047
|
}
|
|
@@ -36466,6 +37096,9 @@
|
|
|
36466
37096
|
},
|
|
36467
37097
|
"404": {
|
|
36468
37098
|
"$ref": "#/components/responses/not_found"
|
|
37099
|
+
},
|
|
37100
|
+
"409": {
|
|
37101
|
+
"$ref": "#/components/responses/conflict"
|
|
36469
37102
|
}
|
|
36470
37103
|
},
|
|
36471
37104
|
"x-github": {
|
|
@@ -36497,7 +37130,7 @@
|
|
|
36497
37130
|
"$ref": "#/components/parameters/repo"
|
|
36498
37131
|
},
|
|
36499
37132
|
{
|
|
36500
|
-
"$ref": "#/components/parameters/
|
|
37133
|
+
"$ref": "#/components/parameters/git-ref-only"
|
|
36501
37134
|
}
|
|
36502
37135
|
],
|
|
36503
37136
|
"responses": {
|
|
@@ -36523,6 +37156,9 @@
|
|
|
36523
37156
|
"$ref": "#/components/headers/link"
|
|
36524
37157
|
}
|
|
36525
37158
|
}
|
|
37159
|
+
},
|
|
37160
|
+
"409": {
|
|
37161
|
+
"$ref": "#/components/responses/conflict"
|
|
36526
37162
|
}
|
|
36527
37163
|
},
|
|
36528
37164
|
"x-github": {
|
|
@@ -36554,7 +37190,7 @@
|
|
|
36554
37190
|
"$ref": "#/components/parameters/repo"
|
|
36555
37191
|
},
|
|
36556
37192
|
{
|
|
36557
|
-
"$ref": "#/components/parameters/
|
|
37193
|
+
"$ref": "#/components/parameters/git-ref-only"
|
|
36558
37194
|
}
|
|
36559
37195
|
],
|
|
36560
37196
|
"responses": {
|
|
@@ -36575,6 +37211,9 @@
|
|
|
36575
37211
|
},
|
|
36576
37212
|
"404": {
|
|
36577
37213
|
"$ref": "#/components/responses/not_found"
|
|
37214
|
+
},
|
|
37215
|
+
"409": {
|
|
37216
|
+
"$ref": "#/components/responses/conflict"
|
|
36578
37217
|
}
|
|
36579
37218
|
},
|
|
36580
37219
|
"x-github": {
|
|
@@ -36662,6 +37301,9 @@
|
|
|
36662
37301
|
}
|
|
36663
37302
|
}
|
|
36664
37303
|
},
|
|
37304
|
+
"409": {
|
|
37305
|
+
"$ref": "#/components/responses/conflict"
|
|
37306
|
+
},
|
|
36665
37307
|
"422": {
|
|
36666
37308
|
"$ref": "#/components/responses/validation_failed"
|
|
36667
37309
|
}
|
|
@@ -36678,7 +37320,7 @@
|
|
|
36678
37320
|
"/repos/{owner}/{repo}/git/refs/{ref}": {
|
|
36679
37321
|
"patch": {
|
|
36680
37322
|
"summary": "Update a reference",
|
|
36681
|
-
"description": "",
|
|
37323
|
+
"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
37324
|
"tags": [
|
|
36683
37325
|
"git"
|
|
36684
37326
|
],
|
|
@@ -36695,15 +37337,7 @@
|
|
|
36695
37337
|
"$ref": "#/components/parameters/repo"
|
|
36696
37338
|
},
|
|
36697
37339
|
{
|
|
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
|
|
37340
|
+
"$ref": "#/components/parameters/git-ref-only"
|
|
36707
37341
|
}
|
|
36708
37342
|
],
|
|
36709
37343
|
"requestBody": {
|
|
@@ -36754,6 +37388,9 @@
|
|
|
36754
37388
|
}
|
|
36755
37389
|
}
|
|
36756
37390
|
},
|
|
37391
|
+
"409": {
|
|
37392
|
+
"$ref": "#/components/responses/conflict"
|
|
37393
|
+
},
|
|
36757
37394
|
"422": {
|
|
36758
37395
|
"$ref": "#/components/responses/validation_failed"
|
|
36759
37396
|
}
|
|
@@ -36768,7 +37405,7 @@
|
|
|
36768
37405
|
},
|
|
36769
37406
|
"delete": {
|
|
36770
37407
|
"summary": "Delete a reference",
|
|
36771
|
-
"description": "",
|
|
37408
|
+
"description": "Deletes the provided reference.",
|
|
36772
37409
|
"tags": [
|
|
36773
37410
|
"git"
|
|
36774
37411
|
],
|
|
@@ -36785,13 +37422,16 @@
|
|
|
36785
37422
|
"$ref": "#/components/parameters/repo"
|
|
36786
37423
|
},
|
|
36787
37424
|
{
|
|
36788
|
-
"$ref": "#/components/parameters/
|
|
37425
|
+
"$ref": "#/components/parameters/git-ref-only"
|
|
36789
37426
|
}
|
|
36790
37427
|
],
|
|
36791
37428
|
"responses": {
|
|
36792
37429
|
"204": {
|
|
36793
37430
|
"description": "Response"
|
|
36794
37431
|
},
|
|
37432
|
+
"409": {
|
|
37433
|
+
"$ref": "#/components/responses/conflict"
|
|
37434
|
+
},
|
|
36795
37435
|
"422": {
|
|
36796
37436
|
"$ref": "#/components/responses/validation_failed"
|
|
36797
37437
|
}
|
|
@@ -36926,6 +37566,9 @@
|
|
|
36926
37566
|
}
|
|
36927
37567
|
}
|
|
36928
37568
|
},
|
|
37569
|
+
"409": {
|
|
37570
|
+
"$ref": "#/components/responses/conflict"
|
|
37571
|
+
},
|
|
36929
37572
|
"422": {
|
|
36930
37573
|
"$ref": "#/components/responses/validation_failed"
|
|
36931
37574
|
}
|
|
@@ -36985,6 +37628,9 @@
|
|
|
36985
37628
|
},
|
|
36986
37629
|
"404": {
|
|
36987
37630
|
"$ref": "#/components/responses/not_found"
|
|
37631
|
+
},
|
|
37632
|
+
"409": {
|
|
37633
|
+
"$ref": "#/components/responses/conflict"
|
|
36988
37634
|
}
|
|
36989
37635
|
},
|
|
36990
37636
|
"x-github": {
|
|
@@ -37122,6 +37768,9 @@
|
|
|
37122
37768
|
"404": {
|
|
37123
37769
|
"$ref": "#/components/responses/not_found"
|
|
37124
37770
|
},
|
|
37771
|
+
"409": {
|
|
37772
|
+
"$ref": "#/components/responses/conflict"
|
|
37773
|
+
},
|
|
37125
37774
|
"422": {
|
|
37126
37775
|
"$ref": "#/components/responses/validation_failed"
|
|
37127
37776
|
}
|
|
@@ -37196,6 +37845,9 @@
|
|
|
37196
37845
|
"404": {
|
|
37197
37846
|
"$ref": "#/components/responses/not_found"
|
|
37198
37847
|
},
|
|
37848
|
+
"409": {
|
|
37849
|
+
"$ref": "#/components/responses/conflict"
|
|
37850
|
+
},
|
|
37199
37851
|
"422": {
|
|
37200
37852
|
"$ref": "#/components/responses/validation_failed"
|
|
37201
37853
|
}
|
|
@@ -44024,6 +44676,9 @@
|
|
|
44024
44676
|
"404": {
|
|
44025
44677
|
"$ref": "#/components/responses/not_found"
|
|
44026
44678
|
},
|
|
44679
|
+
"406": {
|
|
44680
|
+
"$ref": "#/components/responses/unacceptable"
|
|
44681
|
+
},
|
|
44027
44682
|
"500": {
|
|
44028
44683
|
"$ref": "#/components/responses/internal_error"
|
|
44029
44684
|
},
|
|
@@ -48950,587 +49605,7 @@
|
|
|
48950
49605
|
"x-octokit": {}
|
|
48951
49606
|
}
|
|
48952
49607
|
},
|
|
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": {
|
|
49608
|
+
"/scim/v2/enterprises/{enterprise}/Groups": {
|
|
49534
49609
|
"get": {
|
|
49535
49610
|
"summary": "List provisioned SCIM groups for an enterprise",
|
|
49536
49611
|
"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 +49644,9 @@
|
|
|
49569
49644
|
},
|
|
49570
49645
|
{
|
|
49571
49646
|
"$ref": "#/components/parameters/count"
|
|
49647
|
+
},
|
|
49648
|
+
{
|
|
49649
|
+
"$ref": "#/components/parameters/enterprise"
|
|
49572
49650
|
}
|
|
49573
49651
|
],
|
|
49574
49652
|
"responses": {
|
|
@@ -49622,6 +49700,11 @@
|
|
|
49622
49700
|
"description": "API method documentation",
|
|
49623
49701
|
"url": "https://docs.github.com/enterprise-server@3.8/rest/enterprise-admin/scim#provision-a-scim-enterprise-group"
|
|
49624
49702
|
},
|
|
49703
|
+
"parameters": [
|
|
49704
|
+
{
|
|
49705
|
+
"$ref": "#/components/parameters/enterprise"
|
|
49706
|
+
}
|
|
49707
|
+
],
|
|
49625
49708
|
"requestBody": {
|
|
49626
49709
|
"required": true,
|
|
49627
49710
|
"content": {
|
|
@@ -49687,7 +49770,7 @@
|
|
|
49687
49770
|
"x-octokit": {}
|
|
49688
49771
|
}
|
|
49689
49772
|
},
|
|
49690
|
-
"/scim/v2/Groups/{scim_group_id}": {
|
|
49773
|
+
"/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}": {
|
|
49691
49774
|
"get": {
|
|
49692
49775
|
"summary": "Get SCIM provisioning information for an enterprise group",
|
|
49693
49776
|
"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 +49788,9 @@
|
|
|
49705
49788
|
},
|
|
49706
49789
|
{
|
|
49707
49790
|
"$ref": "#/components/parameters/excluded-attributes"
|
|
49791
|
+
},
|
|
49792
|
+
{
|
|
49793
|
+
"$ref": "#/components/parameters/enterprise"
|
|
49708
49794
|
}
|
|
49709
49795
|
],
|
|
49710
49796
|
"responses": {
|
|
@@ -49764,6 +49850,9 @@
|
|
|
49764
49850
|
"parameters": [
|
|
49765
49851
|
{
|
|
49766
49852
|
"$ref": "#/components/parameters/scim-group-id"
|
|
49853
|
+
},
|
|
49854
|
+
{
|
|
49855
|
+
"$ref": "#/components/parameters/enterprise"
|
|
49767
49856
|
}
|
|
49768
49857
|
],
|
|
49769
49858
|
"requestBody": {
|
|
@@ -49871,6 +49960,9 @@
|
|
|
49871
49960
|
"parameters": [
|
|
49872
49961
|
{
|
|
49873
49962
|
"$ref": "#/components/parameters/scim-group-id"
|
|
49963
|
+
},
|
|
49964
|
+
{
|
|
49965
|
+
"$ref": "#/components/parameters/enterprise"
|
|
49874
49966
|
}
|
|
49875
49967
|
],
|
|
49876
49968
|
"requestBody": {
|
|
@@ -49988,6 +50080,9 @@
|
|
|
49988
50080
|
"parameters": [
|
|
49989
50081
|
{
|
|
49990
50082
|
"$ref": "#/components/parameters/scim-group-id"
|
|
50083
|
+
},
|
|
50084
|
+
{
|
|
50085
|
+
"$ref": "#/components/parameters/enterprise"
|
|
49991
50086
|
}
|
|
49992
50087
|
],
|
|
49993
50088
|
"responses": {
|
|
@@ -50022,7 +50117,7 @@
|
|
|
50022
50117
|
"x-octokit": {}
|
|
50023
50118
|
}
|
|
50024
50119
|
},
|
|
50025
|
-
"/scim/v2/Users": {
|
|
50120
|
+
"/scim/v2/enterprises/{enterprise}/Users": {
|
|
50026
50121
|
"get": {
|
|
50027
50122
|
"summary": "List SCIM provisioned identities for an enterprise",
|
|
50028
50123
|
"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 +50152,9 @@
|
|
|
50057
50152
|
},
|
|
50058
50153
|
{
|
|
50059
50154
|
"$ref": "#/components/parameters/count"
|
|
50155
|
+
},
|
|
50156
|
+
{
|
|
50157
|
+
"$ref": "#/components/parameters/enterprise"
|
|
50060
50158
|
}
|
|
50061
50159
|
],
|
|
50062
50160
|
"responses": {
|
|
@@ -50110,6 +50208,11 @@
|
|
|
50110
50208
|
"description": "API method documentation",
|
|
50111
50209
|
"url": "https://docs.github.com/enterprise-server@3.8/rest/enterprise-admin/scim#provision-a-scim-enterprise-user"
|
|
50112
50210
|
},
|
|
50211
|
+
"parameters": [
|
|
50212
|
+
{
|
|
50213
|
+
"$ref": "#/components/parameters/enterprise"
|
|
50214
|
+
}
|
|
50215
|
+
],
|
|
50113
50216
|
"requestBody": {
|
|
50114
50217
|
"required": true,
|
|
50115
50218
|
"content": {
|
|
@@ -50175,7 +50278,7 @@
|
|
|
50175
50278
|
"x-octokit": {}
|
|
50176
50279
|
}
|
|
50177
50280
|
},
|
|
50178
|
-
"/scim/v2/Users/{scim_user_id}": {
|
|
50281
|
+
"/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}": {
|
|
50179
50282
|
"get": {
|
|
50180
50283
|
"summary": "Get SCIM provisioning information for an enterprise user",
|
|
50181
50284
|
"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 +50293,9 @@
|
|
|
50190
50293
|
"parameters": [
|
|
50191
50294
|
{
|
|
50192
50295
|
"$ref": "#/components/parameters/scim-user-id"
|
|
50296
|
+
},
|
|
50297
|
+
{
|
|
50298
|
+
"$ref": "#/components/parameters/enterprise"
|
|
50193
50299
|
}
|
|
50194
50300
|
],
|
|
50195
50301
|
"responses": {
|
|
@@ -50249,6 +50355,9 @@
|
|
|
50249
50355
|
"parameters": [
|
|
50250
50356
|
{
|
|
50251
50357
|
"$ref": "#/components/parameters/scim-user-id"
|
|
50358
|
+
},
|
|
50359
|
+
{
|
|
50360
|
+
"$ref": "#/components/parameters/enterprise"
|
|
50252
50361
|
}
|
|
50253
50362
|
],
|
|
50254
50363
|
"requestBody": {
|
|
@@ -50326,6 +50435,9 @@
|
|
|
50326
50435
|
"parameters": [
|
|
50327
50436
|
{
|
|
50328
50437
|
"$ref": "#/components/parameters/scim-user-id"
|
|
50438
|
+
},
|
|
50439
|
+
{
|
|
50440
|
+
"$ref": "#/components/parameters/enterprise"
|
|
50329
50441
|
}
|
|
50330
50442
|
],
|
|
50331
50443
|
"requestBody": {
|
|
@@ -50461,6 +50573,9 @@
|
|
|
50461
50573
|
"parameters": [
|
|
50462
50574
|
{
|
|
50463
50575
|
"$ref": "#/components/parameters/scim-user-id"
|
|
50576
|
+
},
|
|
50577
|
+
{
|
|
50578
|
+
"$ref": "#/components/parameters/enterprise"
|
|
50464
50579
|
}
|
|
50465
50580
|
],
|
|
50466
50581
|
"responses": {
|
|
@@ -58117,7 +58232,7 @@
|
|
|
58117
58232
|
"/users/{username}/hovercard": {
|
|
58118
58233
|
"get": {
|
|
58119
58234
|
"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\
|
|
58235
|
+
"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
58236
|
"tags": [
|
|
58122
58237
|
"users"
|
|
58123
58238
|
],
|
|
@@ -77348,8 +77463,7 @@
|
|
|
77348
77463
|
},
|
|
77349
77464
|
"repository-dispatch-sample.collected": {
|
|
77350
77465
|
"post": {
|
|
77351
|
-
"summary": "This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/enterprise-server@3.8/rest/repos/repos#create-a-repository-dispatch-event).\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.",
|
|
77352
|
-
"description": "The `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body.",
|
|
77466
|
+
"summary": "This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/enterprise-server@3.8/rest/repos/repos#create-a-repository-dispatch-event). In the payload, the `action` will be the `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.",
|
|
77353
77467
|
"operationId": "repository-dispatch/sample.collected",
|
|
77354
77468
|
"externalDocs": {
|
|
77355
77469
|
"url": "https://docs.github.com/enterprise-server@3.8/webhooks/webhook-events-and-payloads#repository_dispatch"
|
|
@@ -82411,7 +82525,8 @@
|
|
|
82411
82525
|
},
|
|
82412
82526
|
"hub_url": {
|
|
82413
82527
|
"type": "string",
|
|
82414
|
-
"format": "uri-template"
|
|
82528
|
+
"format": "uri-template",
|
|
82529
|
+
"deprecated": true
|
|
82415
82530
|
},
|
|
82416
82531
|
"issue_search_url": {
|
|
82417
82532
|
"type": "string",
|
|
@@ -82507,7 +82622,6 @@
|
|
|
82507
82622
|
"followers_url",
|
|
82508
82623
|
"following_url",
|
|
82509
82624
|
"gists_url",
|
|
82510
|
-
"hub_url",
|
|
82511
82625
|
"issue_search_url",
|
|
82512
82626
|
"issues_url",
|
|
82513
82627
|
"keys_url",
|
|
@@ -94137,7 +94251,9 @@
|
|
|
94137
94251
|
"queued",
|
|
94138
94252
|
"in_progress",
|
|
94139
94253
|
"completed",
|
|
94140
|
-
"waiting"
|
|
94254
|
+
"waiting",
|
|
94255
|
+
"requested",
|
|
94256
|
+
"pending"
|
|
94141
94257
|
]
|
|
94142
94258
|
},
|
|
94143
94259
|
"conclusion": {
|
|
@@ -96535,13 +96651,16 @@
|
|
|
96535
96651
|
"nullable": true
|
|
96536
96652
|
},
|
|
96537
96653
|
"status": {
|
|
96538
|
-
"description": "The phase of the lifecycle that the check is currently in.",
|
|
96654
|
+
"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
96655
|
"example": "queued",
|
|
96540
96656
|
"type": "string",
|
|
96541
96657
|
"enum": [
|
|
96542
96658
|
"queued",
|
|
96543
96659
|
"in_progress",
|
|
96544
|
-
"completed"
|
|
96660
|
+
"completed",
|
|
96661
|
+
"waiting",
|
|
96662
|
+
"requested",
|
|
96663
|
+
"pending"
|
|
96545
96664
|
]
|
|
96546
96665
|
},
|
|
96547
96666
|
"conclusion": {
|
|
@@ -96819,11 +96938,15 @@
|
|
|
96819
96938
|
},
|
|
96820
96939
|
"status": {
|
|
96821
96940
|
"type": "string",
|
|
96941
|
+
"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
96942
|
"example": "completed",
|
|
96823
96943
|
"enum": [
|
|
96824
96944
|
"queued",
|
|
96825
96945
|
"in_progress",
|
|
96826
|
-
"completed"
|
|
96946
|
+
"completed",
|
|
96947
|
+
"waiting",
|
|
96948
|
+
"requested",
|
|
96949
|
+
"pending"
|
|
96827
96950
|
],
|
|
96828
96951
|
"nullable": true
|
|
96829
96952
|
},
|
|
@@ -160086,6 +160209,7 @@
|
|
|
160086
160209
|
"type": "object",
|
|
160087
160210
|
"properties": {
|
|
160088
160211
|
"permission": {
|
|
160212
|
+
"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
160213
|
"type": "object",
|
|
160090
160214
|
"properties": {
|
|
160091
160215
|
"to": {
|
|
@@ -160100,6 +160224,18 @@
|
|
|
160100
160224
|
"required": [
|
|
160101
160225
|
"to"
|
|
160102
160226
|
]
|
|
160227
|
+
},
|
|
160228
|
+
"role_name": {
|
|
160229
|
+
"description": "The role assigned to the collaborator.",
|
|
160230
|
+
"type": "object",
|
|
160231
|
+
"properties": {
|
|
160232
|
+
"to": {
|
|
160233
|
+
"type": "string"
|
|
160234
|
+
}
|
|
160235
|
+
},
|
|
160236
|
+
"required": [
|
|
160237
|
+
"to"
|
|
160238
|
+
]
|
|
160103
160239
|
}
|
|
160104
160240
|
}
|
|
160105
160241
|
},
|
|
@@ -238286,7 +238422,7 @@
|
|
|
238286
238422
|
"type": "string"
|
|
238287
238423
|
},
|
|
238288
238424
|
"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
|
|
238425
|
+
"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
238426
|
"type": "array",
|
|
238291
238427
|
"items": {
|
|
238292
238428
|
"title": "Commit",
|
|
@@ -244094,9 +244230,7 @@
|
|
|
244094
244230
|
"properties": {
|
|
244095
244231
|
"action": {
|
|
244096
244232
|
"type": "string",
|
|
244097
|
-
"
|
|
244098
|
-
"sample.collected"
|
|
244099
|
-
]
|
|
244233
|
+
"description": "The `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body."
|
|
244100
244234
|
},
|
|
244101
244235
|
"branch": {
|
|
244102
244236
|
"type": "string"
|
|
@@ -244104,7 +244238,8 @@
|
|
|
244104
244238
|
"client_payload": {
|
|
244105
244239
|
"type": "object",
|
|
244106
244240
|
"nullable": true,
|
|
244107
|
-
"additionalProperties": true
|
|
244241
|
+
"additionalProperties": true,
|
|
244242
|
+
"description": "The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body."
|
|
244108
244243
|
},
|
|
244109
244244
|
"enterprise": {
|
|
244110
244245
|
"$ref": "#/components/schemas/enterprise-webhooks"
|
|
@@ -280142,6 +280277,20 @@
|
|
|
280142
280277
|
"commit_url": "https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b"
|
|
280143
280278
|
}
|
|
280144
280279
|
},
|
|
280280
|
+
{
|
|
280281
|
+
"type": "wiki_commit",
|
|
280282
|
+
"details": {
|
|
280283
|
+
"path": "/example/Home.md",
|
|
280284
|
+
"start_line": 1,
|
|
280285
|
+
"end_line": 1,
|
|
280286
|
+
"start_column": 1,
|
|
280287
|
+
"end_column": 64,
|
|
280288
|
+
"blob_sha": "af5626b4a114abcb82d63db7c8082c3c4756e51b",
|
|
280289
|
+
"page_url": "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5",
|
|
280290
|
+
"commit_sha": "302c0b7e200761c9dd9b57e57db540ee0b4293a5",
|
|
280291
|
+
"commit_url": "https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5"
|
|
280292
|
+
}
|
|
280293
|
+
},
|
|
280145
280294
|
{
|
|
280146
280295
|
"type": "issue_title",
|
|
280147
280296
|
"details": {
|
|
@@ -286199,7 +286348,7 @@
|
|
|
286199
286348
|
},
|
|
286200
286349
|
"workflow-run-status": {
|
|
286201
286350
|
"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`.",
|
|
286351
|
+
"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
286352
|
"in": "query",
|
|
286204
286353
|
"required": false,
|
|
286205
286354
|
"schema": {
|
|
@@ -286444,6 +286593,17 @@
|
|
|
286444
286593
|
"type": "integer"
|
|
286445
286594
|
}
|
|
286446
286595
|
},
|
|
286596
|
+
"git-ref-only": {
|
|
286597
|
+
"name": "ref",
|
|
286598
|
+
"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.",
|
|
286599
|
+
"in": "path",
|
|
286600
|
+
"required": true,
|
|
286601
|
+
"example": "heads/feature-a",
|
|
286602
|
+
"schema": {
|
|
286603
|
+
"type": "string"
|
|
286604
|
+
},
|
|
286605
|
+
"x-multi-segment": true
|
|
286606
|
+
},
|
|
286447
286607
|
"invitation-id": {
|
|
286448
286608
|
"name": "invitation_id",
|
|
286449
286609
|
"description": "The unique identifier of the invitation.",
|
|
@@ -287003,6 +287163,16 @@
|
|
|
287003
287163
|
}
|
|
287004
287164
|
}
|
|
287005
287165
|
},
|
|
287166
|
+
"unacceptable": {
|
|
287167
|
+
"description": "Unacceptable",
|
|
287168
|
+
"content": {
|
|
287169
|
+
"application/json": {
|
|
287170
|
+
"schema": {
|
|
287171
|
+
"$ref": "#/components/schemas/basic-error"
|
|
287172
|
+
}
|
|
287173
|
+
}
|
|
287174
|
+
}
|
|
287175
|
+
},
|
|
287006
287176
|
"no_content": {
|
|
287007
287177
|
"description": "A header with no content is returned."
|
|
287008
287178
|
},
|