diff --git a/content/rest/enterprise-admin/custom-properties.md b/content/rest/enterprise-admin/custom-properties.md new file mode 100644 index 000000000000..e40d61824e26 --- /dev/null +++ b/content/rest/enterprise-admin/custom-properties.md @@ -0,0 +1,13 @@ +--- +title: Custom properties +shortTitle: Custom properties +intro: Use the REST API to manage custom properties for your enterprise. +versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖 + ghec: '*' +topics: + - API +autogenerated: rest +allowTitleToDifferFromFilename: true +--- + + diff --git a/content/rest/enterprise-admin/index.md b/content/rest/enterprise-admin/index.md index ebf810db3db8..baf214604eb6 100644 --- a/content/rest/enterprise-admin/index.md +++ b/content/rest/enterprise-admin/index.md @@ -18,6 +18,7 @@ children: - /audit-log - /billing - /code-security-and-analysis + - /custom-properties - /global-webhooks - /ldap - /license diff --git a/src/github-apps/data/ghec-2022-11-28/fine-grained-pat-permissions.json b/src/github-apps/data/ghec-2022-11-28/fine-grained-pat-permissions.json index 1fab75814936..463d89842556 100644 --- a/src/github-apps/data/ghec-2022-11-28/fine-grained-pat-permissions.json +++ b/src/github-apps/data/ghec-2022-11-28/fine-grained-pat-permissions.json @@ -1,4 +1,55 @@ { + "enterprise_custom_properties": { + "title": "Custom properties", + "displayTitle": "Business permissions for \"Custom properties\"", + "permissions": [ + { + "category": "enterprise-admin", + "slug": "get-custom-properties-for-an-enterprise", + "subcategory": "custom-properties", + "verb": "get", + "requestPath": "/enterprises/{enterprise}/properties/schema", + "additional-permissions": false, + "access": "read" + }, + { + "category": "enterprise-admin", + "slug": "create-or-update-custom-properties-for-an-enterprise", + "subcategory": "custom-properties", + "verb": "patch", + "requestPath": "/enterprises/{enterprise}/properties/schema", + "additional-permissions": false, + "access": "write" + }, + { + "category": "enterprise-admin", + "slug": "get-a-custom-property-for-an-enterprise", + "subcategory": "custom-properties", + "verb": "get", + "requestPath": "/enterprises/{enterprise}/properties/schema/{custom_property_name}", + "additional-permissions": false, + "access": "read" + }, + { + "category": "enterprise-admin", + "slug": "create-or-update-a-custom-property-for-an-enterprise", + "subcategory": "custom-properties", + "verb": "put", + "requestPath": "/enterprises/{enterprise}/properties/schema/{custom_property_name}", + "additional-permissions": false, + "access": "write" + }, + { + "category": "enterprise-admin", + "slug": "remove-a-custom-property-for-an-enterprise", + "subcategory": "custom-properties", + "verb": "delete", + "requestPath": "/enterprises/{enterprise}/properties/schema/{custom_property_name}", + "additional-permissions": false, + "access": "write" + } + ] + }, "enterprise_administration": { "title": "Enterprise administration", "displayTitle": "Business permissions for \"Enterprise administration\"", diff --git a/src/github-apps/data/ghec-2022-11-28/fine-grained-pat.json b/src/github-apps/data/ghec-2022-11-28/fine-grained-pat.json index 9ae16c978da5..a5bae1302ea2 100644 --- a/src/github-apps/data/ghec-2022-11-28/fine-grained-pat.json +++ b/src/github-apps/data/ghec-2022-11-28/fine-grained-pat.json @@ -2428,6 +2428,36 @@ "verb": "get", "requestPath": "/enterprises/{enterprise}/license-sync-status" }, + { + "slug": "get-custom-properties-for-an-enterprise", + "subcategory": "custom-properties", + "verb": "get", + "requestPath": "/enterprises/{enterprise}/properties/schema" + }, + { + "slug": "create-or-update-custom-properties-for-an-enterprise", + "subcategory": "custom-properties", + "verb": "patch", + "requestPath": "/enterprises/{enterprise}/properties/schema" + }, + { + "slug": "get-a-custom-property-for-an-enterprise", + "subcategory": "custom-properties", + "verb": "get", + "requestPath": "/enterprises/{enterprise}/properties/schema/{custom_property_name}" + }, + { + "slug": "create-or-update-a-custom-property-for-an-enterprise", + "subcategory": "custom-properties", + "verb": "put", + "requestPath": "/enterprises/{enterprise}/properties/schema/{custom_property_name}" + }, + { + "slug": "remove-a-custom-property-for-an-enterprise", + "subcategory": "custom-properties", + "verb": "delete", + "requestPath": "/enterprises/{enterprise}/properties/schema/{custom_property_name}" + }, { "slug": "get-github-actions-billing-for-an-enterprise", "subcategory": "billing", diff --git a/src/github-apps/data/ghec-2022-11-28/server-to-server-permissions.json b/src/github-apps/data/ghec-2022-11-28/server-to-server-permissions.json index ac506e04ab58..c0ec77055407 100644 --- a/src/github-apps/data/ghec-2022-11-28/server-to-server-permissions.json +++ b/src/github-apps/data/ghec-2022-11-28/server-to-server-permissions.json @@ -1,4 +1,65 @@ { + "enterprise_custom_properties": { + "title": "Custom properties", + "displayTitle": "Business permissions for \"Custom properties\"", + "permissions": [ + { + "category": "enterprise-admin", + "slug": "get-custom-properties-for-an-enterprise", + "subcategory": "custom-properties", + "verb": "get", + "requestPath": "/enterprises/{enterprise}/properties/schema", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "enterprise-admin", + "slug": "create-or-update-custom-properties-for-an-enterprise", + "subcategory": "custom-properties", + "verb": "patch", + "requestPath": "/enterprises/{enterprise}/properties/schema", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "enterprise-admin", + "slug": "get-a-custom-property-for-an-enterprise", + "subcategory": "custom-properties", + "verb": "get", + "requestPath": "/enterprises/{enterprise}/properties/schema/{custom_property_name}", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "enterprise-admin", + "slug": "create-or-update-a-custom-property-for-an-enterprise", + "subcategory": "custom-properties", + "verb": "put", + "requestPath": "/enterprises/{enterprise}/properties/schema/{custom_property_name}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "enterprise-admin", + "slug": "remove-a-custom-property-for-an-enterprise", + "subcategory": "custom-properties", + "verb": "delete", + "requestPath": "/enterprises/{enterprise}/properties/schema/{custom_property_name}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + } + ] + }, "enterprise_administration": { "title": "Enterprise administration", "displayTitle": "Business permissions for \"Enterprise administration\"", diff --git a/src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json b/src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json index f0e98a42fe7a..56810d0c6d36 100644 --- a/src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json +++ b/src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json @@ -2156,6 +2156,36 @@ "verb": "get", "requestPath": "/enterprises/{enterprise}/license-sync-status" }, + { + "slug": "get-custom-properties-for-an-enterprise", + "subcategory": "custom-properties", + "verb": "get", + "requestPath": "/enterprises/{enterprise}/properties/schema" + }, + { + "slug": "create-or-update-custom-properties-for-an-enterprise", + "subcategory": "custom-properties", + "verb": "patch", + "requestPath": "/enterprises/{enterprise}/properties/schema" + }, + { + "slug": "get-a-custom-property-for-an-enterprise", + "subcategory": "custom-properties", + "verb": "get", + "requestPath": "/enterprises/{enterprise}/properties/schema/{custom_property_name}" + }, + { + "slug": "create-or-update-a-custom-property-for-an-enterprise", + "subcategory": "custom-properties", + "verb": "put", + "requestPath": "/enterprises/{enterprise}/properties/schema/{custom_property_name}" + }, + { + "slug": "remove-a-custom-property-for-an-enterprise", + "subcategory": "custom-properties", + "verb": "delete", + "requestPath": "/enterprises/{enterprise}/properties/schema/{custom_property_name}" + }, { "slug": "get-github-actions-billing-for-an-enterprise", "subcategory": "billing", diff --git a/src/github-apps/data/ghec-2022-11-28/user-to-server-rest.json b/src/github-apps/data/ghec-2022-11-28/user-to-server-rest.json index 9ae16c978da5..a5bae1302ea2 100644 --- a/src/github-apps/data/ghec-2022-11-28/user-to-server-rest.json +++ b/src/github-apps/data/ghec-2022-11-28/user-to-server-rest.json @@ -2428,6 +2428,36 @@ "verb": "get", "requestPath": "/enterprises/{enterprise}/license-sync-status" }, + { + "slug": "get-custom-properties-for-an-enterprise", + "subcategory": "custom-properties", + "verb": "get", + "requestPath": "/enterprises/{enterprise}/properties/schema" + }, + { + "slug": "create-or-update-custom-properties-for-an-enterprise", + "subcategory": "custom-properties", + "verb": "patch", + "requestPath": "/enterprises/{enterprise}/properties/schema" + }, + { + "slug": "get-a-custom-property-for-an-enterprise", + "subcategory": "custom-properties", + "verb": "get", + "requestPath": "/enterprises/{enterprise}/properties/schema/{custom_property_name}" + }, + { + "slug": "create-or-update-a-custom-property-for-an-enterprise", + "subcategory": "custom-properties", + "verb": "put", + "requestPath": "/enterprises/{enterprise}/properties/schema/{custom_property_name}" + }, + { + "slug": "remove-a-custom-property-for-an-enterprise", + "subcategory": "custom-properties", + "verb": "delete", + "requestPath": "/enterprises/{enterprise}/properties/schema/{custom_property_name}" + }, { "slug": "get-github-actions-billing-for-an-enterprise", "subcategory": "billing", diff --git a/src/github-apps/lib/config.json b/src/github-apps/lib/config.json index 1b8dd60a9912..f789ea239d77 100644 --- a/src/github-apps/lib/config.json +++ b/src/github-apps/lib/config.json @@ -60,5 +60,5 @@ "2022-11-28" ] }, - "sha": "aa8c601f351897d68d87241f85a53f4a287e3eb3" + "sha": "4ab8513682637010cd3bb5d8ee3227cc5ce739d1" } \ No newline at end of file diff --git a/src/rest/data/fpt-2022-11-28/schema.json b/src/rest/data/fpt-2022-11-28/schema.json index 9dba90fdfd4d..0d8776d16920 100644 --- a/src/rest/data/fpt-2022-11-28/schema.json +++ b/src/rest/data/fpt-2022-11-28/schema.json @@ -158772,6 +158772,22 @@ "not-configured" ] }, + { + "type": "string", + "name": "runner_type", + "in": "body", + "description": "

Runner type to be used.

", + "enum": [ + "standard", + "labeled" + ] + }, + { + "type": "string or null", + "name": "runner_label", + "in": "body", + "description": "

Runner label to be used if the runner type is labeled.

" + }, { "type": "string", "name": "query_suite", @@ -159394,6 +159410,35 @@ "not_set" ] }, + "code_scanning_default_setup_options": { + "type": [ + "object", + "null" + ], + "description": "Feature options for code scanning default setup", + "properties": { + "runner_type": { + "type": [ + "string", + "null" + ], + "enum": [ + "standard", + "labeled", + "not_set", + null + ], + "description": "Whether to use labeled runners or standard GitHub runners." + }, + "runner_label": { + "type": [ + "string", + "null" + ], + "description": "The label of the runner to use for code scanning when runner_type is 'labeled'." + } + } + }, "secret_scanning": { "type": "string", "description": "The enablement status of secret scanning", @@ -159646,6 +159691,29 @@ ], "default": "disabled" }, + { + "type": "object or null", + "name": "code_scanning_default_setup_options", + "in": "body", + "description": "

Feature options for code scanning default setup

", + "childParamsGroups": [ + { + "type": "string", + "name": "runner_type", + "description": "

Whether to use labeled runners or standard GitHub runners.

", + "enum": [ + "standard", + "labeled", + "not_set" + ] + }, + { + "type": "string or null", + "name": "runner_label", + "description": "

The label of the runner to use for code scanning default setup when runner_type is 'labeled'.

" + } + ] + }, { "type": "string", "name": "secret_scanning", @@ -159808,6 +159876,10 @@ "dependabot_alerts": "enabled", "dependabot_security_updates": "not_set", "code_scanning_default_setup": "disabled", + "code_scanning_default_setup_options": { + "runner_type": "not_set", + "runner_label": null + }, "secret_scanning": "enabled", "secret_scanning_push_protection": "disabled", "secret_scanning_delegated_bypass": "disabled", @@ -159908,6 +159980,35 @@ "not_set" ] }, + "code_scanning_default_setup_options": { + "type": [ + "object", + "null" + ], + "description": "Feature options for code scanning default setup", + "properties": { + "runner_type": { + "type": [ + "string", + "null" + ], + "enum": [ + "standard", + "labeled", + "not_set", + null + ], + "description": "Whether to use labeled runners or standard GitHub runners." + }, + "runner_label": { + "type": [ + "string", + "null" + ], + "description": "The label of the runner to use for code scanning when runner_type is 'labeled'." + } + } + }, "secret_scanning": { "type": "string", "description": "The enablement status of secret scanning", @@ -160093,6 +160194,10 @@ "dependabot_alerts": "enabled", "dependabot_security_updates": "not_set", "code_scanning_default_setup": "enabled", + "code_scanning_default_setup_options": { + "runner_type": "not_set", + "runner_label": null + }, "secret_scanning": "enabled", "secret_scanning_push_protection": "enabled", "secret_scanning_delegated_bypass": "enabled", @@ -160131,6 +160236,10 @@ "dependabot_alerts": "enabled", "dependabot_security_updates": "not_set", "code_scanning_default_setup": "enabled", + "code_scanning_default_setup_options": { + "runner_type": "not_set", + "runner_label": null + }, "secret_scanning": "enabled", "secret_scanning_push_protection": "enabled", "secret_scanning_delegated_bypass": "disabled", @@ -160246,6 +160355,35 @@ "not_set" ] }, + "code_scanning_default_setup_options": { + "type": [ + "object", + "null" + ], + "description": "Feature options for code scanning default setup", + "properties": { + "runner_type": { + "type": [ + "string", + "null" + ], + "enum": [ + "standard", + "labeled", + "not_set", + null + ], + "description": "Whether to use labeled runners or standard GitHub runners." + }, + "runner_label": { + "type": [ + "string", + "null" + ], + "description": "The label of the runner to use for code scanning when runner_type is 'labeled'." + } + } + }, "secret_scanning": { "type": "string", "description": "The enablement status of secret scanning", @@ -160537,6 +160675,10 @@ "dependabot_alerts": "enabled", "dependabot_security_updates": "not_set", "code_scanning_default_setup": "disabled", + "code_scanning_default_setup_options": { + "runner_type": "not_set", + "runner_label": null + }, "secret_scanning": "enabled", "secret_scanning_push_protection": "disabled", "secret_scanning_delegated_bypass": "disabled", @@ -160637,6 +160779,35 @@ "not_set" ] }, + "code_scanning_default_setup_options": { + "type": [ + "object", + "null" + ], + "description": "Feature options for code scanning default setup", + "properties": { + "runner_type": { + "type": [ + "string", + "null" + ], + "enum": [ + "standard", + "labeled", + "not_set", + null + ], + "description": "Whether to use labeled runners or standard GitHub runners." + }, + "runner_label": { + "type": [ + "string", + "null" + ], + "description": "The label of the runner to use for code scanning when runner_type is 'labeled'." + } + } + }, "secret_scanning": { "type": "string", "description": "The enablement status of secret scanning", @@ -160892,6 +161063,29 @@ "not_set" ] }, + { + "type": "object or null", + "name": "code_scanning_default_setup_options", + "in": "body", + "description": "

Feature options for code scanning default setup

", + "childParamsGroups": [ + { + "type": "string", + "name": "runner_type", + "description": "

Whether to use labeled runners or standard GitHub runners.

", + "enum": [ + "standard", + "labeled", + "not_set" + ] + }, + { + "type": "string or null", + "name": "runner_label", + "description": "

The label of the runner to use for code scanning default setup when runner_type is 'labeled'.

" + } + ] + }, { "type": "string", "name": "secret_scanning", @@ -161045,6 +161239,10 @@ "dependabot_alerts": "enabled", "dependabot_security_updates": "not_set", "code_scanning_default_setup": "enabled", + "code_scanning_default_setup_options": { + "runner_type": "not_set", + "runner_label": null + }, "secret_scanning": "disabled", "secret_scanning_push_protection": "disabled", "secret_scanning_delegated_bypass": "disabled", @@ -161145,6 +161343,35 @@ "not_set" ] }, + "code_scanning_default_setup_options": { + "type": [ + "object", + "null" + ], + "description": "Feature options for code scanning default setup", + "properties": { + "runner_type": { + "type": [ + "string", + "null" + ], + "enum": [ + "standard", + "labeled", + "not_set", + null + ], + "description": "Whether to use labeled runners or standard GitHub runners." + }, + "runner_label": { + "type": [ + "string", + "null" + ], + "description": "The label of the runner to use for code scanning when runner_type is 'labeled'." + } + } + }, "secret_scanning": { "type": "string", "description": "The enablement status of secret scanning", @@ -161539,6 +161766,10 @@ "dependabot_alerts": "enabled", "dependabot_security_updates": "not_set", "code_scanning_default_setup": "disabled", + "code_scanning_default_setup_options": { + "runner_type": "not_set", + "runner_label": null + }, "secret_scanning": "enabled", "secret_scanning_push_protection": "disabled", "secret_scanning_delegated_bypass": "disabled", @@ -161654,6 +161885,35 @@ "not_set" ] }, + "code_scanning_default_setup_options": { + "type": [ + "object", + "null" + ], + "description": "Feature options for code scanning default setup", + "properties": { + "runner_type": { + "type": [ + "string", + "null" + ], + "enum": [ + "standard", + "labeled", + "not_set", + null + ], + "description": "Whether to use labeled runners or standard GitHub runners." + }, + "runner_label": { + "type": [ + "string", + "null" + ], + "description": "The label of the runner to use for code scanning when runner_type is 'labeled'." + } + } + }, "secret_scanning": { "type": "string", "description": "The enablement status of secret scanning", @@ -162738,6 +162998,35 @@ "not_set" ] }, + "code_scanning_default_setup_options": { + "type": [ + "object", + "null" + ], + "description": "Feature options for code scanning default setup", + "properties": { + "runner_type": { + "type": [ + "string", + "null" + ], + "enum": [ + "standard", + "labeled", + "not_set", + null + ], + "description": "Whether to use labeled runners or standard GitHub runners." + }, + "runner_label": { + "type": [ + "string", + "null" + ], + "description": "The label of the runner to use for code scanning when runner_type is 'labeled'." + } + } + }, "secret_scanning": { "type": "string", "description": "The enablement status of secret scanning", @@ -224354,7 +224643,7 @@ } ], "previews": [], - "descriptionHTML": "

Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.

\n

The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.

\n

Note

\n

\nThis endpoint will only return results for a given day if the enterprise team had five or more members with active Copilot licenses on that day, as evaluated at the end of that day.

\n
\n

To access this endpoint, the Copilot Metrics API access policy must be enabled or set to \"no policy\" for the enterprise within GitHub settings.\nOnly owners and billing managers for the enterprise that contains the enterprise team can view Copilot metrics for the enterprise team.

\n

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or read:enterprise scopes to use this endpoint.

", + "descriptionHTML": "

Note

\n

\nThis endpoint is only applicable to dedicated enterprise accounts for Copilot Business. See \"About enterprise accounts for Copilot Business.\"

\n
\n

Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.

\n

The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.

\n

Note

\n

\nThis endpoint will only return results for a given day if the enterprise team had five or more members with active Copilot licenses on that day, as evaluated at the end of that day.

\n
\n

To access this endpoint, the Copilot Metrics API access policy must be enabled or set to \"no policy\" for the enterprise within GitHub settings.\nOnly owners and billing managers for the enterprise that contains the enterprise team can view Copilot metrics for the enterprise team.

\n

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or read:enterprise scopes to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -226106,7 +226395,7 @@ } ], "previews": [], - "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE\nfor users within an enterprise team, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day.\nSee the response schema tab for detailed metrics definitions.

\n

The response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.

\n

Note

\n

\nThis endpoint will only return results for a given day if the enterprise team had five or more members with active Copilot licenses, as evaluated at the end of that day.

\n
\n

Owners and billing managers for the enterprise that contains the enterprise team can view Copilot usage metrics for the enterprise team.

\n

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or read:enterprise scopes to use this endpoint.

", + "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change. This endpoint is only applicable to dedicated enterprise accounts for Copilot Business. See \"About enterprise accounts for Copilot Business.\"

\n
\n

You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE\nfor users within an enterprise team, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day.\nSee the response schema tab for detailed metrics definitions.

\n

The response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.

\n

Note

\n

\nThis endpoint will only return results for a given day if the enterprise team had five or more members with active Copilot licenses, as evaluated at the end of that day.

\n
\n

Owners and billing managers for the enterprise that contains the enterprise team can view Copilot usage metrics for the enterprise team.

\n

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or read:enterprise scopes to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -227453,7 +227742,8 @@ "updated_at": { "type": "string", "format": "date-time", - "description": "Timestamp of when the assignee's GitHub Copilot access was last updated, in ISO 8601 format." + "deprecated": true, + "description": "**Closing down notice:** This field is no longer relevant and is closing down. Use the `created_at` field to determine when the assignee was last granted access to GitHub Copilot. Timestamp of when the assignee's GitHub Copilot access was last updated, in ISO 8601 format." }, "plan_type": { "type": "string", @@ -228438,7 +228728,8 @@ "updated_at": { "type": "string", "format": "date-time", - "description": "Timestamp of when the assignee's GitHub Copilot access was last updated, in ISO 8601 format." + "deprecated": true, + "description": "**Closing down notice:** This field is no longer relevant and is closing down. Use the `created_at` field to determine when the assignee was last granted access to GitHub Copilot. Timestamp of when the assignee's GitHub Copilot access was last updated, in ISO 8601 format." }, "plan_type": { "type": "string", @@ -228568,7 +228859,7 @@ } ], "previews": [], - "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Purchases a GitHub Copilot seat for all users within each specified team.\nThe organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see \"About billing for GitHub Copilot in your organization.\"

\n

Only organization owners can add Copilot seats for their organization members.

\n

In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"Subscribing to Copilot for your organization.\"\nFor more information about setting a suggestion matching policy, see \"Managing policies for Copilot in your organization.\"

\n

The response will contain the total number of new seats that were created and existing seats that were refreshed.

\n

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or admin:org scopes to use this endpoint.

", + "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Purchases a GitHub Copilot seat for all users within each specified team.\nThe organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see \"About billing for GitHub Copilot in your organization.\"

\n

Only organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"Subscribing to Copilot for your organization.\"\nFor more information about setting a suggestion matching policy, see \"Managing policies for Copilot in your organization.\"

\n

The response contains the total number of new seats that were created and existing seats that were refreshed.

\n

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or admin:org scopes to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "201", @@ -228677,7 +228968,7 @@ } ], "previews": [], - "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Sets seats for all members of each team specified to \"pending cancellation\".\nThis will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through another team.

\n

For more information about Copilot pricing, see \"About billing for GitHub Copilot in your organization.\"

\n

For more information about disabling access to Copilot Business or Enterprise, see \"Revoking access to Copilot for members of your organization.\"

\n

Only organization owners can cancel Copilot seats for their organization members.

\n

The response will contain the total number of seats set to \"pending cancellation\".

\n

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or admin:org scopes to use this endpoint.

", + "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Sets seats for all members of each team specified to \"pending cancellation\".\nThis will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through another team.\nFor more information about disabling access to Copilot, see \"Revoking access to Copilot for members of your organization.\"

\n

Only organization owners can cancel Copilot seats for their organization members.

\n

The response contains the total number of seats set to \"pending cancellation\".

\n

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or admin:org scopes to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -228786,7 +229077,7 @@ } ], "previews": [], - "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Purchases a GitHub Copilot seat for each user specified.\nThe organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see \"About billing for GitHub Copilot in your organization.\"

\n

Only organization owners can add Copilot seats for their organization members.

\n

In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"Subscribing to Copilot for your organization.\"\nFor more information about setting a suggestion matching policy, see \"Managing policies for Copilot in your organization.\"

\n

The response will contain the total number of new seats that were created and existing seats that were refreshed.

\n

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or admin:org scopes to use this endpoint.

", + "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Purchases a GitHub Copilot seat for each user specified.\nThe organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see \"About billing for GitHub Copilot in your organization.\"

\n

Only organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"Subscribing to Copilot for your organization.\"\nFor more information about setting a suggestion matching policy, see \"Managing policies for Copilot in your organization.\"

\n

The response contains the total number of new seats that were created and existing seats that were refreshed.

\n

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or admin:org scopes to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "201", @@ -228895,7 +229186,7 @@ } ], "previews": [], - "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Sets seats for all users specified to \"pending cancellation\".\nThis will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through team membership.

\n

For more information about Copilot pricing, see \"About billing for GitHub Copilot in your organization.\"

\n

For more information about disabling access to Copilot Business or Enterprise, see \"Revoking access to Copilot for members of your organization.\"

\n

Only organization owners can cancel Copilot seats for their organization members.

\n

The response will contain the total number of seats set to \"pending cancellation\".

\n

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or admin:org scopes to use this endpoint.

", + "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Sets seats for all users specified to \"pending cancellation\".\nThis will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through team membership.\nFor more information about disabling access to Copilot, see \"Revoking access to Copilot for members of your organization.\"

\n

Only organization owners can cancel Copilot seats for their organization members.

\n

The response contains the total number of seats set to \"pending cancellation\".

\n

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or admin:org scopes to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -229616,7 +229907,8 @@ "updated_at": { "type": "string", "format": "date-time", - "description": "Timestamp of when the assignee's GitHub Copilot access was last updated, in ISO 8601 format." + "deprecated": true, + "description": "**Closing down notice:** This field is no longer relevant and is closing down. Use the `created_at` field to determine when the assignee was last granted access to GitHub Copilot. Timestamp of when the assignee's GitHub Copilot access was last updated, in ISO 8601 format." }, "plan_type": { "type": "string", @@ -372173,11 +372465,11 @@ "schema": { "type": "string", "enum": [ - "installations", - "classic_pats", - "fine_grained_pats", - "oauth_apps", - "github_apps_user_to_server" + "installation", + "classic_pat", + "fine_grained_pat", + "oauth_app", + "github_app_user_to_server" ] } }, @@ -372260,6 +372552,15 @@ "default": "total_request_count" } } + }, + { + "name": "api_route_substring", + "in": "query", + "description": "

Providing a substring will filter results where the API route contains the substring. This is a case-insensitive search.

", + "required": false, + "schema": { + "type": "string" + } } ], "bodyParameters": [], @@ -372434,6 +372735,15 @@ "default": "total_request_count" } } + }, + { + "name": "subject_name_substring", + "in": "query", + "description": "

Providing a substring will filter results where the subject name contains the substring. This is a case-insensitive search.

", + "required": false, + "schema": { + "type": "string" + } } ], "bodyParameters": [], @@ -372761,11 +373071,11 @@ "schema": { "type": "string", "enum": [ - "installations", - "classic_pats", - "fine_grained_pats", - "oauth_apps", - "github_apps_user_to_server" + "installation", + "classic_pat", + "fine_grained_pat", + "oauth_app", + "github_app_user_to_server" ] } }, @@ -373144,11 +373454,11 @@ "schema": { "type": "string", "enum": [ - "installations", - "classic_pats", - "fine_grained_pats", - "oauth_apps", - "github_apps_user_to_server" + "installation", + "classic_pat", + "fine_grained_pat", + "oauth_app", + "github_app_user_to_server" ] } }, @@ -373376,6 +373686,15 @@ "default": "total_request_count" } } + }, + { + "name": "actor_name_substring", + "in": "query", + "description": "

Providing a substring will filter results where the actor name contains the substring. This is a case-insensitive search.

", + "required": false, + "schema": { + "type": "string" + } } ], "bodyParameters": [], @@ -543387,7 +543706,7 @@ }, "status": { "type": "string", - "description": "The state of the scan. Either \"completed\" or \"running\"" + "description": "The state of the scan. Either \"completed\", \"running\", or \"pending\"" }, "completed_at": { "type": [ @@ -543395,12 +543714,15 @@ "null" ], "format": "date-time", - "description": "The time that the scan was completed. Empty if the scan is active" + "description": "The time that the scan was completed. Empty if the scan is running" }, "started_at": { - "type": "string", + "type": [ + "string", + "null" + ], "format": "date-time", - "description": "The time that the scan was started" + "description": "The time that the scan was started. Empty if the scan is pending" } } } @@ -543417,7 +543739,7 @@ }, "status": { "type": "string", - "description": "The state of the scan. Either \"completed\" or \"running\"" + "description": "The state of the scan. Either \"completed\", \"running\", or \"pending\"" }, "completed_at": { "type": [ @@ -543425,12 +543747,15 @@ "null" ], "format": "date-time", - "description": "The time that the scan was completed. Empty if the scan is active" + "description": "The time that the scan was completed. Empty if the scan is running" }, "started_at": { - "type": "string", + "type": [ + "string", + "null" + ], "format": "date-time", - "description": "The time that the scan was started" + "description": "The time that the scan was started. Empty if the scan is pending" } } } @@ -543447,7 +543772,7 @@ }, "status": { "type": "string", - "description": "The state of the scan. Either \"completed\" or \"running\"" + "description": "The state of the scan. Either \"completed\", \"running\", or \"pending\"" }, "completed_at": { "type": [ @@ -543455,12 +543780,15 @@ "null" ], "format": "date-time", - "description": "The time that the scan was completed. Empty if the scan is active" + "description": "The time that the scan was completed. Empty if the scan is running" }, "started_at": { - "type": "string", + "type": [ + "string", + "null" + ], "format": "date-time", - "description": "The time that the scan was started" + "description": "The time that the scan was started. Empty if the scan is pending" } } } @@ -543479,7 +543807,7 @@ }, "status": { "type": "string", - "description": "The state of the scan. Either \"completed\" or \"running\"" + "description": "The state of the scan. Either \"completed\", \"running\", or \"pending\"" }, "completed_at": { "type": [ @@ -543487,12 +543815,15 @@ "null" ], "format": "date-time", - "description": "The time that the scan was completed. Empty if the scan is active" + "description": "The time that the scan was completed. Empty if the scan is running" }, "started_at": { - "type": "string", + "type": [ + "string", + "null" + ], "format": "date-time", - "description": "The time that the scan was started" + "description": "The time that the scan was started. Empty if the scan is pending" } } }, diff --git a/src/rest/data/ghec-2022-11-28/schema.json b/src/rest/data/ghec-2022-11-28/schema.json index af7300049229..c38ef08b4817 100644 --- a/src/rest/data/ghec-2022-11-28/schema.json +++ b/src/rest/data/ghec-2022-11-28/schema.json @@ -167456,6 +167456,22 @@ "not-configured" ] }, + { + "type": "string", + "name": "runner_type", + "in": "body", + "description": "

Runner type to be used.

", + "enum": [ + "standard", + "labeled" + ] + }, + { + "type": "string or null", + "name": "runner_label", + "in": "body", + "description": "

Runner label to be used if the runner type is labeled.

" + }, { "type": "string", "name": "query_suite", @@ -168078,6 +168094,35 @@ "not_set" ] }, + "code_scanning_default_setup_options": { + "type": [ + "object", + "null" + ], + "description": "Feature options for code scanning default setup", + "properties": { + "runner_type": { + "type": [ + "string", + "null" + ], + "enum": [ + "standard", + "labeled", + "not_set", + null + ], + "description": "Whether to use labeled runners or standard GitHub runners." + }, + "runner_label": { + "type": [ + "string", + "null" + ], + "description": "The label of the runner to use for code scanning when runner_type is 'labeled'." + } + } + }, "secret_scanning": { "type": "string", "description": "The enablement status of secret scanning", @@ -168330,6 +168375,29 @@ ], "default": "disabled" }, + { + "type": "object or null", + "name": "code_scanning_default_setup_options", + "in": "body", + "description": "

Feature options for code scanning default setup

", + "childParamsGroups": [ + { + "type": "string", + "name": "runner_type", + "description": "

Whether to use labeled runners or standard GitHub runners.

", + "enum": [ + "standard", + "labeled", + "not_set" + ] + }, + { + "type": "string or null", + "name": "runner_label", + "description": "

The label of the runner to use for code scanning default setup when runner_type is 'labeled'.

" + } + ] + }, { "type": "string", "name": "secret_scanning", @@ -168492,6 +168560,10 @@ "dependabot_alerts": "enabled", "dependabot_security_updates": "not_set", "code_scanning_default_setup": "disabled", + "code_scanning_default_setup_options": { + "runner_type": "not_set", + "runner_label": null + }, "secret_scanning": "enabled", "secret_scanning_push_protection": "disabled", "secret_scanning_delegated_bypass": "disabled", @@ -168592,6 +168664,35 @@ "not_set" ] }, + "code_scanning_default_setup_options": { + "type": [ + "object", + "null" + ], + "description": "Feature options for code scanning default setup", + "properties": { + "runner_type": { + "type": [ + "string", + "null" + ], + "enum": [ + "standard", + "labeled", + "not_set", + null + ], + "description": "Whether to use labeled runners or standard GitHub runners." + }, + "runner_label": { + "type": [ + "string", + "null" + ], + "description": "The label of the runner to use for code scanning when runner_type is 'labeled'." + } + } + }, "secret_scanning": { "type": "string", "description": "The enablement status of secret scanning", @@ -168777,6 +168878,10 @@ "dependabot_alerts": "enabled", "dependabot_security_updates": "not_set", "code_scanning_default_setup": "enabled", + "code_scanning_default_setup_options": { + "runner_type": "not_set", + "runner_label": null + }, "secret_scanning": "enabled", "secret_scanning_push_protection": "enabled", "secret_scanning_delegated_bypass": "enabled", @@ -168815,6 +168920,10 @@ "dependabot_alerts": "enabled", "dependabot_security_updates": "not_set", "code_scanning_default_setup": "enabled", + "code_scanning_default_setup_options": { + "runner_type": "not_set", + "runner_label": null + }, "secret_scanning": "enabled", "secret_scanning_push_protection": "enabled", "secret_scanning_delegated_bypass": "disabled", @@ -168930,6 +169039,35 @@ "not_set" ] }, + "code_scanning_default_setup_options": { + "type": [ + "object", + "null" + ], + "description": "Feature options for code scanning default setup", + "properties": { + "runner_type": { + "type": [ + "string", + "null" + ], + "enum": [ + "standard", + "labeled", + "not_set", + null + ], + "description": "Whether to use labeled runners or standard GitHub runners." + }, + "runner_label": { + "type": [ + "string", + "null" + ], + "description": "The label of the runner to use for code scanning when runner_type is 'labeled'." + } + } + }, "secret_scanning": { "type": "string", "description": "The enablement status of secret scanning", @@ -169221,6 +169359,10 @@ "dependabot_alerts": "enabled", "dependabot_security_updates": "not_set", "code_scanning_default_setup": "disabled", + "code_scanning_default_setup_options": { + "runner_type": "not_set", + "runner_label": null + }, "secret_scanning": "enabled", "secret_scanning_push_protection": "disabled", "secret_scanning_delegated_bypass": "disabled", @@ -169321,6 +169463,35 @@ "not_set" ] }, + "code_scanning_default_setup_options": { + "type": [ + "object", + "null" + ], + "description": "Feature options for code scanning default setup", + "properties": { + "runner_type": { + "type": [ + "string", + "null" + ], + "enum": [ + "standard", + "labeled", + "not_set", + null + ], + "description": "Whether to use labeled runners or standard GitHub runners." + }, + "runner_label": { + "type": [ + "string", + "null" + ], + "description": "The label of the runner to use for code scanning when runner_type is 'labeled'." + } + } + }, "secret_scanning": { "type": "string", "description": "The enablement status of secret scanning", @@ -169576,6 +169747,29 @@ "not_set" ] }, + { + "type": "object or null", + "name": "code_scanning_default_setup_options", + "in": "body", + "description": "

Feature options for code scanning default setup

", + "childParamsGroups": [ + { + "type": "string", + "name": "runner_type", + "description": "

Whether to use labeled runners or standard GitHub runners.

", + "enum": [ + "standard", + "labeled", + "not_set" + ] + }, + { + "type": "string or null", + "name": "runner_label", + "description": "

The label of the runner to use for code scanning default setup when runner_type is 'labeled'.

" + } + ] + }, { "type": "string", "name": "secret_scanning", @@ -169729,6 +169923,10 @@ "dependabot_alerts": "enabled", "dependabot_security_updates": "not_set", "code_scanning_default_setup": "enabled", + "code_scanning_default_setup_options": { + "runner_type": "not_set", + "runner_label": null + }, "secret_scanning": "disabled", "secret_scanning_push_protection": "disabled", "secret_scanning_delegated_bypass": "disabled", @@ -169829,6 +170027,35 @@ "not_set" ] }, + "code_scanning_default_setup_options": { + "type": [ + "object", + "null" + ], + "description": "Feature options for code scanning default setup", + "properties": { + "runner_type": { + "type": [ + "string", + "null" + ], + "enum": [ + "standard", + "labeled", + "not_set", + null + ], + "description": "Whether to use labeled runners or standard GitHub runners." + }, + "runner_label": { + "type": [ + "string", + "null" + ], + "description": "The label of the runner to use for code scanning when runner_type is 'labeled'." + } + } + }, "secret_scanning": { "type": "string", "description": "The enablement status of secret scanning", @@ -170223,6 +170450,10 @@ "dependabot_alerts": "enabled", "dependabot_security_updates": "not_set", "code_scanning_default_setup": "disabled", + "code_scanning_default_setup_options": { + "runner_type": "not_set", + "runner_label": null + }, "secret_scanning": "enabled", "secret_scanning_push_protection": "disabled", "secret_scanning_delegated_bypass": "disabled", @@ -170338,6 +170569,35 @@ "not_set" ] }, + "code_scanning_default_setup_options": { + "type": [ + "object", + "null" + ], + "description": "Feature options for code scanning default setup", + "properties": { + "runner_type": { + "type": [ + "string", + "null" + ], + "enum": [ + "standard", + "labeled", + "not_set", + null + ], + "description": "Whether to use labeled runners or standard GitHub runners." + }, + "runner_label": { + "type": [ + "string", + "null" + ], + "description": "The label of the runner to use for code scanning when runner_type is 'labeled'." + } + } + }, "secret_scanning": { "type": "string", "description": "The enablement status of secret scanning", @@ -171422,6 +171682,35 @@ "not_set" ] }, + "code_scanning_default_setup_options": { + "type": [ + "object", + "null" + ], + "description": "Feature options for code scanning default setup", + "properties": { + "runner_type": { + "type": [ + "string", + "null" + ], + "enum": [ + "standard", + "labeled", + "not_set", + null + ], + "description": "Whether to use labeled runners or standard GitHub runners." + }, + "runner_label": { + "type": [ + "string", + "null" + ], + "description": "The label of the runner to use for code scanning when runner_type is 'labeled'." + } + } + }, "secret_scanning": { "type": "string", "description": "The enablement status of secret scanning", @@ -233314,7 +233603,7 @@ } ], "previews": [], - "descriptionHTML": "

Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.

\n

The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.

\n

Note

\n

\nThis endpoint will only return results for a given day if the enterprise team had five or more members with active Copilot licenses on that day, as evaluated at the end of that day.

\n
\n

To access this endpoint, the Copilot Metrics API access policy must be enabled or set to \"no policy\" for the enterprise within GitHub settings.\nOnly owners and billing managers for the enterprise that contains the enterprise team can view Copilot metrics for the enterprise team.

\n

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or read:enterprise scopes to use this endpoint.

", + "descriptionHTML": "

Note

\n

\nThis endpoint is only applicable to dedicated enterprise accounts for Copilot Business. See \"About enterprise accounts for Copilot Business.\"

\n
\n

Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.

\n

The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.

\n

Note

\n

\nThis endpoint will only return results for a given day if the enterprise team had five or more members with active Copilot licenses on that day, as evaluated at the end of that day.

\n
\n

To access this endpoint, the Copilot Metrics API access policy must be enabled or set to \"no policy\" for the enterprise within GitHub settings.\nOnly owners and billing managers for the enterprise that contains the enterprise team can view Copilot metrics for the enterprise team.

\n

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or read:enterprise scopes to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -235066,7 +235355,7 @@ } ], "previews": [], - "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE\nfor users within an enterprise team, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day.\nSee the response schema tab for detailed metrics definitions.

\n

The response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.

\n

Note

\n

\nThis endpoint will only return results for a given day if the enterprise team had five or more members with active Copilot licenses, as evaluated at the end of that day.

\n
\n

Owners and billing managers for the enterprise that contains the enterprise team can view Copilot usage metrics for the enterprise team.

\n

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or read:enterprise scopes to use this endpoint.

", + "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change. This endpoint is only applicable to dedicated enterprise accounts for Copilot Business. See \"About enterprise accounts for Copilot Business.\"

\n
\n

You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE\nfor users within an enterprise team, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day.\nSee the response schema tab for detailed metrics definitions.

\n

The response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.

\n

Note

\n

\nThis endpoint will only return results for a given day if the enterprise team had five or more members with active Copilot licenses, as evaluated at the end of that day.

\n
\n

Owners and billing managers for the enterprise that contains the enterprise team can view Copilot usage metrics for the enterprise team.

\n

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or read:enterprise scopes to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -236413,7 +236702,8 @@ "updated_at": { "type": "string", "format": "date-time", - "description": "Timestamp of when the assignee's GitHub Copilot access was last updated, in ISO 8601 format." + "deprecated": true, + "description": "**Closing down notice:** This field is no longer relevant and is closing down. Use the `created_at` field to determine when the assignee was last granted access to GitHub Copilot. Timestamp of when the assignee's GitHub Copilot access was last updated, in ISO 8601 format." }, "plan_type": { "type": "string", @@ -237398,7 +237688,8 @@ "updated_at": { "type": "string", "format": "date-time", - "description": "Timestamp of when the assignee's GitHub Copilot access was last updated, in ISO 8601 format." + "deprecated": true, + "description": "**Closing down notice:** This field is no longer relevant and is closing down. Use the `created_at` field to determine when the assignee was last granted access to GitHub Copilot. Timestamp of when the assignee's GitHub Copilot access was last updated, in ISO 8601 format." }, "plan_type": { "type": "string", @@ -237528,7 +237819,7 @@ } ], "previews": [], - "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Purchases a GitHub Copilot seat for all users within each specified team.\nThe organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see \"About billing for GitHub Copilot in your organization.\"

\n

Only organization owners can add Copilot seats for their organization members.

\n

In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"Subscribing to Copilot for your organization.\"\nFor more information about setting a suggestion matching policy, see \"Managing policies for Copilot in your organization.\"

\n

The response will contain the total number of new seats that were created and existing seats that were refreshed.

\n

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or admin:org scopes to use this endpoint.

", + "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Purchases a GitHub Copilot seat for all users within each specified team.\nThe organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see \"About billing for GitHub Copilot in your organization.\"

\n

Only organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"Subscribing to Copilot for your organization.\"\nFor more information about setting a suggestion matching policy, see \"Managing policies for Copilot in your organization.\"

\n

The response contains the total number of new seats that were created and existing seats that were refreshed.

\n

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or admin:org scopes to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "201", @@ -237637,7 +237928,7 @@ } ], "previews": [], - "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Sets seats for all members of each team specified to \"pending cancellation\".\nThis will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through another team.

\n

For more information about Copilot pricing, see \"About billing for GitHub Copilot in your organization.\"

\n

For more information about disabling access to Copilot Business or Enterprise, see \"Revoking access to Copilot for members of your organization.\"

\n

Only organization owners can cancel Copilot seats for their organization members.

\n

The response will contain the total number of seats set to \"pending cancellation\".

\n

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or admin:org scopes to use this endpoint.

", + "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Sets seats for all members of each team specified to \"pending cancellation\".\nThis will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through another team.\nFor more information about disabling access to Copilot, see \"Revoking access to Copilot for members of your organization.\"

\n

Only organization owners can cancel Copilot seats for their organization members.

\n

The response contains the total number of seats set to \"pending cancellation\".

\n

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or admin:org scopes to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -237746,7 +238037,7 @@ } ], "previews": [], - "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Purchases a GitHub Copilot seat for each user specified.\nThe organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see \"About billing for GitHub Copilot in your organization.\"

\n

Only organization owners can add Copilot seats for their organization members.

\n

In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"Subscribing to Copilot for your organization.\"\nFor more information about setting a suggestion matching policy, see \"Managing policies for Copilot in your organization.\"

\n

The response will contain the total number of new seats that were created and existing seats that were refreshed.

\n

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or admin:org scopes to use this endpoint.

", + "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Purchases a GitHub Copilot seat for each user specified.\nThe organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see \"About billing for GitHub Copilot in your organization.\"

\n

Only organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"Subscribing to Copilot for your organization.\"\nFor more information about setting a suggestion matching policy, see \"Managing policies for Copilot in your organization.\"

\n

The response contains the total number of new seats that were created and existing seats that were refreshed.

\n

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or admin:org scopes to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "201", @@ -237855,7 +238146,7 @@ } ], "previews": [], - "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Sets seats for all users specified to \"pending cancellation\".\nThis will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through team membership.

\n

For more information about Copilot pricing, see \"About billing for GitHub Copilot in your organization.\"

\n

For more information about disabling access to Copilot Business or Enterprise, see \"Revoking access to Copilot for members of your organization.\"

\n

Only organization owners can cancel Copilot seats for their organization members.

\n

The response will contain the total number of seats set to \"pending cancellation\".

\n

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or admin:org scopes to use this endpoint.

", + "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Sets seats for all users specified to \"pending cancellation\".\nThis will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through team membership.\nFor more information about disabling access to Copilot, see \"Revoking access to Copilot for members of your organization.\"

\n

Only organization owners can cancel Copilot seats for their organization members.

\n

The response contains the total number of seats set to \"pending cancellation\".

\n

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or admin:org scopes to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -238576,7 +238867,8 @@ "updated_at": { "type": "string", "format": "date-time", - "description": "Timestamp of when the assignee's GitHub Copilot access was last updated, in ISO 8601 format." + "deprecated": true, + "description": "**Closing down notice:** This field is no longer relevant and is closing down. Use the `created_at` field to determine when the assignee was last granted access to GitHub Copilot. Timestamp of when the assignee's GitHub Copilot access was last updated, in ISO 8601 format." }, "plan_type": { "type": "string", @@ -263621,6 +263913,944 @@ ] } ], + "custom-properties": [ + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/enterprises/{enterprise}/properties/schema", + "title": "Get custom properties for an enterprise", + "category": "enterprise-admin", + "subcategory": "custom-properties", + "parameters": [ + { + "name": "enterprise", + "description": "

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Custom properties\" business permissions": "read" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "enterprise": "ENTERPRISE" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": [ + { + "property_name": "environment", + "url": "https://api.github.com/orgs/github/properties/schema/environment", + "source_type": "organization", + "value_type": "single_select", + "required": true, + "default_value": "production", + "description": "Prod or dev environment", + "allowed_values": [ + "production", + "development" + ], + "values_editable_by": "org_actors" + }, + { + "property_name": "service", + "url": "https://api.github.com/orgs/github/properties/schema/service", + "source_type": "organization", + "value_type": "string" + }, + { + "property_name": "team", + "url": "https://api.github.com/orgs/github/properties/schema/team", + "source_type": "organization", + "value_type": "string", + "description": "Team owning the repository" + } + ], + "schema": { + "type": "array", + "items": { + "title": "Organization Custom Property", + "description": "Custom property defined on an organization", + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL that can be used to fetch, update, or delete info about this property via the API." + }, + "source_type": { + "type": "string", + "description": "The source type of the property", + "enum": [ + "organization", + "enterprise" + ], + "examples": [ + "organization" + ] + }, + "value_type": { + "type": "string", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ], + "description": "The type of the value for the property", + "examples": [ + "single_select" + ] + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "description": "Default value of the property", + "type": [ + "null", + "string", + "array" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "Short description of the property" + }, + "allowed_values": { + "type": [ + "array", + "null" + ], + "items": { + "type": "string", + "maxLength": 75 + }, + "maxItems": 200, + "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." + }, + "values_editable_by": { + "type": [ + "string", + "null" + ], + "enum": [ + "org_actors", + "org_and_repo_actors", + null + ], + "description": "Who can edit the values of the property", + "examples": [ + "org_actors" + ] + } + }, + "required": [ + "property_name", + "value_type" + ] + } + } + } + } + ], + "previews": [], + "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Gets all custom properties defined for an enterprise.\nEnterprise members can read these properties.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "patch", + "requestPath": "/enterprises/{enterprise}/properties/schema", + "title": "Create or update custom properties for an enterprise", + "category": "enterprise-admin", + "subcategory": "custom-properties", + "parameters": [ + { + "name": "enterprise", + "description": "

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "array of objects", + "name": "properties", + "in": "body", + "description": "

The array of custom properties to create or update.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "property_name", + "description": "

The name of the property

", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "

The URL that can be used to fetch, update, or delete info about this property via the API.

" + }, + { + "type": "string", + "name": "source_type", + "description": "

The source type of the property

", + "enum": [ + "organization", + "enterprise" + ] + }, + { + "type": "string", + "name": "value_type", + "description": "

The type of the value for the property

", + "isRequired": true, + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ] + }, + { + "type": "boolean", + "name": "required", + "description": "

Whether the property is required.

" + }, + { + "type": "null or string or array", + "name": "default_value", + "description": "

Default value of the property

" + }, + { + "type": "string or null", + "name": "description", + "description": "

Short description of the property

" + }, + { + "type": "array of strings or null", + "name": "allowed_values", + "description": "

An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values.

" + }, + { + "type": "string or null", + "name": "values_editable_by", + "description": "

Who can edit the values of the property

", + "enum": [ + "org_actors", + "org_and_repo_actors", + null + ] + } + ] + } + ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Custom properties\" business permissions": "write" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "properties": [ + { + "property_name": "environment", + "value_type": "single_select", + "required": true, + "default_value": "production", + "description": "Prod or dev environment", + "allowed_values": [ + "production", + "development" + ], + "values_editable_by": "org_actors" + }, + { + "property_name": "service", + "value_type": "string" + }, + { + "property_name": "team", + "value_type": "string", + "description": "Team owning the repository" + } + ] + }, + "parameters": { + "enterprise": "ENTERPRISE" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": [ + { + "property_name": "environment", + "url": "https://api.github.com/orgs/github/properties/schema/environment", + "source_type": "organization", + "value_type": "single_select", + "required": true, + "default_value": "production", + "description": "Prod or dev environment", + "allowed_values": [ + "production", + "development" + ], + "values_editable_by": "org_actors" + }, + { + "property_name": "service", + "url": "https://api.github.com/orgs/github/properties/schema/service", + "source_type": "organization", + "value_type": "string" + }, + { + "property_name": "team", + "url": "https://api.github.com/orgs/github/properties/schema/team", + "source_type": "organization", + "value_type": "string", + "description": "Team owning the repository" + } + ], + "schema": { + "type": "array", + "items": { + "title": "Organization Custom Property", + "description": "Custom property defined on an organization", + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL that can be used to fetch, update, or delete info about this property via the API." + }, + "source_type": { + "type": "string", + "description": "The source type of the property", + "enum": [ + "organization", + "enterprise" + ], + "examples": [ + "organization" + ] + }, + "value_type": { + "type": "string", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ], + "description": "The type of the value for the property", + "examples": [ + "single_select" + ] + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "description": "Default value of the property", + "type": [ + "null", + "string", + "array" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "Short description of the property" + }, + "allowed_values": { + "type": [ + "array", + "null" + ], + "items": { + "type": "string", + "maxLength": 75 + }, + "maxItems": 200, + "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." + }, + "values_editable_by": { + "type": [ + "string", + "null" + ], + "enum": [ + "org_actors", + "org_and_repo_actors", + null + ], + "description": "Who can edit the values of the property", + "examples": [ + "org_actors" + ] + } + }, + "required": [ + "property_name", + "value_type" + ] + } + } + } + } + ], + "previews": [], + "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Creates new or updates existing custom properties defined for an enterprise in a batch.

\n

To use this endpoint, the authenticated user must be an administrator for the enterprise.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/enterprises/{enterprise}/properties/schema/{custom_property_name}", + "title": "Get a custom property for an enterprise", + "category": "enterprise-admin", + "subcategory": "custom-properties", + "parameters": [ + { + "name": "enterprise", + "description": "

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "custom_property_name", + "description": "

The custom property name

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Custom properties\" business permissions": "read" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "enterprise": "ENTERPRISE", + "custom_property_name": "CUSTOM_PROPERTY_NAME" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "property_name": "environment", + "url": "https://api.github.com/orgs/github/properties/schema/environment", + "source_type": "organization", + "value_type": "single_select", + "required": true, + "default_value": "production", + "description": "Prod or dev environment", + "allowed_values": [ + "production", + "development" + ] + }, + "schema": { + "title": "Organization Custom Property", + "description": "Custom property defined on an organization", + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL that can be used to fetch, update, or delete info about this property via the API." + }, + "source_type": { + "type": "string", + "description": "The source type of the property", + "enum": [ + "organization", + "enterprise" + ], + "examples": [ + "organization" + ] + }, + "value_type": { + "type": "string", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ], + "description": "The type of the value for the property", + "examples": [ + "single_select" + ] + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "description": "Default value of the property", + "type": [ + "null", + "string", + "array" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "Short description of the property" + }, + "allowed_values": { + "type": [ + "array", + "null" + ], + "items": { + "type": "string", + "maxLength": 75 + }, + "maxItems": 200, + "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." + }, + "values_editable_by": { + "type": [ + "string", + "null" + ], + "enum": [ + "org_actors", + "org_and_repo_actors", + null + ], + "description": "Who can edit the values of the property", + "examples": [ + "org_actors" + ] + } + }, + "required": [ + "property_name", + "value_type" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Gets a custom property that is defined for an enterprise.\nEnterprise members can read these properties.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "put", + "requestPath": "/enterprises/{enterprise}/properties/schema/{custom_property_name}", + "title": "Create or update a custom property for an enterprise", + "category": "enterprise-admin", + "subcategory": "custom-properties", + "parameters": [ + { + "name": "enterprise", + "description": "

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "custom_property_name", + "description": "

The custom property name

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Custom properties\" business permissions": "write" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "enterprise": "ENTERPRISE", + "custom_property_name": "CUSTOM_PROPERTY_NAME" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "property_name": "environment", + "url": "https://api.github.com/orgs/github/properties/schema/environment", + "source_type": "organization", + "value_type": "single_select", + "required": true, + "default_value": "production", + "description": "Prod or dev environment", + "allowed_values": [ + "production", + "development" + ] + }, + "schema": { + "title": "Organization Custom Property", + "description": "Custom property defined on an organization", + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL that can be used to fetch, update, or delete info about this property via the API." + }, + "source_type": { + "type": "string", + "description": "The source type of the property", + "enum": [ + "organization", + "enterprise" + ], + "examples": [ + "organization" + ] + }, + "value_type": { + "type": "string", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ], + "description": "The type of the value for the property", + "examples": [ + "single_select" + ] + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "description": "Default value of the property", + "type": [ + "null", + "string", + "array" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "Short description of the property" + }, + "allowed_values": { + "type": [ + "array", + "null" + ], + "items": { + "type": "string", + "maxLength": 75 + }, + "maxItems": 200, + "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." + }, + "values_editable_by": { + "type": [ + "string", + "null" + ], + "enum": [ + "org_actors", + "org_and_repo_actors", + null + ], + "description": "Who can edit the values of the property", + "examples": [ + "org_actors" + ] + } + }, + "required": [ + "property_name", + "value_type" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Creates a new or updates an existing custom property that is defined for an enterprise.

\n

To use this endpoint, the authenticated user must be an administrator for the enterprise.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "delete", + "requestPath": "/enterprises/{enterprise}/properties/schema/{custom_property_name}", + "title": "Remove a custom property for an enterprise", + "category": "enterprise-admin", + "subcategory": "custom-properties", + "parameters": [ + { + "name": "enterprise", + "description": "

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "custom_property_name", + "description": "

The custom property name

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Custom properties\" business permissions": "write" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "enterprise": "ENTERPRISE", + "custom_property_name": "CUSTOM_PROPERTY_NAME" + } + }, + "response": { + "statusCode": "204", + "description": "

A header with no content is returned.

" + } + } + ], + "previews": [], + "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Remove a custom property that is defined for an enterprise.

\n

To use this endpoint, the authenticated user must be an administrator for the enterprise.

", + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "

A header with no content is returned.

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ] + } + ], "license": [ { "serverUrl": "https://api.github.com", @@ -391047,11 +392277,11 @@ "schema": { "type": "string", "enum": [ - "installations", - "classic_pats", - "fine_grained_pats", - "oauth_apps", - "github_apps_user_to_server" + "installation", + "classic_pat", + "fine_grained_pat", + "oauth_app", + "github_app_user_to_server" ] } }, @@ -391134,6 +392364,15 @@ "default": "total_request_count" } } + }, + { + "name": "api_route_substring", + "in": "query", + "description": "

Providing a substring will filter results where the API route contains the substring. This is a case-insensitive search.

", + "required": false, + "schema": { + "type": "string" + } } ], "bodyParameters": [], @@ -391308,6 +392547,15 @@ "default": "total_request_count" } } + }, + { + "name": "subject_name_substring", + "in": "query", + "description": "

Providing a substring will filter results where the subject name contains the substring. This is a case-insensitive search.

", + "required": false, + "schema": { + "type": "string" + } } ], "bodyParameters": [], @@ -391635,11 +392883,11 @@ "schema": { "type": "string", "enum": [ - "installations", - "classic_pats", - "fine_grained_pats", - "oauth_apps", - "github_apps_user_to_server" + "installation", + "classic_pat", + "fine_grained_pat", + "oauth_app", + "github_app_user_to_server" ] } }, @@ -392018,11 +393266,11 @@ "schema": { "type": "string", "enum": [ - "installations", - "classic_pats", - "fine_grained_pats", - "oauth_apps", - "github_apps_user_to_server" + "installation", + "classic_pat", + "fine_grained_pat", + "oauth_app", + "github_app_user_to_server" ] } }, @@ -392250,6 +393498,15 @@ "default": "total_request_count" } } + }, + { + "name": "actor_name_substring", + "in": "query", + "description": "

Providing a substring will filter results where the actor name contains the substring. This is a case-insensitive search.

", + "required": false, + "schema": { + "type": "string" + } } ], "bodyParameters": [], @@ -569278,7 +570535,7 @@ }, "status": { "type": "string", - "description": "The state of the scan. Either \"completed\" or \"running\"" + "description": "The state of the scan. Either \"completed\", \"running\", or \"pending\"" }, "completed_at": { "type": [ @@ -569286,12 +570543,15 @@ "null" ], "format": "date-time", - "description": "The time that the scan was completed. Empty if the scan is active" + "description": "The time that the scan was completed. Empty if the scan is running" }, "started_at": { - "type": "string", + "type": [ + "string", + "null" + ], "format": "date-time", - "description": "The time that the scan was started" + "description": "The time that the scan was started. Empty if the scan is pending" } } } @@ -569308,7 +570568,7 @@ }, "status": { "type": "string", - "description": "The state of the scan. Either \"completed\" or \"running\"" + "description": "The state of the scan. Either \"completed\", \"running\", or \"pending\"" }, "completed_at": { "type": [ @@ -569316,12 +570576,15 @@ "null" ], "format": "date-time", - "description": "The time that the scan was completed. Empty if the scan is active" + "description": "The time that the scan was completed. Empty if the scan is running" }, "started_at": { - "type": "string", + "type": [ + "string", + "null" + ], "format": "date-time", - "description": "The time that the scan was started" + "description": "The time that the scan was started. Empty if the scan is pending" } } } @@ -569338,7 +570601,7 @@ }, "status": { "type": "string", - "description": "The state of the scan. Either \"completed\" or \"running\"" + "description": "The state of the scan. Either \"completed\", \"running\", or \"pending\"" }, "completed_at": { "type": [ @@ -569346,12 +570609,15 @@ "null" ], "format": "date-time", - "description": "The time that the scan was completed. Empty if the scan is active" + "description": "The time that the scan was completed. Empty if the scan is running" }, "started_at": { - "type": "string", + "type": [ + "string", + "null" + ], "format": "date-time", - "description": "The time that the scan was started" + "description": "The time that the scan was started. Empty if the scan is pending" } } } @@ -569370,7 +570636,7 @@ }, "status": { "type": "string", - "description": "The state of the scan. Either \"completed\" or \"running\"" + "description": "The state of the scan. Either \"completed\", \"running\", or \"pending\"" }, "completed_at": { "type": [ @@ -569378,12 +570644,15 @@ "null" ], "format": "date-time", - "description": "The time that the scan was completed. Empty if the scan is active" + "description": "The time that the scan was completed. Empty if the scan is running" }, "started_at": { - "type": "string", + "type": [ + "string", + "null" + ], "format": "date-time", - "description": "The time that the scan was started" + "description": "The time that the scan was started. Empty if the scan is pending" } } }, diff --git a/src/rest/data/ghes-3.15-2022-11-28/schema.json b/src/rest/data/ghes-3.15-2022-11-28/schema.json index f352b4f3e672..9b16b6d2fdaf 100644 --- a/src/rest/data/ghes-3.15-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.15-2022-11-28/schema.json @@ -154456,10 +154456,6 @@ "description": "Suggested settings for Dependabot, secret scanning, and code scanning.", "advanced_security": "enabled", "dependency_graph": "enabled", - "dependency_graph_autosubmit_action": "not_set", - "dependency_graph_autosubmit_action_options": { - "labeled_runners": false - }, "dependabot_alerts": "enabled", "dependabot_security_updates": "not_set", "code_scanning_default_setup": "enabled", @@ -154476,8 +154472,6 @@ ] }, "secret_scanning_validity_checks": "enabled", - "secret_scanning_non_provider_patterns": "enabled", - "private_vulnerability_reporting": "enabled", "enforcement": "enforced", "url": "https://api.github.com/orgs/octo-org/code-security/configurations/17", "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/view", @@ -154491,10 +154485,6 @@ "description": "This is a code security configuration for octo-org high risk repositories", "advanced_security": "enabled", "dependency_graph": "enabled", - "dependency_graph_autosubmit_action": "enabled", - "dependency_graph_autosubmit_action_options": { - "labeled_runners": false - }, "dependabot_alerts": "enabled", "dependabot_security_updates": "enabled", "code_scanning_default_setup": "enabled", @@ -154502,68 +154492,11 @@ "secret_scanning_push_protection": "enabled", "secret_scanning_delegated_bypass": "disabled", "secret_scanning_validity_checks": "disabled", - "secret_scanning_non_provider_patterns": "disabled", - "private_vulnerability_reporting": "enabled", "enforcement": "enforced", "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1326", "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1326", "created_at": "2024-05-10T00:00:00Z", - "updated_at": "2024-05-10T00:00:00Z", - "value": [ - { - "id": 17, - "target_type": "global", - "name": "GitHub recommended", - "description": "Suggested settings for Dependabot, secret scanning, and code scanning.", - "advanced_security": "enabled", - "dependency_graph": "enabled", - "dependency_graph_autosubmit_action": null, - "dependency_graph_autosubmit_action_options": null, - "dependabot_alerts": "enabled", - "dependabot_security_updates": "not_set", - "code_scanning_default_setup": "enabled", - "secret_scanning": "enabled", - "secret_scanning_push_protection": "enabled", - "secret_scanning_delegated_bypass": "enabled", - "secret_scanning_delegated_bypass_options": { - "reviewers": [ - { - "security_configuration_id": 17, - "reviewer_id": 5678, - "reviewer_type": "TEAM" - } - ] - }, - "secret_scanning_validity_checks": "enabled", - "enforcement": "enforced", - "url": "https://api.github.com/orgs/octo-org/code-security/configurations/17", - "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/view", - "created_at": "2023-12-04T15:58:07Z", - "updated_at": "2023-12-04T15:58:07Z" - }, - { - "id": 1326, - "target_type": "organization", - "name": "High risk settings", - "description": "This is a code security configuration for octo-org high risk repositories", - "advanced_security": "enabled", - "dependency_graph": "enabled", - "dependency_graph_autosubmit_action": null, - "dependency_graph_autosubmit_action_options": null, - "dependabot_alerts": "enabled", - "dependabot_security_updates": "enabled", - "code_scanning_default_setup": "enabled", - "secret_scanning": "enabled", - "secret_scanning_push_protection": "enabled", - "secret_scanning_delegated_bypass": "disabled", - "secret_scanning_validity_checks": "disabled", - "enforcement": "enforced", - "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1326", - "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1326", - "created_at": "2024-05-10T00:00:00Z", - "updated_at": "2024-05-10T00:00:00Z" - } - ] + "updated_at": "2024-05-10T00:00:00Z" } ], "schema": { @@ -155009,10 +154942,6 @@ "description": "This is a code security configuration for octo-org", "advanced_security": "enabled", "dependency_graph": "enabled", - "dependency_graph_autosubmit_action": "enabled", - "dependency_graph_autosubmit_action_options": { - "labeled_runners": false - }, "dependabot_alerts": "enabled", "dependabot_security_updates": "not_set", "code_scanning_default_setup": "disabled", @@ -155021,13 +154950,11 @@ "secret_scanning_delegated_bypass": "disabled", "secret_scanning_validity_checks": "disabled", "secret_scanning_non_provider_patterns": "disabled", - "private_vulnerability_reporting": "disabled", "enforcement": "enforced", "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325", "created_at": "2024-05-01T00:00:00Z", - "updated_at": "2024-05-01T00:00:00Z", - "value": {} + "updated_at": "2024-05-01T00:00:00Z" }, "schema": { "type": "object", @@ -155267,8 +155194,6 @@ "description": "This is a code security configuration for octo-org", "advanced_security": "enabled", "dependency_graph": "enabled", - "dependency_graph_autosubmit_action": null, - "dependency_graph_autosubmit_action_options": null, "dependabot_alerts": "enabled", "dependabot_security_updates": "not_set", "code_scanning_default_setup": "enabled", @@ -155301,8 +155226,6 @@ "description": "Suggested settings for Dependabot, secret scanning, and code scanning.", "advanced_security": "enabled", "dependency_graph": "enabled", - "dependency_graph_autosubmit_action": null, - "dependency_graph_autosubmit_action_options": null, "dependabot_alerts": "enabled", "dependabot_security_updates": "not_set", "code_scanning_default_setup": "enabled", @@ -155676,10 +155599,6 @@ "description": "This is a code security configuration for octo-org", "advanced_security": "enabled", "dependency_graph": "enabled", - "dependency_graph_autosubmit_action": "enabled", - "dependency_graph_autosubmit_action_options": { - "labeled_runners": false - }, "dependabot_alerts": "enabled", "dependabot_security_updates": "not_set", "code_scanning_default_setup": "disabled", @@ -155688,13 +155607,11 @@ "secret_scanning_delegated_bypass": "disabled", "secret_scanning_validity_checks": "disabled", "secret_scanning_non_provider_patterns": "disabled", - "private_vulnerability_reporting": "disabled", "enforcement": "enforced", "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325", "created_at": "2024-05-01T00:00:00Z", - "updated_at": "2024-05-01T00:00:00Z", - "value": {} + "updated_at": "2024-05-01T00:00:00Z" }, "schema": { "type": "object", @@ -156594,10 +156511,6 @@ "description": "This is a code security configuration for octo-org", "advanced_security": "enabled", "dependency_graph": "enabled", - "dependency_graph_autosubmit_action": "enabled", - "dependency_graph_autosubmit_action_options": { - "labeled_runners": false - }, "dependabot_alerts": "enabled", "dependabot_security_updates": "not_set", "code_scanning_default_setup": "disabled", @@ -156606,13 +156519,11 @@ "secret_scanning_delegated_bypass": "disabled", "secret_scanning_validity_checks": "disabled", "secret_scanning_non_provider_patterns": "disabled", - "private_vulnerability_reporting": "disabled", "enforcement": "enforced", "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325", "created_at": "2024-05-01T00:00:00Z", - "updated_at": "2024-05-01T00:00:00Z", - "value": {} + "updated_at": "2024-05-01T00:00:00Z" } } }, @@ -157647,10 +157558,6 @@ "description": "This is a code security configuration for octo-org", "advanced_security": "enabled", "dependency_graph": "enabled", - "dependency_graph_autosubmit_action": "enabled", - "dependency_graph_autosubmit_action_options": { - "labeled_runners": false - }, "dependabot_alerts": "enabled", "dependabot_security_updates": "not_set", "code_scanning_default_setup": "disabled", @@ -157659,19 +157566,11 @@ "secret_scanning_delegated_bypass": "disabled", "secret_scanning_validity_checks": "disabled", "secret_scanning_non_provider_patterns": "disabled", - "private_vulnerability_reporting": "disabled", "enforcement": "enforced", "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325", "created_at": "2024-05-01T00:00:00Z", "updated_at": "2024-05-01T00:00:00Z" - }, - "value": { - "configuration": { - "dependency_graph_autosubmit_action": null, - "dependency_graph_autosubmit_action_options": null, - "private_vulnerability_reporting": null - } } }, "schema": { diff --git a/src/rest/lib/config.json b/src/rest/lib/config.json index 953012cea293..99b22d914a60 100644 --- a/src/rest/lib/config.json +++ b/src/rest/lib/config.json @@ -50,5 +50,5 @@ ] } }, - "sha": "aa8c601f351897d68d87241f85a53f4a287e3eb3" + "sha": "4ab8513682637010cd3bb5d8ee3227cc5ce739d1" } \ No newline at end of file diff --git a/src/webhooks/lib/config.json b/src/webhooks/lib/config.json index 18425fb36e58..f9331d8032b2 100644 --- a/src/webhooks/lib/config.json +++ b/src/webhooks/lib/config.json @@ -1,3 +1,3 @@ { - "sha": "aa8c601f351897d68d87241f85a53f4a287e3eb3" + "sha": "4ab8513682637010cd3bb5d8ee3227cc5ce739d1" } \ No newline at end of file