@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.10.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": {
|
|
@@ -8127,7 +8127,6 @@
|
|
|
8127
8127
|
"default": {
|
|
8128
8128
|
"value": {
|
|
8129
8129
|
"advanced_security_enabled_for_new_repositories": true,
|
|
8130
|
-
"advanced_security_enabled_new_user_namespace_repos": true,
|
|
8131
8130
|
"dependabot_alerts_enabled_for_new_repositories": true,
|
|
8132
8131
|
"secret_scanning_enabled_for_new_repositories": true,
|
|
8133
8132
|
"secret_scanning_push_protection_enabled_for_new_repositories": true,
|
|
@@ -8490,7 +8489,7 @@
|
|
|
8490
8489
|
"/feeds": {
|
|
8491
8490
|
"get": {
|
|
8492
8491
|
"summary": "Get feeds",
|
|
8493
|
-
"description": "
|
|
8492
|
+
"description": "Lists the feeds available to the authenticated user. The response provides a URL for each feed. You can then get a specific feed by sending a request to one of the feed URLs.\n\n* **Timeline**: The GitHub Enterprise Server global public timeline\n* **User**: The public timeline for any user, using `uri_template`. For more information, see \"[Hypermedia](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia).\"\n* **Current user public**: The public timeline for the authenticated user\n* **Current user**: The private timeline for the authenticated user\n* **Current user actor**: The private timeline for activity created by the authenticated user\n* **Current user organizations**: The private timeline for the organizations the authenticated user is a member of.\n* **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub Enterprise Server.\n\nBy default, timeline resources are returned in JSON. You can specify the `application/atom+xml` type in the `Accept` header to return timeline resources in Atom format. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n**Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/enterprise-server@3.10/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens.",
|
|
8494
8493
|
"tags": [
|
|
8495
8494
|
"activity"
|
|
8496
8495
|
],
|
|
@@ -11362,7 +11361,7 @@
|
|
|
11362
11361
|
"/organizations": {
|
|
11363
11362
|
"get": {
|
|
11364
11363
|
"summary": "List organizations",
|
|
11365
|
-
"description": "Lists all organizations, in the order that they were created
|
|
11364
|
+
"description": "Lists all organizations, in the order that they were created.\n\n**Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations.",
|
|
11366
11365
|
"tags": [
|
|
11367
11366
|
"orgs"
|
|
11368
11367
|
],
|
|
@@ -16357,7 +16356,7 @@
|
|
|
16357
16356
|
"/orgs/{org}/hooks": {
|
|
16358
16357
|
"get": {
|
|
16359
16358
|
"summary": "List organization webhooks",
|
|
16360
|
-
"description": "",
|
|
16359
|
+
"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.",
|
|
16361
16360
|
"tags": [
|
|
16362
16361
|
"orgs"
|
|
16363
16362
|
],
|
|
@@ -16415,7 +16414,7 @@
|
|
|
16415
16414
|
},
|
|
16416
16415
|
"post": {
|
|
16417
16416
|
"summary": "Create an organization webhook",
|
|
16418
|
-
"description": "
|
|
16417
|
+
"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.",
|
|
16419
16418
|
"tags": [
|
|
16420
16419
|
"orgs"
|
|
16421
16420
|
],
|
|
@@ -16552,7 +16551,7 @@
|
|
|
16552
16551
|
"/orgs/{org}/hooks/{hook_id}": {
|
|
16553
16552
|
"get": {
|
|
16554
16553
|
"summary": "Get an organization webhook",
|
|
16555
|
-
"description": "Returns a webhook configured in an organization. To get only the webhook
|
|
16554
|
+
"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.",
|
|
16556
16555
|
"tags": [
|
|
16557
16556
|
"orgs"
|
|
16558
16557
|
],
|
|
@@ -16599,7 +16598,7 @@
|
|
|
16599
16598
|
},
|
|
16600
16599
|
"patch": {
|
|
16601
16600
|
"summary": "Update an organization webhook",
|
|
16602
|
-
"description": "Updates a webhook configured in an organization. When you update a webhook
|
|
16601
|
+
"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.",
|
|
16603
16602
|
"tags": [
|
|
16604
16603
|
"orgs"
|
|
16605
16604
|
],
|
|
@@ -16711,7 +16710,7 @@
|
|
|
16711
16710
|
},
|
|
16712
16711
|
"delete": {
|
|
16713
16712
|
"summary": "Delete an organization webhook",
|
|
16714
|
-
"description": "",
|
|
16713
|
+
"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.",
|
|
16715
16714
|
"tags": [
|
|
16716
16715
|
"orgs"
|
|
16717
16716
|
],
|
|
@@ -16748,7 +16747,7 @@
|
|
|
16748
16747
|
"/orgs/{org}/hooks/{hook_id}/config": {
|
|
16749
16748
|
"get": {
|
|
16750
16749
|
"summary": "Get a webhook configuration for an organization",
|
|
16751
|
-
"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
|
|
16750
|
+
"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.",
|
|
16752
16751
|
"tags": [
|
|
16753
16752
|
"orgs"
|
|
16754
16753
|
],
|
|
@@ -16792,7 +16791,7 @@
|
|
|
16792
16791
|
},
|
|
16793
16792
|
"patch": {
|
|
16794
16793
|
"summary": "Update a webhook configuration for an organization",
|
|
16795
|
-
"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
|
|
16794
|
+
"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.",
|
|
16796
16795
|
"tags": [
|
|
16797
16796
|
"orgs"
|
|
16798
16797
|
],
|
|
@@ -16873,7 +16872,7 @@
|
|
|
16873
16872
|
"/orgs/{org}/hooks/{hook_id}/deliveries": {
|
|
16874
16873
|
"get": {
|
|
16875
16874
|
"summary": "List deliveries for an organization webhook",
|
|
16876
|
-
"description": "Returns a list of webhook deliveries for a webhook configured in an organization.",
|
|
16875
|
+
"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.",
|
|
16877
16876
|
"tags": [
|
|
16878
16877
|
"orgs"
|
|
16879
16878
|
],
|
|
@@ -16942,7 +16941,7 @@
|
|
|
16942
16941
|
"/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}": {
|
|
16943
16942
|
"get": {
|
|
16944
16943
|
"summary": "Get a webhook delivery for an organization webhook",
|
|
16945
|
-
"description": "Returns a delivery for a webhook configured in an organization.",
|
|
16944
|
+
"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.",
|
|
16946
16945
|
"tags": [
|
|
16947
16946
|
"orgs"
|
|
16948
16947
|
],
|
|
@@ -16997,7 +16996,7 @@
|
|
|
16997
16996
|
"/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts": {
|
|
16998
16997
|
"post": {
|
|
16999
16998
|
"summary": "Redeliver a delivery for an organization webhook",
|
|
17000
|
-
"description": "Redeliver a delivery for a webhook configured in an organization.",
|
|
16999
|
+
"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.",
|
|
17001
17000
|
"tags": [
|
|
17002
17001
|
"orgs"
|
|
17003
17002
|
],
|
|
@@ -17040,7 +17039,7 @@
|
|
|
17040
17039
|
"/orgs/{org}/hooks/{hook_id}/pings": {
|
|
17041
17040
|
"post": {
|
|
17042
17041
|
"summary": "Ping an organization webhook",
|
|
17043
|
-
"description": "This will trigger a [ping event](https://docs.github.com/enterprise-server@3.10/webhooks/#ping-event)
|
|
17042
|
+
"description": "This will trigger a [ping event](https://docs.github.com/enterprise-server@3.10/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.",
|
|
17044
17043
|
"tags": [
|
|
17045
17044
|
"orgs"
|
|
17046
17045
|
],
|
|
@@ -27057,7 +27056,7 @@
|
|
|
27057
27056
|
"/repos/{owner}/{repo}/actions/runs": {
|
|
27058
27057
|
"get": {
|
|
27059
27058
|
"summary": "List workflow runs for a repository",
|
|
27060
|
-
"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.10/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
|
|
27059
|
+
"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.10/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`.",
|
|
27061
27060
|
"tags": [
|
|
27062
27061
|
"actions"
|
|
27063
27062
|
],
|
|
@@ -32707,11 +32706,14 @@
|
|
|
32707
32706
|
},
|
|
32708
32707
|
"status": {
|
|
32709
32708
|
"type": "string",
|
|
32710
|
-
"description": "The current status.",
|
|
32709
|
+
"description": "The current status of the check run. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`.",
|
|
32711
32710
|
"enum": [
|
|
32712
32711
|
"queued",
|
|
32713
32712
|
"in_progress",
|
|
32714
|
-
"completed"
|
|
32713
|
+
"completed",
|
|
32714
|
+
"waiting",
|
|
32715
|
+
"requested",
|
|
32716
|
+
"pending"
|
|
32715
32717
|
]
|
|
32716
32718
|
},
|
|
32717
32719
|
"conclusion": {
|
|
@@ -35366,6 +35368,9 @@
|
|
|
35366
35368
|
}
|
|
35367
35369
|
}
|
|
35368
35370
|
},
|
|
35371
|
+
"409": {
|
|
35372
|
+
"$ref": "#/components/responses/conflict"
|
|
35373
|
+
},
|
|
35369
35374
|
"422": {
|
|
35370
35375
|
"$ref": "#/components/responses/validation_failed"
|
|
35371
35376
|
}
|
|
@@ -35597,6 +35602,9 @@
|
|
|
35597
35602
|
"$ref": "#/components/headers/link"
|
|
35598
35603
|
}
|
|
35599
35604
|
}
|
|
35605
|
+
},
|
|
35606
|
+
"409": {
|
|
35607
|
+
"$ref": "#/components/responses/conflict"
|
|
35600
35608
|
}
|
|
35601
35609
|
},
|
|
35602
35610
|
"x-github": {
|
|
@@ -35656,6 +35664,9 @@
|
|
|
35656
35664
|
"404": {
|
|
35657
35665
|
"$ref": "#/components/responses/not_found"
|
|
35658
35666
|
},
|
|
35667
|
+
"409": {
|
|
35668
|
+
"$ref": "#/components/responses/conflict"
|
|
35669
|
+
},
|
|
35659
35670
|
"422": {
|
|
35660
35671
|
"$ref": "#/components/responses/validation_failed"
|
|
35661
35672
|
},
|
|
@@ -35993,7 +36004,7 @@
|
|
|
35993
36004
|
"/repos/{owner}/{repo}/compare/{basehead}": {
|
|
35994
36005
|
"get": {
|
|
35995
36006
|
"summary": "Compare two commits",
|
|
35996
|
-
"description": "Compares two commits against one another. You can compare branches in the same repository, or you can compare
|
|
36007
|
+
"description": "Compares two commits against one another. You can compare refs (branches or tags) and commit SHAs in the same repository, or you can compare refs and commit SHAs that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see \"[Understanding connections between repositories](https://docs.github.com/enterprise-server@3.10/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories).\"\n\nThis endpoint is equivalent to running the `git log BASE..HEAD` command, but it returns commits in a different order. The `git log BASE..HEAD` command returns commits in reverse chronological order, whereas the API returns commits in chronological order.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.diff`**: Returns the diff of the commit.\n- **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property.\n\nThe API response includes details about the files that were changed between the two commits. This includes the status of the change (if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a `renamed` status have a `previous_filename` field showing the previous filename of the file, and files with a `modified` status have a `patch` field showing the changes made to the file.\n\nWhen calling this endpoint without any paging parameter (`per_page` or `page`), the returned list is limited to 250 commits, and the last commit in the list is the most recent of the entire comparison.\n\n**Working with large comparisons**\n\nTo process a response with a large number of commits, use a query parameter (`per_page` or `page`) to paginate the results. When using pagination:\n\n- The list of changed files is only shown on the first page of results, but it includes all changed files for the entire comparison.\n- The results are returned in chronological order, but the last commit in the returned list may not be the most recent one in the entire set if there are more pages of results.\n\nFor more information on working with pagination, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api).\"\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The `verification` object includes the following fields:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |",
|
|
35997
36008
|
"tags": [
|
|
35998
36009
|
"repos"
|
|
35999
36010
|
],
|
|
@@ -38013,6 +38024,9 @@
|
|
|
38013
38024
|
"204": {
|
|
38014
38025
|
"description": "Response"
|
|
38015
38026
|
},
|
|
38027
|
+
"404": {
|
|
38028
|
+
"$ref": "#/components/responses/not_found"
|
|
38029
|
+
},
|
|
38016
38030
|
"422": {
|
|
38017
38031
|
"$ref": "#/components/responses/validation_failed"
|
|
38018
38032
|
}
|
|
@@ -38919,6 +38933,616 @@
|
|
|
38919
38933
|
"x-octokit": {}
|
|
38920
38934
|
}
|
|
38921
38935
|
},
|
|
38936
|
+
"/repos/{owner}/{repo}/environments/{environment_name}/secrets": {
|
|
38937
|
+
"get": {
|
|
38938
|
+
"summary": "List environment secrets",
|
|
38939
|
+
"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.",
|
|
38940
|
+
"tags": [
|
|
38941
|
+
"actions"
|
|
38942
|
+
],
|
|
38943
|
+
"operationId": "actions/list-environment-secrets",
|
|
38944
|
+
"externalDocs": {
|
|
38945
|
+
"description": "API method documentation",
|
|
38946
|
+
"url": "https://docs.github.com/enterprise-server@3.10/rest/actions/secrets#list-environment-secrets"
|
|
38947
|
+
},
|
|
38948
|
+
"parameters": [
|
|
38949
|
+
{
|
|
38950
|
+
"$ref": "#/components/parameters/owner"
|
|
38951
|
+
},
|
|
38952
|
+
{
|
|
38953
|
+
"$ref": "#/components/parameters/repo"
|
|
38954
|
+
},
|
|
38955
|
+
{
|
|
38956
|
+
"$ref": "#/components/parameters/environment-name"
|
|
38957
|
+
},
|
|
38958
|
+
{
|
|
38959
|
+
"$ref": "#/components/parameters/per-page"
|
|
38960
|
+
},
|
|
38961
|
+
{
|
|
38962
|
+
"$ref": "#/components/parameters/page"
|
|
38963
|
+
}
|
|
38964
|
+
],
|
|
38965
|
+
"responses": {
|
|
38966
|
+
"200": {
|
|
38967
|
+
"description": "Response",
|
|
38968
|
+
"content": {
|
|
38969
|
+
"application/json": {
|
|
38970
|
+
"schema": {
|
|
38971
|
+
"type": "object",
|
|
38972
|
+
"required": [
|
|
38973
|
+
"total_count",
|
|
38974
|
+
"secrets"
|
|
38975
|
+
],
|
|
38976
|
+
"properties": {
|
|
38977
|
+
"total_count": {
|
|
38978
|
+
"type": "integer"
|
|
38979
|
+
},
|
|
38980
|
+
"secrets": {
|
|
38981
|
+
"type": "array",
|
|
38982
|
+
"items": {
|
|
38983
|
+
"$ref": "#/components/schemas/actions-secret"
|
|
38984
|
+
}
|
|
38985
|
+
}
|
|
38986
|
+
}
|
|
38987
|
+
},
|
|
38988
|
+
"examples": {
|
|
38989
|
+
"default": {
|
|
38990
|
+
"$ref": "#/components/examples/actions-secret-paginated"
|
|
38991
|
+
}
|
|
38992
|
+
}
|
|
38993
|
+
}
|
|
38994
|
+
},
|
|
38995
|
+
"headers": {
|
|
38996
|
+
"Link": {
|
|
38997
|
+
"$ref": "#/components/headers/link"
|
|
38998
|
+
}
|
|
38999
|
+
}
|
|
39000
|
+
}
|
|
39001
|
+
},
|
|
39002
|
+
"x-github": {
|
|
39003
|
+
"githubCloudOnly": false,
|
|
39004
|
+
"enabledForGitHubApps": true,
|
|
39005
|
+
"category": "actions",
|
|
39006
|
+
"subcategory": "secrets"
|
|
39007
|
+
},
|
|
39008
|
+
"x-octokit": {}
|
|
39009
|
+
}
|
|
39010
|
+
},
|
|
39011
|
+
"/repos/{owner}/{repo}/environments/{environment_name}/secrets/public-key": {
|
|
39012
|
+
"get": {
|
|
39013
|
+
"summary": "Get an environment public key",
|
|
39014
|
+
"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.",
|
|
39015
|
+
"tags": [
|
|
39016
|
+
"actions"
|
|
39017
|
+
],
|
|
39018
|
+
"operationId": "actions/get-environment-public-key",
|
|
39019
|
+
"externalDocs": {
|
|
39020
|
+
"description": "API method documentation",
|
|
39021
|
+
"url": "https://docs.github.com/enterprise-server@3.10/rest/actions/secrets#get-an-environment-public-key"
|
|
39022
|
+
},
|
|
39023
|
+
"parameters": [
|
|
39024
|
+
{
|
|
39025
|
+
"$ref": "#/components/parameters/owner"
|
|
39026
|
+
},
|
|
39027
|
+
{
|
|
39028
|
+
"$ref": "#/components/parameters/repo"
|
|
39029
|
+
},
|
|
39030
|
+
{
|
|
39031
|
+
"$ref": "#/components/parameters/environment-name"
|
|
39032
|
+
}
|
|
39033
|
+
],
|
|
39034
|
+
"responses": {
|
|
39035
|
+
"200": {
|
|
39036
|
+
"description": "Response",
|
|
39037
|
+
"content": {
|
|
39038
|
+
"application/json": {
|
|
39039
|
+
"schema": {
|
|
39040
|
+
"$ref": "#/components/schemas/actions-public-key"
|
|
39041
|
+
},
|
|
39042
|
+
"examples": {
|
|
39043
|
+
"default": {
|
|
39044
|
+
"$ref": "#/components/examples/actions-public-key"
|
|
39045
|
+
}
|
|
39046
|
+
}
|
|
39047
|
+
}
|
|
39048
|
+
}
|
|
39049
|
+
}
|
|
39050
|
+
},
|
|
39051
|
+
"x-github": {
|
|
39052
|
+
"githubCloudOnly": false,
|
|
39053
|
+
"enabledForGitHubApps": true,
|
|
39054
|
+
"category": "actions",
|
|
39055
|
+
"subcategory": "secrets"
|
|
39056
|
+
},
|
|
39057
|
+
"x-octokit": {}
|
|
39058
|
+
}
|
|
39059
|
+
},
|
|
39060
|
+
"/repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}": {
|
|
39061
|
+
"get": {
|
|
39062
|
+
"summary": "Get an environment secret",
|
|
39063
|
+
"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.",
|
|
39064
|
+
"tags": [
|
|
39065
|
+
"actions"
|
|
39066
|
+
],
|
|
39067
|
+
"operationId": "actions/get-environment-secret",
|
|
39068
|
+
"externalDocs": {
|
|
39069
|
+
"description": "API method documentation",
|
|
39070
|
+
"url": "https://docs.github.com/enterprise-server@3.10/rest/actions/secrets#get-an-environment-secret"
|
|
39071
|
+
},
|
|
39072
|
+
"parameters": [
|
|
39073
|
+
{
|
|
39074
|
+
"$ref": "#/components/parameters/owner"
|
|
39075
|
+
},
|
|
39076
|
+
{
|
|
39077
|
+
"$ref": "#/components/parameters/repo"
|
|
39078
|
+
},
|
|
39079
|
+
{
|
|
39080
|
+
"$ref": "#/components/parameters/environment-name"
|
|
39081
|
+
},
|
|
39082
|
+
{
|
|
39083
|
+
"$ref": "#/components/parameters/secret-name"
|
|
39084
|
+
}
|
|
39085
|
+
],
|
|
39086
|
+
"responses": {
|
|
39087
|
+
"200": {
|
|
39088
|
+
"description": "Response",
|
|
39089
|
+
"content": {
|
|
39090
|
+
"application/json": {
|
|
39091
|
+
"schema": {
|
|
39092
|
+
"$ref": "#/components/schemas/actions-secret"
|
|
39093
|
+
},
|
|
39094
|
+
"examples": {
|
|
39095
|
+
"default": {
|
|
39096
|
+
"$ref": "#/components/examples/actions-secret"
|
|
39097
|
+
}
|
|
39098
|
+
}
|
|
39099
|
+
}
|
|
39100
|
+
}
|
|
39101
|
+
}
|
|
39102
|
+
},
|
|
39103
|
+
"x-github": {
|
|
39104
|
+
"githubCloudOnly": false,
|
|
39105
|
+
"enabledForGitHubApps": true,
|
|
39106
|
+
"category": "actions",
|
|
39107
|
+
"subcategory": "secrets"
|
|
39108
|
+
},
|
|
39109
|
+
"x-octokit": {}
|
|
39110
|
+
},
|
|
39111
|
+
"put": {
|
|
39112
|
+
"summary": "Create or update an environment secret",
|
|
39113
|
+
"description": "Creates or updates an environment secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
|
|
39114
|
+
"tags": [
|
|
39115
|
+
"actions"
|
|
39116
|
+
],
|
|
39117
|
+
"operationId": "actions/create-or-update-environment-secret",
|
|
39118
|
+
"externalDocs": {
|
|
39119
|
+
"description": "API method documentation",
|
|
39120
|
+
"url": "https://docs.github.com/enterprise-server@3.10/rest/actions/secrets#create-or-update-an-environment-secret"
|
|
39121
|
+
},
|
|
39122
|
+
"parameters": [
|
|
39123
|
+
{
|
|
39124
|
+
"$ref": "#/components/parameters/owner"
|
|
39125
|
+
},
|
|
39126
|
+
{
|
|
39127
|
+
"$ref": "#/components/parameters/repo"
|
|
39128
|
+
},
|
|
39129
|
+
{
|
|
39130
|
+
"$ref": "#/components/parameters/environment-name"
|
|
39131
|
+
},
|
|
39132
|
+
{
|
|
39133
|
+
"$ref": "#/components/parameters/secret-name"
|
|
39134
|
+
}
|
|
39135
|
+
],
|
|
39136
|
+
"requestBody": {
|
|
39137
|
+
"required": true,
|
|
39138
|
+
"content": {
|
|
39139
|
+
"application/json": {
|
|
39140
|
+
"schema": {
|
|
39141
|
+
"type": "object",
|
|
39142
|
+
"properties": {
|
|
39143
|
+
"encrypted_value": {
|
|
39144
|
+
"type": "string",
|
|
39145
|
+
"description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https://docs.github.com/enterprise-server@3.10/rest/actions/secrets#get-an-environment-public-key) endpoint.",
|
|
39146
|
+
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$"
|
|
39147
|
+
},
|
|
39148
|
+
"key_id": {
|
|
39149
|
+
"type": "string",
|
|
39150
|
+
"description": "ID of the key you used to encrypt the secret."
|
|
39151
|
+
}
|
|
39152
|
+
},
|
|
39153
|
+
"required": [
|
|
39154
|
+
"encrypted_value",
|
|
39155
|
+
"key_id"
|
|
39156
|
+
]
|
|
39157
|
+
},
|
|
39158
|
+
"examples": {
|
|
39159
|
+
"default": {
|
|
39160
|
+
"value": {
|
|
39161
|
+
"encrypted_value": "c2VjcmV0",
|
|
39162
|
+
"key_id": "012345678912345678"
|
|
39163
|
+
}
|
|
39164
|
+
}
|
|
39165
|
+
}
|
|
39166
|
+
}
|
|
39167
|
+
}
|
|
39168
|
+
},
|
|
39169
|
+
"responses": {
|
|
39170
|
+
"201": {
|
|
39171
|
+
"description": "Response when creating a secret",
|
|
39172
|
+
"content": {
|
|
39173
|
+
"application/json": {
|
|
39174
|
+
"schema": {
|
|
39175
|
+
"$ref": "#/components/schemas/empty-object"
|
|
39176
|
+
},
|
|
39177
|
+
"examples": {
|
|
39178
|
+
"default": {
|
|
39179
|
+
"value": null
|
|
39180
|
+
}
|
|
39181
|
+
}
|
|
39182
|
+
}
|
|
39183
|
+
}
|
|
39184
|
+
},
|
|
39185
|
+
"204": {
|
|
39186
|
+
"description": "Response when updating a secret"
|
|
39187
|
+
}
|
|
39188
|
+
},
|
|
39189
|
+
"x-github": {
|
|
39190
|
+
"githubCloudOnly": false,
|
|
39191
|
+
"enabledForGitHubApps": true,
|
|
39192
|
+
"category": "actions",
|
|
39193
|
+
"subcategory": "secrets"
|
|
39194
|
+
},
|
|
39195
|
+
"x-octokit": {}
|
|
39196
|
+
},
|
|
39197
|
+
"delete": {
|
|
39198
|
+
"summary": "Delete an environment secret",
|
|
39199
|
+
"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.",
|
|
39200
|
+
"tags": [
|
|
39201
|
+
"actions"
|
|
39202
|
+
],
|
|
39203
|
+
"operationId": "actions/delete-environment-secret",
|
|
39204
|
+
"externalDocs": {
|
|
39205
|
+
"description": "API method documentation",
|
|
39206
|
+
"url": "https://docs.github.com/enterprise-server@3.10/rest/actions/secrets#delete-an-environment-secret"
|
|
39207
|
+
},
|
|
39208
|
+
"parameters": [
|
|
39209
|
+
{
|
|
39210
|
+
"$ref": "#/components/parameters/owner"
|
|
39211
|
+
},
|
|
39212
|
+
{
|
|
39213
|
+
"$ref": "#/components/parameters/repo"
|
|
39214
|
+
},
|
|
39215
|
+
{
|
|
39216
|
+
"$ref": "#/components/parameters/environment-name"
|
|
39217
|
+
},
|
|
39218
|
+
{
|
|
39219
|
+
"$ref": "#/components/parameters/secret-name"
|
|
39220
|
+
}
|
|
39221
|
+
],
|
|
39222
|
+
"responses": {
|
|
39223
|
+
"204": {
|
|
39224
|
+
"description": "Default response"
|
|
39225
|
+
}
|
|
39226
|
+
},
|
|
39227
|
+
"x-github": {
|
|
39228
|
+
"githubCloudOnly": false,
|
|
39229
|
+
"enabledForGitHubApps": true,
|
|
39230
|
+
"category": "actions",
|
|
39231
|
+
"subcategory": "secrets"
|
|
39232
|
+
},
|
|
39233
|
+
"x-octokit": {}
|
|
39234
|
+
}
|
|
39235
|
+
},
|
|
39236
|
+
"/repos/{owner}/{repo}/environments/{environment_name}/variables": {
|
|
39237
|
+
"get": {
|
|
39238
|
+
"summary": "List environment variables",
|
|
39239
|
+
"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.",
|
|
39240
|
+
"tags": [
|
|
39241
|
+
"actions"
|
|
39242
|
+
],
|
|
39243
|
+
"operationId": "actions/list-environment-variables",
|
|
39244
|
+
"externalDocs": {
|
|
39245
|
+
"description": "API method documentation",
|
|
39246
|
+
"url": "https://docs.github.com/enterprise-server@3.10/rest/actions/variables#list-environment-variables"
|
|
39247
|
+
},
|
|
39248
|
+
"parameters": [
|
|
39249
|
+
{
|
|
39250
|
+
"$ref": "#/components/parameters/owner"
|
|
39251
|
+
},
|
|
39252
|
+
{
|
|
39253
|
+
"$ref": "#/components/parameters/repo"
|
|
39254
|
+
},
|
|
39255
|
+
{
|
|
39256
|
+
"$ref": "#/components/parameters/environment-name"
|
|
39257
|
+
},
|
|
39258
|
+
{
|
|
39259
|
+
"$ref": "#/components/parameters/variables-per-page"
|
|
39260
|
+
},
|
|
39261
|
+
{
|
|
39262
|
+
"$ref": "#/components/parameters/page"
|
|
39263
|
+
}
|
|
39264
|
+
],
|
|
39265
|
+
"responses": {
|
|
39266
|
+
"200": {
|
|
39267
|
+
"description": "Response",
|
|
39268
|
+
"content": {
|
|
39269
|
+
"application/json": {
|
|
39270
|
+
"schema": {
|
|
39271
|
+
"type": "object",
|
|
39272
|
+
"required": [
|
|
39273
|
+
"total_count",
|
|
39274
|
+
"variables"
|
|
39275
|
+
],
|
|
39276
|
+
"properties": {
|
|
39277
|
+
"total_count": {
|
|
39278
|
+
"type": "integer"
|
|
39279
|
+
},
|
|
39280
|
+
"variables": {
|
|
39281
|
+
"type": "array",
|
|
39282
|
+
"items": {
|
|
39283
|
+
"$ref": "#/components/schemas/actions-variable"
|
|
39284
|
+
}
|
|
39285
|
+
}
|
|
39286
|
+
}
|
|
39287
|
+
},
|
|
39288
|
+
"examples": {
|
|
39289
|
+
"default": {
|
|
39290
|
+
"$ref": "#/components/examples/actions-variables-paginated"
|
|
39291
|
+
}
|
|
39292
|
+
}
|
|
39293
|
+
}
|
|
39294
|
+
},
|
|
39295
|
+
"headers": {
|
|
39296
|
+
"Link": {
|
|
39297
|
+
"$ref": "#/components/headers/link"
|
|
39298
|
+
}
|
|
39299
|
+
}
|
|
39300
|
+
}
|
|
39301
|
+
},
|
|
39302
|
+
"x-github": {
|
|
39303
|
+
"githubCloudOnly": false,
|
|
39304
|
+
"enabledForGitHubApps": true,
|
|
39305
|
+
"category": "actions",
|
|
39306
|
+
"subcategory": "variables"
|
|
39307
|
+
},
|
|
39308
|
+
"x-octokit": {}
|
|
39309
|
+
},
|
|
39310
|
+
"post": {
|
|
39311
|
+
"summary": "Create an environment variable",
|
|
39312
|
+
"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.",
|
|
39313
|
+
"tags": [
|
|
39314
|
+
"actions"
|
|
39315
|
+
],
|
|
39316
|
+
"operationId": "actions/create-environment-variable",
|
|
39317
|
+
"externalDocs": {
|
|
39318
|
+
"description": "API method documentation",
|
|
39319
|
+
"url": "https://docs.github.com/enterprise-server@3.10/rest/actions/variables#create-an-environment-variable"
|
|
39320
|
+
},
|
|
39321
|
+
"parameters": [
|
|
39322
|
+
{
|
|
39323
|
+
"$ref": "#/components/parameters/owner"
|
|
39324
|
+
},
|
|
39325
|
+
{
|
|
39326
|
+
"$ref": "#/components/parameters/repo"
|
|
39327
|
+
},
|
|
39328
|
+
{
|
|
39329
|
+
"$ref": "#/components/parameters/environment-name"
|
|
39330
|
+
}
|
|
39331
|
+
],
|
|
39332
|
+
"requestBody": {
|
|
39333
|
+
"required": true,
|
|
39334
|
+
"content": {
|
|
39335
|
+
"application/json": {
|
|
39336
|
+
"schema": {
|
|
39337
|
+
"type": "object",
|
|
39338
|
+
"properties": {
|
|
39339
|
+
"name": {
|
|
39340
|
+
"type": "string",
|
|
39341
|
+
"description": "The name of the variable."
|
|
39342
|
+
},
|
|
39343
|
+
"value": {
|
|
39344
|
+
"type": "string",
|
|
39345
|
+
"description": "The value of the variable."
|
|
39346
|
+
}
|
|
39347
|
+
},
|
|
39348
|
+
"required": [
|
|
39349
|
+
"name",
|
|
39350
|
+
"value"
|
|
39351
|
+
]
|
|
39352
|
+
},
|
|
39353
|
+
"examples": {
|
|
39354
|
+
"default": {
|
|
39355
|
+
"value": {
|
|
39356
|
+
"name": "USERNAME",
|
|
39357
|
+
"value": "octocat"
|
|
39358
|
+
}
|
|
39359
|
+
}
|
|
39360
|
+
}
|
|
39361
|
+
}
|
|
39362
|
+
}
|
|
39363
|
+
},
|
|
39364
|
+
"responses": {
|
|
39365
|
+
"201": {
|
|
39366
|
+
"description": "Response",
|
|
39367
|
+
"content": {
|
|
39368
|
+
"application/json": {
|
|
39369
|
+
"schema": {
|
|
39370
|
+
"$ref": "#/components/schemas/empty-object"
|
|
39371
|
+
},
|
|
39372
|
+
"examples": {
|
|
39373
|
+
"default": {
|
|
39374
|
+
"value": null
|
|
39375
|
+
}
|
|
39376
|
+
}
|
|
39377
|
+
}
|
|
39378
|
+
}
|
|
39379
|
+
}
|
|
39380
|
+
},
|
|
39381
|
+
"x-github": {
|
|
39382
|
+
"githubCloudOnly": false,
|
|
39383
|
+
"enabledForGitHubApps": true,
|
|
39384
|
+
"category": "actions",
|
|
39385
|
+
"subcategory": "variables"
|
|
39386
|
+
},
|
|
39387
|
+
"x-octokit": {}
|
|
39388
|
+
}
|
|
39389
|
+
},
|
|
39390
|
+
"/repos/{owner}/{repo}/environments/{environment_name}/variables/{name}": {
|
|
39391
|
+
"get": {
|
|
39392
|
+
"summary": "Get an environment variable",
|
|
39393
|
+
"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.",
|
|
39394
|
+
"tags": [
|
|
39395
|
+
"actions"
|
|
39396
|
+
],
|
|
39397
|
+
"operationId": "actions/get-environment-variable",
|
|
39398
|
+
"externalDocs": {
|
|
39399
|
+
"description": "API method documentation",
|
|
39400
|
+
"url": "https://docs.github.com/enterprise-server@3.10/rest/actions/variables#get-an-environment-variable"
|
|
39401
|
+
},
|
|
39402
|
+
"parameters": [
|
|
39403
|
+
{
|
|
39404
|
+
"$ref": "#/components/parameters/owner"
|
|
39405
|
+
},
|
|
39406
|
+
{
|
|
39407
|
+
"$ref": "#/components/parameters/repo"
|
|
39408
|
+
},
|
|
39409
|
+
{
|
|
39410
|
+
"$ref": "#/components/parameters/environment-name"
|
|
39411
|
+
},
|
|
39412
|
+
{
|
|
39413
|
+
"$ref": "#/components/parameters/variable-name"
|
|
39414
|
+
}
|
|
39415
|
+
],
|
|
39416
|
+
"responses": {
|
|
39417
|
+
"200": {
|
|
39418
|
+
"description": "Response",
|
|
39419
|
+
"content": {
|
|
39420
|
+
"application/json": {
|
|
39421
|
+
"schema": {
|
|
39422
|
+
"$ref": "#/components/schemas/actions-variable"
|
|
39423
|
+
},
|
|
39424
|
+
"examples": {
|
|
39425
|
+
"default": {
|
|
39426
|
+
"$ref": "#/components/examples/actions-variable"
|
|
39427
|
+
}
|
|
39428
|
+
}
|
|
39429
|
+
}
|
|
39430
|
+
}
|
|
39431
|
+
}
|
|
39432
|
+
},
|
|
39433
|
+
"x-github": {
|
|
39434
|
+
"githubCloudOnly": false,
|
|
39435
|
+
"enabledForGitHubApps": true,
|
|
39436
|
+
"category": "actions",
|
|
39437
|
+
"subcategory": "variables"
|
|
39438
|
+
},
|
|
39439
|
+
"x-octokit": {}
|
|
39440
|
+
},
|
|
39441
|
+
"patch": {
|
|
39442
|
+
"summary": "Update an environment variable",
|
|
39443
|
+
"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.",
|
|
39444
|
+
"tags": [
|
|
39445
|
+
"actions"
|
|
39446
|
+
],
|
|
39447
|
+
"operationId": "actions/update-environment-variable",
|
|
39448
|
+
"externalDocs": {
|
|
39449
|
+
"description": "API method documentation",
|
|
39450
|
+
"url": "https://docs.github.com/enterprise-server@3.10/rest/actions/variables#update-an-environment-variable"
|
|
39451
|
+
},
|
|
39452
|
+
"parameters": [
|
|
39453
|
+
{
|
|
39454
|
+
"$ref": "#/components/parameters/owner"
|
|
39455
|
+
},
|
|
39456
|
+
{
|
|
39457
|
+
"$ref": "#/components/parameters/repo"
|
|
39458
|
+
},
|
|
39459
|
+
{
|
|
39460
|
+
"$ref": "#/components/parameters/variable-name"
|
|
39461
|
+
},
|
|
39462
|
+
{
|
|
39463
|
+
"$ref": "#/components/parameters/environment-name"
|
|
39464
|
+
}
|
|
39465
|
+
],
|
|
39466
|
+
"requestBody": {
|
|
39467
|
+
"required": true,
|
|
39468
|
+
"content": {
|
|
39469
|
+
"application/json": {
|
|
39470
|
+
"schema": {
|
|
39471
|
+
"type": "object",
|
|
39472
|
+
"properties": {
|
|
39473
|
+
"name": {
|
|
39474
|
+
"type": "string",
|
|
39475
|
+
"description": "The name of the variable."
|
|
39476
|
+
},
|
|
39477
|
+
"value": {
|
|
39478
|
+
"type": "string",
|
|
39479
|
+
"description": "The value of the variable."
|
|
39480
|
+
}
|
|
39481
|
+
}
|
|
39482
|
+
},
|
|
39483
|
+
"examples": {
|
|
39484
|
+
"default": {
|
|
39485
|
+
"value": {
|
|
39486
|
+
"name": "USERNAME",
|
|
39487
|
+
"value": "octocat"
|
|
39488
|
+
}
|
|
39489
|
+
}
|
|
39490
|
+
}
|
|
39491
|
+
}
|
|
39492
|
+
}
|
|
39493
|
+
},
|
|
39494
|
+
"responses": {
|
|
39495
|
+
"204": {
|
|
39496
|
+
"description": "Response"
|
|
39497
|
+
}
|
|
39498
|
+
},
|
|
39499
|
+
"x-github": {
|
|
39500
|
+
"githubCloudOnly": false,
|
|
39501
|
+
"enabledForGitHubApps": true,
|
|
39502
|
+
"category": "actions",
|
|
39503
|
+
"subcategory": "variables"
|
|
39504
|
+
},
|
|
39505
|
+
"x-octokit": {}
|
|
39506
|
+
},
|
|
39507
|
+
"delete": {
|
|
39508
|
+
"summary": "Delete an environment variable",
|
|
39509
|
+
"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.",
|
|
39510
|
+
"tags": [
|
|
39511
|
+
"actions"
|
|
39512
|
+
],
|
|
39513
|
+
"operationId": "actions/delete-environment-variable",
|
|
39514
|
+
"externalDocs": {
|
|
39515
|
+
"description": "API method documentation",
|
|
39516
|
+
"url": "https://docs.github.com/enterprise-server@3.10/rest/actions/variables#delete-an-environment-variable"
|
|
39517
|
+
},
|
|
39518
|
+
"parameters": [
|
|
39519
|
+
{
|
|
39520
|
+
"$ref": "#/components/parameters/owner"
|
|
39521
|
+
},
|
|
39522
|
+
{
|
|
39523
|
+
"$ref": "#/components/parameters/repo"
|
|
39524
|
+
},
|
|
39525
|
+
{
|
|
39526
|
+
"$ref": "#/components/parameters/variable-name"
|
|
39527
|
+
},
|
|
39528
|
+
{
|
|
39529
|
+
"$ref": "#/components/parameters/environment-name"
|
|
39530
|
+
}
|
|
39531
|
+
],
|
|
39532
|
+
"responses": {
|
|
39533
|
+
"204": {
|
|
39534
|
+
"description": "Response"
|
|
39535
|
+
}
|
|
39536
|
+
},
|
|
39537
|
+
"x-github": {
|
|
39538
|
+
"githubCloudOnly": false,
|
|
39539
|
+
"enabledForGitHubApps": true,
|
|
39540
|
+
"category": "actions",
|
|
39541
|
+
"subcategory": "variables"
|
|
39542
|
+
},
|
|
39543
|
+
"x-octokit": {}
|
|
39544
|
+
}
|
|
39545
|
+
},
|
|
38922
39546
|
"/repos/{owner}/{repo}/events": {
|
|
38923
39547
|
"get": {
|
|
38924
39548
|
"summary": "List repository events",
|
|
@@ -39291,6 +39915,9 @@
|
|
|
39291
39915
|
"404": {
|
|
39292
39916
|
"$ref": "#/components/responses/not_found"
|
|
39293
39917
|
},
|
|
39918
|
+
"409": {
|
|
39919
|
+
"$ref": "#/components/responses/conflict"
|
|
39920
|
+
},
|
|
39294
39921
|
"422": {
|
|
39295
39922
|
"$ref": "#/components/responses/validation_failed"
|
|
39296
39923
|
}
|
|
@@ -39445,6 +40072,9 @@
|
|
|
39445
40072
|
"404": {
|
|
39446
40073
|
"$ref": "#/components/responses/not_found"
|
|
39447
40074
|
},
|
|
40075
|
+
"409": {
|
|
40076
|
+
"$ref": "#/components/responses/conflict"
|
|
40077
|
+
},
|
|
39448
40078
|
"422": {
|
|
39449
40079
|
"$ref": "#/components/responses/validation_failed"
|
|
39450
40080
|
}
|
|
@@ -39499,6 +40129,9 @@
|
|
|
39499
40129
|
},
|
|
39500
40130
|
"404": {
|
|
39501
40131
|
"$ref": "#/components/responses/not_found"
|
|
40132
|
+
},
|
|
40133
|
+
"409": {
|
|
40134
|
+
"$ref": "#/components/responses/conflict"
|
|
39502
40135
|
}
|
|
39503
40136
|
},
|
|
39504
40137
|
"x-github": {
|
|
@@ -39530,7 +40163,7 @@
|
|
|
39530
40163
|
"$ref": "#/components/parameters/repo"
|
|
39531
40164
|
},
|
|
39532
40165
|
{
|
|
39533
|
-
"$ref": "#/components/parameters/
|
|
40166
|
+
"$ref": "#/components/parameters/git-ref-only"
|
|
39534
40167
|
}
|
|
39535
40168
|
],
|
|
39536
40169
|
"responses": {
|
|
@@ -39556,6 +40189,9 @@
|
|
|
39556
40189
|
"$ref": "#/components/headers/link"
|
|
39557
40190
|
}
|
|
39558
40191
|
}
|
|
40192
|
+
},
|
|
40193
|
+
"409": {
|
|
40194
|
+
"$ref": "#/components/responses/conflict"
|
|
39559
40195
|
}
|
|
39560
40196
|
},
|
|
39561
40197
|
"x-github": {
|
|
@@ -39587,7 +40223,7 @@
|
|
|
39587
40223
|
"$ref": "#/components/parameters/repo"
|
|
39588
40224
|
},
|
|
39589
40225
|
{
|
|
39590
|
-
"$ref": "#/components/parameters/
|
|
40226
|
+
"$ref": "#/components/parameters/git-ref-only"
|
|
39591
40227
|
}
|
|
39592
40228
|
],
|
|
39593
40229
|
"responses": {
|
|
@@ -39608,6 +40244,9 @@
|
|
|
39608
40244
|
},
|
|
39609
40245
|
"404": {
|
|
39610
40246
|
"$ref": "#/components/responses/not_found"
|
|
40247
|
+
},
|
|
40248
|
+
"409": {
|
|
40249
|
+
"$ref": "#/components/responses/conflict"
|
|
39611
40250
|
}
|
|
39612
40251
|
},
|
|
39613
40252
|
"x-github": {
|
|
@@ -39695,6 +40334,9 @@
|
|
|
39695
40334
|
}
|
|
39696
40335
|
}
|
|
39697
40336
|
},
|
|
40337
|
+
"409": {
|
|
40338
|
+
"$ref": "#/components/responses/conflict"
|
|
40339
|
+
},
|
|
39698
40340
|
"422": {
|
|
39699
40341
|
"$ref": "#/components/responses/validation_failed"
|
|
39700
40342
|
}
|
|
@@ -39711,7 +40353,7 @@
|
|
|
39711
40353
|
"/repos/{owner}/{repo}/git/refs/{ref}": {
|
|
39712
40354
|
"patch": {
|
|
39713
40355
|
"summary": "Update a reference",
|
|
39714
|
-
"description": "",
|
|
40356
|
+
"description": "Updates the provided reference to point to a new SHA. For more information, see \"[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)\" in the Git documentation.",
|
|
39715
40357
|
"tags": [
|
|
39716
40358
|
"git"
|
|
39717
40359
|
],
|
|
@@ -39728,15 +40370,7 @@
|
|
|
39728
40370
|
"$ref": "#/components/parameters/repo"
|
|
39729
40371
|
},
|
|
39730
40372
|
{
|
|
39731
|
-
"
|
|
39732
|
-
"description": "The name of the reference to update (for example, `heads/featureA`). Can be a branch name (`heads/BRANCH_NAME`) or tag name (`tags/TAG_NAME`). For more information, see \"[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)\" in the Git documentation.",
|
|
39733
|
-
"in": "path",
|
|
39734
|
-
"required": true,
|
|
39735
|
-
"example": "heads/featureA",
|
|
39736
|
-
"schema": {
|
|
39737
|
-
"type": "string"
|
|
39738
|
-
},
|
|
39739
|
-
"x-multi-segment": true
|
|
40373
|
+
"$ref": "#/components/parameters/git-ref-only"
|
|
39740
40374
|
}
|
|
39741
40375
|
],
|
|
39742
40376
|
"requestBody": {
|
|
@@ -39787,6 +40421,9 @@
|
|
|
39787
40421
|
}
|
|
39788
40422
|
}
|
|
39789
40423
|
},
|
|
40424
|
+
"409": {
|
|
40425
|
+
"$ref": "#/components/responses/conflict"
|
|
40426
|
+
},
|
|
39790
40427
|
"422": {
|
|
39791
40428
|
"$ref": "#/components/responses/validation_failed"
|
|
39792
40429
|
}
|
|
@@ -39801,7 +40438,7 @@
|
|
|
39801
40438
|
},
|
|
39802
40439
|
"delete": {
|
|
39803
40440
|
"summary": "Delete a reference",
|
|
39804
|
-
"description": "",
|
|
40441
|
+
"description": "Deletes the provided reference.",
|
|
39805
40442
|
"tags": [
|
|
39806
40443
|
"git"
|
|
39807
40444
|
],
|
|
@@ -39818,13 +40455,16 @@
|
|
|
39818
40455
|
"$ref": "#/components/parameters/repo"
|
|
39819
40456
|
},
|
|
39820
40457
|
{
|
|
39821
|
-
"$ref": "#/components/parameters/
|
|
40458
|
+
"$ref": "#/components/parameters/git-ref-only"
|
|
39822
40459
|
}
|
|
39823
40460
|
],
|
|
39824
40461
|
"responses": {
|
|
39825
40462
|
"204": {
|
|
39826
40463
|
"description": "Response"
|
|
39827
40464
|
},
|
|
40465
|
+
"409": {
|
|
40466
|
+
"$ref": "#/components/responses/conflict"
|
|
40467
|
+
},
|
|
39828
40468
|
"422": {
|
|
39829
40469
|
"$ref": "#/components/responses/validation_failed"
|
|
39830
40470
|
}
|
|
@@ -39959,6 +40599,9 @@
|
|
|
39959
40599
|
}
|
|
39960
40600
|
}
|
|
39961
40601
|
},
|
|
40602
|
+
"409": {
|
|
40603
|
+
"$ref": "#/components/responses/conflict"
|
|
40604
|
+
},
|
|
39962
40605
|
"422": {
|
|
39963
40606
|
"$ref": "#/components/responses/validation_failed"
|
|
39964
40607
|
}
|
|
@@ -40018,6 +40661,9 @@
|
|
|
40018
40661
|
},
|
|
40019
40662
|
"404": {
|
|
40020
40663
|
"$ref": "#/components/responses/not_found"
|
|
40664
|
+
},
|
|
40665
|
+
"409": {
|
|
40666
|
+
"$ref": "#/components/responses/conflict"
|
|
40021
40667
|
}
|
|
40022
40668
|
},
|
|
40023
40669
|
"x-github": {
|
|
@@ -40155,6 +40801,9 @@
|
|
|
40155
40801
|
"404": {
|
|
40156
40802
|
"$ref": "#/components/responses/not_found"
|
|
40157
40803
|
},
|
|
40804
|
+
"409": {
|
|
40805
|
+
"$ref": "#/components/responses/conflict"
|
|
40806
|
+
},
|
|
40158
40807
|
"422": {
|
|
40159
40808
|
"$ref": "#/components/responses/validation_failed"
|
|
40160
40809
|
}
|
|
@@ -40229,6 +40878,9 @@
|
|
|
40229
40878
|
"404": {
|
|
40230
40879
|
"$ref": "#/components/responses/not_found"
|
|
40231
40880
|
},
|
|
40881
|
+
"409": {
|
|
40882
|
+
"$ref": "#/components/responses/conflict"
|
|
40883
|
+
},
|
|
40232
40884
|
"422": {
|
|
40233
40885
|
"$ref": "#/components/responses/validation_failed"
|
|
40234
40886
|
}
|
|
@@ -47057,6 +47709,9 @@
|
|
|
47057
47709
|
"404": {
|
|
47058
47710
|
"$ref": "#/components/responses/not_found"
|
|
47059
47711
|
},
|
|
47712
|
+
"406": {
|
|
47713
|
+
"$ref": "#/components/responses/unacceptable"
|
|
47714
|
+
},
|
|
47060
47715
|
"500": {
|
|
47061
47716
|
"$ref": "#/components/responses/internal_error"
|
|
47062
47717
|
},
|
|
@@ -52092,587 +52747,7 @@
|
|
|
52092
52747
|
"x-octokit": {}
|
|
52093
52748
|
}
|
|
52094
52749
|
},
|
|
52095
|
-
"/
|
|
52096
|
-
"get": {
|
|
52097
|
-
"summary": "List environment secrets",
|
|
52098
|
-
"description": "Lists all secrets available in an environment without revealing their\nencrypted values.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
|
|
52099
|
-
"tags": [
|
|
52100
|
-
"actions"
|
|
52101
|
-
],
|
|
52102
|
-
"operationId": "actions/list-environment-secrets",
|
|
52103
|
-
"externalDocs": {
|
|
52104
|
-
"description": "API method documentation",
|
|
52105
|
-
"url": "https://docs.github.com/enterprise-server@3.10/rest/actions/secrets#list-environment-secrets"
|
|
52106
|
-
},
|
|
52107
|
-
"parameters": [
|
|
52108
|
-
{
|
|
52109
|
-
"$ref": "#/components/parameters/repository-id"
|
|
52110
|
-
},
|
|
52111
|
-
{
|
|
52112
|
-
"$ref": "#/components/parameters/environment-name"
|
|
52113
|
-
},
|
|
52114
|
-
{
|
|
52115
|
-
"$ref": "#/components/parameters/per-page"
|
|
52116
|
-
},
|
|
52117
|
-
{
|
|
52118
|
-
"$ref": "#/components/parameters/page"
|
|
52119
|
-
}
|
|
52120
|
-
],
|
|
52121
|
-
"responses": {
|
|
52122
|
-
"200": {
|
|
52123
|
-
"description": "Response",
|
|
52124
|
-
"content": {
|
|
52125
|
-
"application/json": {
|
|
52126
|
-
"schema": {
|
|
52127
|
-
"type": "object",
|
|
52128
|
-
"required": [
|
|
52129
|
-
"total_count",
|
|
52130
|
-
"secrets"
|
|
52131
|
-
],
|
|
52132
|
-
"properties": {
|
|
52133
|
-
"total_count": {
|
|
52134
|
-
"type": "integer"
|
|
52135
|
-
},
|
|
52136
|
-
"secrets": {
|
|
52137
|
-
"type": "array",
|
|
52138
|
-
"items": {
|
|
52139
|
-
"$ref": "#/components/schemas/actions-secret"
|
|
52140
|
-
}
|
|
52141
|
-
}
|
|
52142
|
-
}
|
|
52143
|
-
},
|
|
52144
|
-
"examples": {
|
|
52145
|
-
"default": {
|
|
52146
|
-
"$ref": "#/components/examples/actions-secret-paginated"
|
|
52147
|
-
}
|
|
52148
|
-
}
|
|
52149
|
-
}
|
|
52150
|
-
},
|
|
52151
|
-
"headers": {
|
|
52152
|
-
"Link": {
|
|
52153
|
-
"$ref": "#/components/headers/link"
|
|
52154
|
-
}
|
|
52155
|
-
}
|
|
52156
|
-
}
|
|
52157
|
-
},
|
|
52158
|
-
"x-github": {
|
|
52159
|
-
"githubCloudOnly": false,
|
|
52160
|
-
"enabledForGitHubApps": true,
|
|
52161
|
-
"category": "actions",
|
|
52162
|
-
"subcategory": "secrets"
|
|
52163
|
-
},
|
|
52164
|
-
"x-octokit": {}
|
|
52165
|
-
}
|
|
52166
|
-
},
|
|
52167
|
-
"/repositories/{repository_id}/environments/{environment_name}/secrets/public-key": {
|
|
52168
|
-
"get": {
|
|
52169
|
-
"summary": "Get an environment public key",
|
|
52170
|
-
"description": "Get the public key for an environment, which you need to encrypt environment\nsecrets. You need to encrypt a secret before you can create or update secrets.\n\nAnyone with read access to the repository can use this endpoint.\n\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
|
|
52171
|
-
"tags": [
|
|
52172
|
-
"actions"
|
|
52173
|
-
],
|
|
52174
|
-
"operationId": "actions/get-environment-public-key",
|
|
52175
|
-
"externalDocs": {
|
|
52176
|
-
"description": "API method documentation",
|
|
52177
|
-
"url": "https://docs.github.com/enterprise-server@3.10/rest/actions/secrets#get-an-environment-public-key"
|
|
52178
|
-
},
|
|
52179
|
-
"parameters": [
|
|
52180
|
-
{
|
|
52181
|
-
"$ref": "#/components/parameters/repository-id"
|
|
52182
|
-
},
|
|
52183
|
-
{
|
|
52184
|
-
"$ref": "#/components/parameters/environment-name"
|
|
52185
|
-
}
|
|
52186
|
-
],
|
|
52187
|
-
"responses": {
|
|
52188
|
-
"200": {
|
|
52189
|
-
"description": "Response",
|
|
52190
|
-
"content": {
|
|
52191
|
-
"application/json": {
|
|
52192
|
-
"schema": {
|
|
52193
|
-
"$ref": "#/components/schemas/actions-public-key"
|
|
52194
|
-
},
|
|
52195
|
-
"examples": {
|
|
52196
|
-
"default": {
|
|
52197
|
-
"$ref": "#/components/examples/actions-public-key"
|
|
52198
|
-
}
|
|
52199
|
-
}
|
|
52200
|
-
}
|
|
52201
|
-
}
|
|
52202
|
-
}
|
|
52203
|
-
},
|
|
52204
|
-
"x-github": {
|
|
52205
|
-
"githubCloudOnly": false,
|
|
52206
|
-
"enabledForGitHubApps": true,
|
|
52207
|
-
"category": "actions",
|
|
52208
|
-
"subcategory": "secrets"
|
|
52209
|
-
},
|
|
52210
|
-
"x-octokit": {}
|
|
52211
|
-
}
|
|
52212
|
-
},
|
|
52213
|
-
"/repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}": {
|
|
52214
|
-
"get": {
|
|
52215
|
-
"summary": "Get an environment secret",
|
|
52216
|
-
"description": "Gets a single environment secret without revealing its encrypted value.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
|
|
52217
|
-
"tags": [
|
|
52218
|
-
"actions"
|
|
52219
|
-
],
|
|
52220
|
-
"operationId": "actions/get-environment-secret",
|
|
52221
|
-
"externalDocs": {
|
|
52222
|
-
"description": "API method documentation",
|
|
52223
|
-
"url": "https://docs.github.com/enterprise-server@3.10/rest/actions/secrets#get-an-environment-secret"
|
|
52224
|
-
},
|
|
52225
|
-
"parameters": [
|
|
52226
|
-
{
|
|
52227
|
-
"$ref": "#/components/parameters/repository-id"
|
|
52228
|
-
},
|
|
52229
|
-
{
|
|
52230
|
-
"$ref": "#/components/parameters/environment-name"
|
|
52231
|
-
},
|
|
52232
|
-
{
|
|
52233
|
-
"$ref": "#/components/parameters/secret-name"
|
|
52234
|
-
}
|
|
52235
|
-
],
|
|
52236
|
-
"responses": {
|
|
52237
|
-
"200": {
|
|
52238
|
-
"description": "Response",
|
|
52239
|
-
"content": {
|
|
52240
|
-
"application/json": {
|
|
52241
|
-
"schema": {
|
|
52242
|
-
"$ref": "#/components/schemas/actions-secret"
|
|
52243
|
-
},
|
|
52244
|
-
"examples": {
|
|
52245
|
-
"default": {
|
|
52246
|
-
"$ref": "#/components/examples/actions-secret"
|
|
52247
|
-
}
|
|
52248
|
-
}
|
|
52249
|
-
}
|
|
52250
|
-
}
|
|
52251
|
-
}
|
|
52252
|
-
},
|
|
52253
|
-
"x-github": {
|
|
52254
|
-
"githubCloudOnly": false,
|
|
52255
|
-
"enabledForGitHubApps": true,
|
|
52256
|
-
"category": "actions",
|
|
52257
|
-
"subcategory": "secrets"
|
|
52258
|
-
},
|
|
52259
|
-
"x-octokit": {}
|
|
52260
|
-
},
|
|
52261
|
-
"put": {
|
|
52262
|
-
"summary": "Create or update an environment secret",
|
|
52263
|
-
"description": "Creates or updates an environment secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
|
|
52264
|
-
"tags": [
|
|
52265
|
-
"actions"
|
|
52266
|
-
],
|
|
52267
|
-
"operationId": "actions/create-or-update-environment-secret",
|
|
52268
|
-
"externalDocs": {
|
|
52269
|
-
"description": "API method documentation",
|
|
52270
|
-
"url": "https://docs.github.com/enterprise-server@3.10/rest/actions/secrets#create-or-update-an-environment-secret"
|
|
52271
|
-
},
|
|
52272
|
-
"parameters": [
|
|
52273
|
-
{
|
|
52274
|
-
"$ref": "#/components/parameters/repository-id"
|
|
52275
|
-
},
|
|
52276
|
-
{
|
|
52277
|
-
"$ref": "#/components/parameters/environment-name"
|
|
52278
|
-
},
|
|
52279
|
-
{
|
|
52280
|
-
"$ref": "#/components/parameters/secret-name"
|
|
52281
|
-
}
|
|
52282
|
-
],
|
|
52283
|
-
"requestBody": {
|
|
52284
|
-
"required": true,
|
|
52285
|
-
"content": {
|
|
52286
|
-
"application/json": {
|
|
52287
|
-
"schema": {
|
|
52288
|
-
"type": "object",
|
|
52289
|
-
"properties": {
|
|
52290
|
-
"encrypted_value": {
|
|
52291
|
-
"type": "string",
|
|
52292
|
-
"description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https://docs.github.com/enterprise-server@3.10/rest/actions/secrets#get-an-environment-public-key) endpoint.",
|
|
52293
|
-
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$"
|
|
52294
|
-
},
|
|
52295
|
-
"key_id": {
|
|
52296
|
-
"type": "string",
|
|
52297
|
-
"description": "ID of the key you used to encrypt the secret."
|
|
52298
|
-
}
|
|
52299
|
-
},
|
|
52300
|
-
"required": [
|
|
52301
|
-
"encrypted_value",
|
|
52302
|
-
"key_id"
|
|
52303
|
-
]
|
|
52304
|
-
},
|
|
52305
|
-
"examples": {
|
|
52306
|
-
"default": {
|
|
52307
|
-
"value": {
|
|
52308
|
-
"encrypted_value": "c2VjcmV0",
|
|
52309
|
-
"key_id": "012345678912345678"
|
|
52310
|
-
}
|
|
52311
|
-
}
|
|
52312
|
-
}
|
|
52313
|
-
}
|
|
52314
|
-
}
|
|
52315
|
-
},
|
|
52316
|
-
"responses": {
|
|
52317
|
-
"201": {
|
|
52318
|
-
"description": "Response when creating a secret",
|
|
52319
|
-
"content": {
|
|
52320
|
-
"application/json": {
|
|
52321
|
-
"schema": {
|
|
52322
|
-
"$ref": "#/components/schemas/empty-object"
|
|
52323
|
-
},
|
|
52324
|
-
"examples": {
|
|
52325
|
-
"default": {
|
|
52326
|
-
"value": null
|
|
52327
|
-
}
|
|
52328
|
-
}
|
|
52329
|
-
}
|
|
52330
|
-
}
|
|
52331
|
-
},
|
|
52332
|
-
"204": {
|
|
52333
|
-
"description": "Response when updating a secret"
|
|
52334
|
-
}
|
|
52335
|
-
},
|
|
52336
|
-
"x-github": {
|
|
52337
|
-
"githubCloudOnly": false,
|
|
52338
|
-
"enabledForGitHubApps": true,
|
|
52339
|
-
"category": "actions",
|
|
52340
|
-
"subcategory": "secrets"
|
|
52341
|
-
},
|
|
52342
|
-
"x-octokit": {}
|
|
52343
|
-
},
|
|
52344
|
-
"delete": {
|
|
52345
|
-
"summary": "Delete an environment secret",
|
|
52346
|
-
"description": "Deletes a secret in an environment using the secret name.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
|
|
52347
|
-
"tags": [
|
|
52348
|
-
"actions"
|
|
52349
|
-
],
|
|
52350
|
-
"operationId": "actions/delete-environment-secret",
|
|
52351
|
-
"externalDocs": {
|
|
52352
|
-
"description": "API method documentation",
|
|
52353
|
-
"url": "https://docs.github.com/enterprise-server@3.10/rest/actions/secrets#delete-an-environment-secret"
|
|
52354
|
-
},
|
|
52355
|
-
"parameters": [
|
|
52356
|
-
{
|
|
52357
|
-
"$ref": "#/components/parameters/repository-id"
|
|
52358
|
-
},
|
|
52359
|
-
{
|
|
52360
|
-
"$ref": "#/components/parameters/environment-name"
|
|
52361
|
-
},
|
|
52362
|
-
{
|
|
52363
|
-
"$ref": "#/components/parameters/secret-name"
|
|
52364
|
-
}
|
|
52365
|
-
],
|
|
52366
|
-
"responses": {
|
|
52367
|
-
"204": {
|
|
52368
|
-
"description": "Default response"
|
|
52369
|
-
}
|
|
52370
|
-
},
|
|
52371
|
-
"x-github": {
|
|
52372
|
-
"githubCloudOnly": false,
|
|
52373
|
-
"enabledForGitHubApps": true,
|
|
52374
|
-
"category": "actions",
|
|
52375
|
-
"subcategory": "secrets"
|
|
52376
|
-
},
|
|
52377
|
-
"x-octokit": {}
|
|
52378
|
-
}
|
|
52379
|
-
},
|
|
52380
|
-
"/repositories/{repository_id}/environments/{environment_name}/variables": {
|
|
52381
|
-
"get": {
|
|
52382
|
-
"summary": "List environment variables",
|
|
52383
|
-
"description": "Lists all environment variables.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
|
|
52384
|
-
"tags": [
|
|
52385
|
-
"actions"
|
|
52386
|
-
],
|
|
52387
|
-
"operationId": "actions/list-environment-variables",
|
|
52388
|
-
"externalDocs": {
|
|
52389
|
-
"description": "API method documentation",
|
|
52390
|
-
"url": "https://docs.github.com/enterprise-server@3.10/rest/actions/variables#list-environment-variables"
|
|
52391
|
-
},
|
|
52392
|
-
"parameters": [
|
|
52393
|
-
{
|
|
52394
|
-
"$ref": "#/components/parameters/repository-id"
|
|
52395
|
-
},
|
|
52396
|
-
{
|
|
52397
|
-
"$ref": "#/components/parameters/environment-name"
|
|
52398
|
-
},
|
|
52399
|
-
{
|
|
52400
|
-
"$ref": "#/components/parameters/variables-per-page"
|
|
52401
|
-
},
|
|
52402
|
-
{
|
|
52403
|
-
"$ref": "#/components/parameters/page"
|
|
52404
|
-
}
|
|
52405
|
-
],
|
|
52406
|
-
"responses": {
|
|
52407
|
-
"200": {
|
|
52408
|
-
"description": "Response",
|
|
52409
|
-
"content": {
|
|
52410
|
-
"application/json": {
|
|
52411
|
-
"schema": {
|
|
52412
|
-
"type": "object",
|
|
52413
|
-
"required": [
|
|
52414
|
-
"total_count",
|
|
52415
|
-
"variables"
|
|
52416
|
-
],
|
|
52417
|
-
"properties": {
|
|
52418
|
-
"total_count": {
|
|
52419
|
-
"type": "integer"
|
|
52420
|
-
},
|
|
52421
|
-
"variables": {
|
|
52422
|
-
"type": "array",
|
|
52423
|
-
"items": {
|
|
52424
|
-
"$ref": "#/components/schemas/actions-variable"
|
|
52425
|
-
}
|
|
52426
|
-
}
|
|
52427
|
-
}
|
|
52428
|
-
},
|
|
52429
|
-
"examples": {
|
|
52430
|
-
"default": {
|
|
52431
|
-
"$ref": "#/components/examples/actions-variables-paginated"
|
|
52432
|
-
}
|
|
52433
|
-
}
|
|
52434
|
-
}
|
|
52435
|
-
},
|
|
52436
|
-
"headers": {
|
|
52437
|
-
"Link": {
|
|
52438
|
-
"$ref": "#/components/headers/link"
|
|
52439
|
-
}
|
|
52440
|
-
}
|
|
52441
|
-
}
|
|
52442
|
-
},
|
|
52443
|
-
"x-github": {
|
|
52444
|
-
"githubCloudOnly": false,
|
|
52445
|
-
"enabledForGitHubApps": true,
|
|
52446
|
-
"category": "actions",
|
|
52447
|
-
"subcategory": "variables"
|
|
52448
|
-
},
|
|
52449
|
-
"x-octokit": {}
|
|
52450
|
-
},
|
|
52451
|
-
"post": {
|
|
52452
|
-
"summary": "Create an environment variable",
|
|
52453
|
-
"description": "Create an environment variable that you can reference in a GitHub Actions workflow.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
|
|
52454
|
-
"tags": [
|
|
52455
|
-
"actions"
|
|
52456
|
-
],
|
|
52457
|
-
"operationId": "actions/create-environment-variable",
|
|
52458
|
-
"externalDocs": {
|
|
52459
|
-
"description": "API method documentation",
|
|
52460
|
-
"url": "https://docs.github.com/enterprise-server@3.10/rest/actions/variables#create-an-environment-variable"
|
|
52461
|
-
},
|
|
52462
|
-
"parameters": [
|
|
52463
|
-
{
|
|
52464
|
-
"$ref": "#/components/parameters/repository-id"
|
|
52465
|
-
},
|
|
52466
|
-
{
|
|
52467
|
-
"$ref": "#/components/parameters/environment-name"
|
|
52468
|
-
}
|
|
52469
|
-
],
|
|
52470
|
-
"requestBody": {
|
|
52471
|
-
"required": true,
|
|
52472
|
-
"content": {
|
|
52473
|
-
"application/json": {
|
|
52474
|
-
"schema": {
|
|
52475
|
-
"type": "object",
|
|
52476
|
-
"properties": {
|
|
52477
|
-
"name": {
|
|
52478
|
-
"type": "string",
|
|
52479
|
-
"description": "The name of the variable."
|
|
52480
|
-
},
|
|
52481
|
-
"value": {
|
|
52482
|
-
"type": "string",
|
|
52483
|
-
"description": "The value of the variable."
|
|
52484
|
-
}
|
|
52485
|
-
},
|
|
52486
|
-
"required": [
|
|
52487
|
-
"name",
|
|
52488
|
-
"value"
|
|
52489
|
-
]
|
|
52490
|
-
},
|
|
52491
|
-
"examples": {
|
|
52492
|
-
"default": {
|
|
52493
|
-
"value": {
|
|
52494
|
-
"name": "USERNAME",
|
|
52495
|
-
"value": "octocat"
|
|
52496
|
-
}
|
|
52497
|
-
}
|
|
52498
|
-
}
|
|
52499
|
-
}
|
|
52500
|
-
}
|
|
52501
|
-
},
|
|
52502
|
-
"responses": {
|
|
52503
|
-
"201": {
|
|
52504
|
-
"description": "Response",
|
|
52505
|
-
"content": {
|
|
52506
|
-
"application/json": {
|
|
52507
|
-
"schema": {
|
|
52508
|
-
"$ref": "#/components/schemas/empty-object"
|
|
52509
|
-
},
|
|
52510
|
-
"examples": {
|
|
52511
|
-
"default": {
|
|
52512
|
-
"value": null
|
|
52513
|
-
}
|
|
52514
|
-
}
|
|
52515
|
-
}
|
|
52516
|
-
}
|
|
52517
|
-
}
|
|
52518
|
-
},
|
|
52519
|
-
"x-github": {
|
|
52520
|
-
"githubCloudOnly": false,
|
|
52521
|
-
"enabledForGitHubApps": true,
|
|
52522
|
-
"category": "actions",
|
|
52523
|
-
"subcategory": "variables"
|
|
52524
|
-
},
|
|
52525
|
-
"x-octokit": {}
|
|
52526
|
-
}
|
|
52527
|
-
},
|
|
52528
|
-
"/repositories/{repository_id}/environments/{environment_name}/variables/{name}": {
|
|
52529
|
-
"get": {
|
|
52530
|
-
"summary": "Get an environment variable",
|
|
52531
|
-
"description": "Gets a specific variable in an environment.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
|
|
52532
|
-
"tags": [
|
|
52533
|
-
"actions"
|
|
52534
|
-
],
|
|
52535
|
-
"operationId": "actions/get-environment-variable",
|
|
52536
|
-
"externalDocs": {
|
|
52537
|
-
"description": "API method documentation",
|
|
52538
|
-
"url": "https://docs.github.com/enterprise-server@3.10/rest/actions/variables#get-an-environment-variable"
|
|
52539
|
-
},
|
|
52540
|
-
"parameters": [
|
|
52541
|
-
{
|
|
52542
|
-
"$ref": "#/components/parameters/repository-id"
|
|
52543
|
-
},
|
|
52544
|
-
{
|
|
52545
|
-
"$ref": "#/components/parameters/environment-name"
|
|
52546
|
-
},
|
|
52547
|
-
{
|
|
52548
|
-
"$ref": "#/components/parameters/variable-name"
|
|
52549
|
-
}
|
|
52550
|
-
],
|
|
52551
|
-
"responses": {
|
|
52552
|
-
"200": {
|
|
52553
|
-
"description": "Response",
|
|
52554
|
-
"content": {
|
|
52555
|
-
"application/json": {
|
|
52556
|
-
"schema": {
|
|
52557
|
-
"$ref": "#/components/schemas/actions-variable"
|
|
52558
|
-
},
|
|
52559
|
-
"examples": {
|
|
52560
|
-
"default": {
|
|
52561
|
-
"$ref": "#/components/examples/actions-variable"
|
|
52562
|
-
}
|
|
52563
|
-
}
|
|
52564
|
-
}
|
|
52565
|
-
}
|
|
52566
|
-
}
|
|
52567
|
-
},
|
|
52568
|
-
"x-github": {
|
|
52569
|
-
"githubCloudOnly": false,
|
|
52570
|
-
"enabledForGitHubApps": true,
|
|
52571
|
-
"category": "actions",
|
|
52572
|
-
"subcategory": "variables"
|
|
52573
|
-
},
|
|
52574
|
-
"x-octokit": {}
|
|
52575
|
-
},
|
|
52576
|
-
"patch": {
|
|
52577
|
-
"summary": "Update an environment variable",
|
|
52578
|
-
"description": "Updates an environment variable that you can reference in a GitHub Actions workflow.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
|
|
52579
|
-
"tags": [
|
|
52580
|
-
"actions"
|
|
52581
|
-
],
|
|
52582
|
-
"operationId": "actions/update-environment-variable",
|
|
52583
|
-
"externalDocs": {
|
|
52584
|
-
"description": "API method documentation",
|
|
52585
|
-
"url": "https://docs.github.com/enterprise-server@3.10/rest/actions/variables#update-an-environment-variable"
|
|
52586
|
-
},
|
|
52587
|
-
"parameters": [
|
|
52588
|
-
{
|
|
52589
|
-
"$ref": "#/components/parameters/repository-id"
|
|
52590
|
-
},
|
|
52591
|
-
{
|
|
52592
|
-
"$ref": "#/components/parameters/variable-name"
|
|
52593
|
-
},
|
|
52594
|
-
{
|
|
52595
|
-
"$ref": "#/components/parameters/environment-name"
|
|
52596
|
-
}
|
|
52597
|
-
],
|
|
52598
|
-
"requestBody": {
|
|
52599
|
-
"required": true,
|
|
52600
|
-
"content": {
|
|
52601
|
-
"application/json": {
|
|
52602
|
-
"schema": {
|
|
52603
|
-
"type": "object",
|
|
52604
|
-
"properties": {
|
|
52605
|
-
"name": {
|
|
52606
|
-
"type": "string",
|
|
52607
|
-
"description": "The name of the variable."
|
|
52608
|
-
},
|
|
52609
|
-
"value": {
|
|
52610
|
-
"type": "string",
|
|
52611
|
-
"description": "The value of the variable."
|
|
52612
|
-
}
|
|
52613
|
-
}
|
|
52614
|
-
},
|
|
52615
|
-
"examples": {
|
|
52616
|
-
"default": {
|
|
52617
|
-
"value": {
|
|
52618
|
-
"name": "USERNAME",
|
|
52619
|
-
"value": "octocat"
|
|
52620
|
-
}
|
|
52621
|
-
}
|
|
52622
|
-
}
|
|
52623
|
-
}
|
|
52624
|
-
}
|
|
52625
|
-
},
|
|
52626
|
-
"responses": {
|
|
52627
|
-
"204": {
|
|
52628
|
-
"description": "Response"
|
|
52629
|
-
}
|
|
52630
|
-
},
|
|
52631
|
-
"x-github": {
|
|
52632
|
-
"githubCloudOnly": false,
|
|
52633
|
-
"enabledForGitHubApps": true,
|
|
52634
|
-
"category": "actions",
|
|
52635
|
-
"subcategory": "variables"
|
|
52636
|
-
},
|
|
52637
|
-
"x-octokit": {}
|
|
52638
|
-
},
|
|
52639
|
-
"delete": {
|
|
52640
|
-
"summary": "Delete an environment variable",
|
|
52641
|
-
"description": "Deletes an environment variable using the variable name.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
|
|
52642
|
-
"tags": [
|
|
52643
|
-
"actions"
|
|
52644
|
-
],
|
|
52645
|
-
"operationId": "actions/delete-environment-variable",
|
|
52646
|
-
"externalDocs": {
|
|
52647
|
-
"description": "API method documentation",
|
|
52648
|
-
"url": "https://docs.github.com/enterprise-server@3.10/rest/actions/variables#delete-an-environment-variable"
|
|
52649
|
-
},
|
|
52650
|
-
"parameters": [
|
|
52651
|
-
{
|
|
52652
|
-
"$ref": "#/components/parameters/repository-id"
|
|
52653
|
-
},
|
|
52654
|
-
{
|
|
52655
|
-
"$ref": "#/components/parameters/variable-name"
|
|
52656
|
-
},
|
|
52657
|
-
{
|
|
52658
|
-
"$ref": "#/components/parameters/environment-name"
|
|
52659
|
-
}
|
|
52660
|
-
],
|
|
52661
|
-
"responses": {
|
|
52662
|
-
"204": {
|
|
52663
|
-
"description": "Response"
|
|
52664
|
-
}
|
|
52665
|
-
},
|
|
52666
|
-
"x-github": {
|
|
52667
|
-
"githubCloudOnly": false,
|
|
52668
|
-
"enabledForGitHubApps": true,
|
|
52669
|
-
"category": "actions",
|
|
52670
|
-
"subcategory": "variables"
|
|
52671
|
-
},
|
|
52672
|
-
"x-octokit": {}
|
|
52673
|
-
}
|
|
52674
|
-
},
|
|
52675
|
-
"/scim/v2/Groups": {
|
|
52750
|
+
"/scim/v2/enterprises/{enterprise}/Groups": {
|
|
52676
52751
|
"get": {
|
|
52677
52752
|
"summary": "List provisioned SCIM groups for an enterprise",
|
|
52678
52753
|
"description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nLists provisioned SCIM groups in an enterprise.\n\nYou can improve query search time by using the `excludedAttributes` query parameter with a value of `members` to exclude members from the response.",
|
|
@@ -52711,6 +52786,9 @@
|
|
|
52711
52786
|
},
|
|
52712
52787
|
{
|
|
52713
52788
|
"$ref": "#/components/parameters/count"
|
|
52789
|
+
},
|
|
52790
|
+
{
|
|
52791
|
+
"$ref": "#/components/parameters/enterprise"
|
|
52714
52792
|
}
|
|
52715
52793
|
],
|
|
52716
52794
|
"responses": {
|
|
@@ -52764,6 +52842,11 @@
|
|
|
52764
52842
|
"description": "API method documentation",
|
|
52765
52843
|
"url": "https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/scim#provision-a-scim-enterprise-group"
|
|
52766
52844
|
},
|
|
52845
|
+
"parameters": [
|
|
52846
|
+
{
|
|
52847
|
+
"$ref": "#/components/parameters/enterprise"
|
|
52848
|
+
}
|
|
52849
|
+
],
|
|
52767
52850
|
"requestBody": {
|
|
52768
52851
|
"required": true,
|
|
52769
52852
|
"content": {
|
|
@@ -52829,7 +52912,7 @@
|
|
|
52829
52912
|
"x-octokit": {}
|
|
52830
52913
|
}
|
|
52831
52914
|
},
|
|
52832
|
-
"/scim/v2/Groups/{scim_group_id}": {
|
|
52915
|
+
"/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}": {
|
|
52833
52916
|
"get": {
|
|
52834
52917
|
"summary": "Get SCIM provisioning information for an enterprise group",
|
|
52835
52918
|
"description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nGets information about a SCIM group.",
|
|
@@ -52847,6 +52930,9 @@
|
|
|
52847
52930
|
},
|
|
52848
52931
|
{
|
|
52849
52932
|
"$ref": "#/components/parameters/excluded-attributes"
|
|
52933
|
+
},
|
|
52934
|
+
{
|
|
52935
|
+
"$ref": "#/components/parameters/enterprise"
|
|
52850
52936
|
}
|
|
52851
52937
|
],
|
|
52852
52938
|
"responses": {
|
|
@@ -52906,6 +52992,9 @@
|
|
|
52906
52992
|
"parameters": [
|
|
52907
52993
|
{
|
|
52908
52994
|
"$ref": "#/components/parameters/scim-group-id"
|
|
52995
|
+
},
|
|
52996
|
+
{
|
|
52997
|
+
"$ref": "#/components/parameters/enterprise"
|
|
52909
52998
|
}
|
|
52910
52999
|
],
|
|
52911
53000
|
"requestBody": {
|
|
@@ -53013,6 +53102,9 @@
|
|
|
53013
53102
|
"parameters": [
|
|
53014
53103
|
{
|
|
53015
53104
|
"$ref": "#/components/parameters/scim-group-id"
|
|
53105
|
+
},
|
|
53106
|
+
{
|
|
53107
|
+
"$ref": "#/components/parameters/enterprise"
|
|
53016
53108
|
}
|
|
53017
53109
|
],
|
|
53018
53110
|
"requestBody": {
|
|
@@ -53130,6 +53222,9 @@
|
|
|
53130
53222
|
"parameters": [
|
|
53131
53223
|
{
|
|
53132
53224
|
"$ref": "#/components/parameters/scim-group-id"
|
|
53225
|
+
},
|
|
53226
|
+
{
|
|
53227
|
+
"$ref": "#/components/parameters/enterprise"
|
|
53133
53228
|
}
|
|
53134
53229
|
],
|
|
53135
53230
|
"responses": {
|
|
@@ -53164,7 +53259,7 @@
|
|
|
53164
53259
|
"x-octokit": {}
|
|
53165
53260
|
}
|
|
53166
53261
|
},
|
|
53167
|
-
"/scim/v2/Users": {
|
|
53262
|
+
"/scim/v2/enterprises/{enterprise}/Users": {
|
|
53168
53263
|
"get": {
|
|
53169
53264
|
"summary": "List SCIM provisioned identities for an enterprise",
|
|
53170
53265
|
"description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nLists provisioned SCIM enterprise members.\n\nWhen a user with a SCIM-provisioned external identity is removed from an enterprise through a `patch` with `active` flag set to `false`, the account's metadata is preserved to allow the user to re-join the enterprise in the future. However, the user's account will be suspended and the user will not be able to sign-in. In order to permanently suspend the users account with no ability to re-join the enterprise in the future, use the `delete` request. Users that were not permanently deleted will be visible in the returned results.",
|
|
@@ -53199,6 +53294,9 @@
|
|
|
53199
53294
|
},
|
|
53200
53295
|
{
|
|
53201
53296
|
"$ref": "#/components/parameters/count"
|
|
53297
|
+
},
|
|
53298
|
+
{
|
|
53299
|
+
"$ref": "#/components/parameters/enterprise"
|
|
53202
53300
|
}
|
|
53203
53301
|
],
|
|
53204
53302
|
"responses": {
|
|
@@ -53252,6 +53350,11 @@
|
|
|
53252
53350
|
"description": "API method documentation",
|
|
53253
53351
|
"url": "https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/scim#provision-a-scim-enterprise-user"
|
|
53254
53352
|
},
|
|
53353
|
+
"parameters": [
|
|
53354
|
+
{
|
|
53355
|
+
"$ref": "#/components/parameters/enterprise"
|
|
53356
|
+
}
|
|
53357
|
+
],
|
|
53255
53358
|
"requestBody": {
|
|
53256
53359
|
"required": true,
|
|
53257
53360
|
"content": {
|
|
@@ -53317,7 +53420,7 @@
|
|
|
53317
53420
|
"x-octokit": {}
|
|
53318
53421
|
}
|
|
53319
53422
|
},
|
|
53320
|
-
"/scim/v2/Users/{scim_user_id}": {
|
|
53423
|
+
"/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}": {
|
|
53321
53424
|
"get": {
|
|
53322
53425
|
"summary": "Get SCIM provisioning information for an enterprise user",
|
|
53323
53426
|
"description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nGets information about a SCIM user.",
|
|
@@ -53332,6 +53435,9 @@
|
|
|
53332
53435
|
"parameters": [
|
|
53333
53436
|
{
|
|
53334
53437
|
"$ref": "#/components/parameters/scim-user-id"
|
|
53438
|
+
},
|
|
53439
|
+
{
|
|
53440
|
+
"$ref": "#/components/parameters/enterprise"
|
|
53335
53441
|
}
|
|
53336
53442
|
],
|
|
53337
53443
|
"responses": {
|
|
@@ -53391,6 +53497,9 @@
|
|
|
53391
53497
|
"parameters": [
|
|
53392
53498
|
{
|
|
53393
53499
|
"$ref": "#/components/parameters/scim-user-id"
|
|
53500
|
+
},
|
|
53501
|
+
{
|
|
53502
|
+
"$ref": "#/components/parameters/enterprise"
|
|
53394
53503
|
}
|
|
53395
53504
|
],
|
|
53396
53505
|
"requestBody": {
|
|
@@ -53468,6 +53577,9 @@
|
|
|
53468
53577
|
"parameters": [
|
|
53469
53578
|
{
|
|
53470
53579
|
"$ref": "#/components/parameters/scim-user-id"
|
|
53580
|
+
},
|
|
53581
|
+
{
|
|
53582
|
+
"$ref": "#/components/parameters/enterprise"
|
|
53471
53583
|
}
|
|
53472
53584
|
],
|
|
53473
53585
|
"requestBody": {
|
|
@@ -53603,6 +53715,9 @@
|
|
|
53603
53715
|
"parameters": [
|
|
53604
53716
|
{
|
|
53605
53717
|
"$ref": "#/components/parameters/scim-user-id"
|
|
53718
|
+
},
|
|
53719
|
+
{
|
|
53720
|
+
"$ref": "#/components/parameters/enterprise"
|
|
53606
53721
|
}
|
|
53607
53722
|
],
|
|
53608
53723
|
"responses": {
|
|
@@ -62045,7 +62160,7 @@
|
|
|
62045
62160
|
"/users/{username}/hovercard": {
|
|
62046
62161
|
"get": {
|
|
62047
62162
|
"summary": "Get contextual information for a user",
|
|
62048
|
-
"description": "Provides hovercard information. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations.\n\
|
|
62163
|
+
"description": "Provides hovercard information. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations.\n\n The `subject_type` and `subject_id` parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about `octocat` who owns the `Spoon-Knife` repository, you would use a `subject_type` value of `repository` and a `subject_id` value of `1300192` (the ID of the `Spoon-Knife` repository).\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
|
|
62049
62164
|
"tags": [
|
|
62050
62165
|
"users"
|
|
62051
62166
|
],
|
|
@@ -83000,8 +83115,7 @@
|
|
|
83000
83115
|
},
|
|
83001
83116
|
"repository-dispatch-sample.collected": {
|
|
83002
83117
|
"post": {
|
|
83003
|
-
"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.10/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.",
|
|
83004
|
-
"description": "The `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body.",
|
|
83118
|
+
"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.10/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.",
|
|
83005
83119
|
"operationId": "repository-dispatch/sample.collected",
|
|
83006
83120
|
"externalDocs": {
|
|
83007
83121
|
"url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#repository_dispatch"
|
|
@@ -88063,7 +88177,8 @@
|
|
|
88063
88177
|
},
|
|
88064
88178
|
"hub_url": {
|
|
88065
88179
|
"type": "string",
|
|
88066
|
-
"format": "uri-template"
|
|
88180
|
+
"format": "uri-template",
|
|
88181
|
+
"deprecated": true
|
|
88067
88182
|
},
|
|
88068
88183
|
"issue_search_url": {
|
|
88069
88184
|
"type": "string",
|
|
@@ -88159,7 +88274,6 @@
|
|
|
88159
88274
|
"followers_url",
|
|
88160
88275
|
"following_url",
|
|
88161
88276
|
"gists_url",
|
|
88162
|
-
"hub_url",
|
|
88163
88277
|
"issue_search_url",
|
|
88164
88278
|
"issues_url",
|
|
88165
88279
|
"keys_url",
|
|
@@ -101078,7 +101192,9 @@
|
|
|
101078
101192
|
"queued",
|
|
101079
101193
|
"in_progress",
|
|
101080
101194
|
"completed",
|
|
101081
|
-
"waiting"
|
|
101195
|
+
"waiting",
|
|
101196
|
+
"requested",
|
|
101197
|
+
"pending"
|
|
101082
101198
|
]
|
|
101083
101199
|
},
|
|
101084
101200
|
"conclusion": {
|
|
@@ -103549,13 +103665,16 @@
|
|
|
103549
103665
|
"nullable": true
|
|
103550
103666
|
},
|
|
103551
103667
|
"status": {
|
|
103552
|
-
"description": "The phase of the lifecycle that the check is currently in.",
|
|
103668
|
+
"description": "The phase of the lifecycle that the check is currently in. Statuses of waiting, requested, and pending are reserved for GitHub Actions check runs.",
|
|
103553
103669
|
"example": "queued",
|
|
103554
103670
|
"type": "string",
|
|
103555
103671
|
"enum": [
|
|
103556
103672
|
"queued",
|
|
103557
103673
|
"in_progress",
|
|
103558
|
-
"completed"
|
|
103674
|
+
"completed",
|
|
103675
|
+
"waiting",
|
|
103676
|
+
"requested",
|
|
103677
|
+
"pending"
|
|
103559
103678
|
]
|
|
103560
103679
|
},
|
|
103561
103680
|
"conclusion": {
|
|
@@ -103833,11 +103952,15 @@
|
|
|
103833
103952
|
},
|
|
103834
103953
|
"status": {
|
|
103835
103954
|
"type": "string",
|
|
103955
|
+
"description": "The phase of the lifecycle that the check suite is currently in. Statuses of waiting, requested, and pending are reserved for GitHub Actions check suites.",
|
|
103836
103956
|
"example": "completed",
|
|
103837
103957
|
"enum": [
|
|
103838
103958
|
"queued",
|
|
103839
103959
|
"in_progress",
|
|
103840
|
-
"completed"
|
|
103960
|
+
"completed",
|
|
103961
|
+
"waiting",
|
|
103962
|
+
"requested",
|
|
103963
|
+
"pending"
|
|
103841
103964
|
],
|
|
103842
103965
|
"nullable": true
|
|
103843
103966
|
},
|
|
@@ -167827,6 +167950,7 @@
|
|
|
167827
167950
|
"type": "object",
|
|
167828
167951
|
"properties": {
|
|
167829
167952
|
"permission": {
|
|
167953
|
+
"description": "This field is included for legacy purposes; use the `role_name` field instead. The `maintain`\nrole is mapped to `write` and the `triage` role is mapped to `read`. To determine the role\nassigned to the collaborator, use the `role_name` field instead, which will provide the full\nrole name, including custom roles.",
|
|
167830
167954
|
"type": "object",
|
|
167831
167955
|
"properties": {
|
|
167832
167956
|
"to": {
|
|
@@ -167841,6 +167965,18 @@
|
|
|
167841
167965
|
"required": [
|
|
167842
167966
|
"to"
|
|
167843
167967
|
]
|
|
167968
|
+
},
|
|
167969
|
+
"role_name": {
|
|
167970
|
+
"description": "The role assigned to the collaborator.",
|
|
167971
|
+
"type": "object",
|
|
167972
|
+
"properties": {
|
|
167973
|
+
"to": {
|
|
167974
|
+
"type": "string"
|
|
167975
|
+
}
|
|
167976
|
+
},
|
|
167977
|
+
"required": [
|
|
167978
|
+
"to"
|
|
167979
|
+
]
|
|
167844
167980
|
}
|
|
167845
167981
|
}
|
|
167846
167982
|
},
|
|
@@ -246387,7 +246523,7 @@
|
|
|
246387
246523
|
"type": "string"
|
|
246388
246524
|
},
|
|
246389
246525
|
"commits": {
|
|
246390
|
-
"description": "An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the `compare` between the `before` commit and the `after` commit.) The array includes a maximum of
|
|
246526
|
+
"description": "An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the `compare` between the `before` commit and the `after` commit.) The array includes a maximum of 2048 commits. If necessary, you can use the [Commits API](https://docs.github.com/enterprise-server@3.10/rest/commits) to fetch additional commits.",
|
|
246391
246527
|
"type": "array",
|
|
246392
246528
|
"items": {
|
|
246393
246529
|
"title": "Commit",
|
|
@@ -252207,9 +252343,7 @@
|
|
|
252207
252343
|
"properties": {
|
|
252208
252344
|
"action": {
|
|
252209
252345
|
"type": "string",
|
|
252210
|
-
"
|
|
252211
|
-
"sample.collected"
|
|
252212
|
-
]
|
|
252346
|
+
"description": "The `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body."
|
|
252213
252347
|
},
|
|
252214
252348
|
"branch": {
|
|
252215
252349
|
"type": "string"
|
|
@@ -252217,7 +252351,8 @@
|
|
|
252217
252351
|
"client_payload": {
|
|
252218
252352
|
"type": "object",
|
|
252219
252353
|
"nullable": true,
|
|
252220
|
-
"additionalProperties": true
|
|
252354
|
+
"additionalProperties": true,
|
|
252355
|
+
"description": "The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body."
|
|
252221
252356
|
},
|
|
252222
252357
|
"enterprise": {
|
|
252223
252358
|
"$ref": "#/components/schemas/enterprise-webhooks"
|
|
@@ -289046,6 +289181,20 @@
|
|
|
289046
289181
|
"commit_url": "https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b"
|
|
289047
289182
|
}
|
|
289048
289183
|
},
|
|
289184
|
+
{
|
|
289185
|
+
"type": "wiki_commit",
|
|
289186
|
+
"details": {
|
|
289187
|
+
"path": "/example/Home.md",
|
|
289188
|
+
"start_line": 1,
|
|
289189
|
+
"end_line": 1,
|
|
289190
|
+
"start_column": 1,
|
|
289191
|
+
"end_column": 64,
|
|
289192
|
+
"blob_sha": "af5626b4a114abcb82d63db7c8082c3c4756e51b",
|
|
289193
|
+
"page_url": "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5",
|
|
289194
|
+
"commit_sha": "302c0b7e200761c9dd9b57e57db540ee0b4293a5",
|
|
289195
|
+
"commit_url": "https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5"
|
|
289196
|
+
}
|
|
289197
|
+
},
|
|
289049
289198
|
{
|
|
289050
289199
|
"type": "issue_title",
|
|
289051
289200
|
"details": {
|
|
@@ -295546,7 +295695,7 @@
|
|
|
295546
295695
|
},
|
|
295547
295696
|
"workflow-run-status": {
|
|
295548
295697
|
"name": "status",
|
|
295549
|
-
"description": "Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`.",
|
|
295698
|
+
"description": "Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`.",
|
|
295550
295699
|
"in": "query",
|
|
295551
295700
|
"required": false,
|
|
295552
295701
|
"schema": {
|
|
@@ -295800,6 +295949,17 @@
|
|
|
295800
295949
|
"type": "integer"
|
|
295801
295950
|
}
|
|
295802
295951
|
},
|
|
295952
|
+
"git-ref-only": {
|
|
295953
|
+
"name": "ref",
|
|
295954
|
+
"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.",
|
|
295955
|
+
"in": "path",
|
|
295956
|
+
"required": true,
|
|
295957
|
+
"example": "heads/feature-a",
|
|
295958
|
+
"schema": {
|
|
295959
|
+
"type": "string"
|
|
295960
|
+
},
|
|
295961
|
+
"x-multi-segment": true
|
|
295962
|
+
},
|
|
295803
295963
|
"invitation-id": {
|
|
295804
295964
|
"name": "invitation_id",
|
|
295805
295965
|
"description": "The unique identifier of the invitation.",
|
|
@@ -296403,6 +296563,16 @@
|
|
|
296403
296563
|
}
|
|
296404
296564
|
}
|
|
296405
296565
|
},
|
|
296566
|
+
"unacceptable": {
|
|
296567
|
+
"description": "Unacceptable",
|
|
296568
|
+
"content": {
|
|
296569
|
+
"application/json": {
|
|
296570
|
+
"schema": {
|
|
296571
|
+
"$ref": "#/components/schemas/basic-error"
|
|
296572
|
+
}
|
|
296573
|
+
}
|
|
296574
|
+
}
|
|
296575
|
+
},
|
|
296406
296576
|
"scim_bad_request": {
|
|
296407
296577
|
"description": "Bad request",
|
|
296408
296578
|
"content": {
|