diff --git a/assets/images/help/enterprises/edit-agent-profile-ruleset.png b/assets/images/help/enterprises/edit-agent-profile-ruleset.png new file mode 100644 index 000000000000..36094768aa3a Binary files /dev/null and b/assets/images/help/enterprises/edit-agent-profile-ruleset.png differ diff --git a/content/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-agents/prepare-for-custom-agents.md b/content/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-agents/prepare-for-custom-agents.md index e0a58727ab48..03df4ed28a7c 100644 --- a/content/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-agents/prepare-for-custom-agents.md +++ b/content/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-agents/prepare-for-custom-agents.md @@ -33,4 +33,6 @@ Enterprise-level {% data variables.copilot.custom_agents_short %} are defined in ## Next steps -To implement {% data variables.copilot.custom_agents_short %} in your enterprise, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/coding-agent/create-custom-agents). +To reduce your administrative burden and empower your SMEs, you can delegate the creation and management of {% data variables.copilot.custom_agents_short %} in your enterprise by creating a team of AI managers. See [AUTOTITLE](/copilot/tutorials/roll-out-at-scale/establish-ai-managers). + +If you prefer to maintain full control over your enterprise's tooling to ensure security and compliance, you can create and manage {% data variables.copilot.custom_agents_short %} yourself. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/coding-agent/create-custom-agents). diff --git a/content/copilot/reference/agentic-audit-log-events.md b/content/copilot/reference/agentic-audit-log-events.md index 805888a5f093..efe042df3be0 100644 --- a/content/copilot/reference/agentic-audit-log-events.md +++ b/content/copilot/reference/agentic-audit-log-events.md @@ -2,7 +2,7 @@ title: Audit log events for agents shortTitle: Agentic audit log events intro: 'Understand the structure of audit log events for agents in your enterprise.' -permissions: Enterprise owners and people with read permissions for enterprise audit logs +permissions: Enterprise owners versions: feature: copilot topics: diff --git a/content/copilot/tutorials/roll-out-at-scale/establish-ai-managers.md b/content/copilot/tutorials/roll-out-at-scale/establish-ai-managers.md new file mode 100644 index 000000000000..d7d7cfd30de4 --- /dev/null +++ b/content/copilot/tutorials/roll-out-at-scale/establish-ai-managers.md @@ -0,0 +1,74 @@ +--- +title: Establishing AI managers in your enterprise +intro: 'Reduce your administrative burden and empower your SMEs by creating a team of AI managers.' +permissions: Enterprise owners +versions: + feature: copilot +topics: + - Copilot +shortTitle: Establish AI managers +contentType: tutorials +--- + +> [!NOTE] +> Enterprise custom roles, enterprise teams, and the AI Controls view are in public preview and subject to change. + +## Overview + +You can use custom roles and enterprise teams to delegate AI administration permissions without granting enterprise ownership. AI managers can view and manage **nearly all AI features in your enterprise's AI Controls**, including agentic AI features, {% data variables.product.prodname_copilot_short %} features, and Model Context Protocol (MCP) features. + +Unless you grant additional permissions beyond those listed in this article, AI managers **cannot access** the following: +* Access management settings for {% data variables.product.prodname_copilot_short %} +* Settings in the "Billing" section of the {% data variables.product.prodname_copilot_short %} page +* Settings in the "Metrics" section of the {% data variables.product.prodname_copilot_short %} page + +## 1. Create a custom role for AI management + +To get started, you need to create a custom role with the necessary permissions for AI management. + +{% data reusables.enterprise-accounts.start-creating-custom-role %} +1. To clarify the purpose of the role, give it a name and description. +1. In the "Add permissions" section, use the search bar to find and select the following permissions: + + * **Manage enterprise AI controls**: Allows this role to view and manage all settings in the "AI Controls" tab for your enterprise + * **Read enterprise audit logs**: Allows this role to view **all** audit log events for your enterprise, helping your AI managers monitor agentic activity + +1. Click **Create role**. + +## 2. Create an enterprise team for AI management + +Now that you have created your AI manager role, you need to set up an enterprise team and add your future AI managers as members. + +1. In the sidebar of the "People" tab, click {% octicon "people" aria-hidden="true" aria-label="people" %} **Enterprise teams**. +1. Click **Create Enterprise team**. +1. Give your team a name, then click **Create Enterprise team**. +1. On the team page, select the **Add members** dropdown menu, then click the members of your enterprise you want to grant AI management permissions to. +1. To confirm your selections, click **Add**. + +## 3. Assign the AI management role to your team + +With both your AI management role and team created, you can now assign the role to your team, granting management permissions to your team members. + +1. In the sidebar of the "People" tab, select {% octicon "globe" aria-hidden="true" aria-label="globe" %} **Enterprise roles**, then click **Role assignments**. +1. On the "Enterprise role assignments" page, click **Assign role**. +1. In the "Assign role to" section, select the **Select user or team** dropdown menu, then click your AI management team. +1. In the "Select role" section, click your AI management role. +1. At the bottom of the page, click **Assign role**. + +## 4. Grant your AI managers bypass permissions for {% data variables.copilot.agent_profiles %} + +If you have created a ruleset targeting {% data variables.copilot.agent_profiles %} in your enterprise, you can grant bypass access to allow your AI managers to create and edit those profiles. This access also lets your AI managers merge pull requests modifying those files, allowing your developers to propose {% data variables.copilot.custom_agents_short %} while maintaining your enterprise's security standards. + +{% data reusables.enterprise-accounts.ai-controls-tab %} +1. In the "Only enterprise admins can edit agent files" field, click **Edit ruleset** {% octicon "chevron-right" aria-hidden="true" aria-label="chevron-right" %}. + + ![Screenshot of the "Installed agents" section of the agent settings page. A button labeled "Edit ruleset" is outlined in dark orange.](/assets/images/help/enterprises/edit-agent-profile-ruleset.png) + +1. In the "Bypass list" section, select the {% octicon "plus" aria-hidden="true" aria-label="plus" %} **Add bypass** dropdown menu, then click your AI management team. +1. At the bottom of the page, click **Save changes**. + +## Next steps + +Now that you have established AI managers for your enterprise, help them customize and manage your enterprise's AI experience by sharing the following resources: +* [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-enterprise-policies) +* [AUTOTITLE](/copilot/how-tos/use-copilot-agents/coding-agent/create-custom-agents) diff --git a/content/copilot/tutorials/roll-out-at-scale/index.md b/content/copilot/tutorials/roll-out-at-scale/index.md index 160d098c5393..61224ece51e9 100644 --- a/content/copilot/tutorials/roll-out-at-scale/index.md +++ b/content/copilot/tutorials/roll-out-at-scale/index.md @@ -8,6 +8,7 @@ topics: - Copilot children: - /assign-licenses + - /establish-ai-managers - /enable-developers - /drive-downstream-impact - /measure-success diff --git a/content/site-policy/github-terms/github-dpa-previews.md b/content/site-policy/github-terms/github-dpa-previews.md index 64473de06d5c..e77c903b1611 100644 --- a/content/site-policy/github-terms/github-dpa-previews.md +++ b/content/site-policy/github-terms/github-dpa-previews.md @@ -14,4 +14,6 @@ The pre-release products and features listed below use data handling that is the | Product / Feature | DPA Coverage Date | |:---------------------------------------------------|:-------------------:| -| Coming Soon! | 27 October 2025 | +| Copilot CLI | 27 October 2025 | +| Copilot Enterprise & Users Usage Metrics Dashboard | 27 October 2025 | +| Spark | 27 October 2025 | diff --git a/data/reusables/enterprise-accounts/start-creating-custom-role.md b/data/reusables/enterprise-accounts/start-creating-custom-role.md new file mode 100644 index 000000000000..a3ecc69214bd --- /dev/null +++ b/data/reusables/enterprise-accounts/start-creating-custom-role.md @@ -0,0 +1,4 @@ +{% data reusables.enterprise-accounts.access-enterprise %} +{% data reusables.enterprise-accounts.people-tab %} +1. In the left sidebar, click **{% octicon "globe" aria-hidden="true" aria-label="globe" %} Enterprise roles**, then click **Role management**. +1. Click **Create custom role**. diff --git a/data/reusables/enterprise-onboarding/create-custom-roles.md b/data/reusables/enterprise-onboarding/create-custom-roles.md index 52fcdde1a8c4..8ee9278832f2 100644 --- a/data/reusables/enterprise-onboarding/create-custom-roles.md +++ b/data/reusables/enterprise-onboarding/create-custom-roles.md @@ -10,10 +10,7 @@ Custom roles are sets of permissions for settings and resources that you can ass Enterprise custom roles grant access to a subset of enterprise settings, such as viewing audit logs and creating organizations. {% data variables.product.github %} plans to expand the list of available permissions over time. -{% data reusables.enterprise-accounts.access-enterprise %} -{% data reusables.enterprise-accounts.people-tab %} -1. In the left sidebar, click **{% octicon "globe" aria-hidden="true" aria-label="globe" %} Enterprise roles**, then click **Role management**. -1. Click **Create custom role**. +{% data reusables.enterprise-accounts.start-creating-custom-role %} 1. Enter the details, then click **Create role**. {% endif %} diff --git a/src/github-apps/data/fpt-2022-11-28/fine-grained-pat-permissions.json b/src/github-apps/data/fpt-2022-11-28/fine-grained-pat-permissions.json index 167e5ea9da69..09c7b3b3e108 100644 --- a/src/github-apps/data/fpt-2022-11-28/fine-grained-pat-permissions.json +++ b/src/github-apps/data/fpt-2022-11-28/fine-grained-pat-permissions.json @@ -135,6 +135,15 @@ "additional-permissions": false, "access": "read" }, + { + "category": "billing", + "slug": "get-billing-usage-summary-report-for-an-organization", + "subcategory": "enhanced-billing", + "verb": "get", + "requestPath": "/organizations/{org}/settings/billing/usage/summary", + "additional-permissions": false, + "access": "read" + }, { "category": "orgs", "slug": "update-an-organization", @@ -8741,6 +8750,15 @@ "requestPath": "/users/{username}/settings/billing/usage", "additional-permissions": false, "access": "read" + }, + { + "category": "billing", + "slug": "get-billing-usage-summary-report-for-a-user", + "subcategory": "enhanced-billing", + "verb": "get", + "requestPath": "/users/{username}/settings/billing/usage/summary", + "additional-permissions": false, + "access": "read" } ] }, diff --git a/src/github-apps/data/fpt-2022-11-28/fine-grained-pat.json b/src/github-apps/data/fpt-2022-11-28/fine-grained-pat.json index 88afe097f2a7..79c9f0e67cee 100644 --- a/src/github-apps/data/fpt-2022-11-28/fine-grained-pat.json +++ b/src/github-apps/data/fpt-2022-11-28/fine-grained-pat.json @@ -1120,6 +1120,12 @@ "verb": "get", "requestPath": "/organizations/{org}/settings/billing/usage" }, + { + "slug": "get-billing-usage-summary-report-for-an-organization", + "subcategory": "enhanced-billing", + "verb": "get", + "requestPath": "/organizations/{org}/settings/billing/usage/summary" + }, { "slug": "get-github-actions-billing-for-an-organization", "subcategory": "billing", @@ -1167,6 +1173,12 @@ "subcategory": "enhanced-billing", "verb": "get", "requestPath": "/users/{username}/settings/billing/usage" + }, + { + "slug": "get-billing-usage-summary-report-for-a-user", + "subcategory": "enhanced-billing", + "verb": "get", + "requestPath": "/users/{username}/settings/billing/usage/summary" } ], "branches": [ diff --git a/src/github-apps/data/fpt-2022-11-28/server-to-server-permissions.json b/src/github-apps/data/fpt-2022-11-28/server-to-server-permissions.json index d8861d75d32b..a915cf9fd017 100644 --- a/src/github-apps/data/fpt-2022-11-28/server-to-server-permissions.json +++ b/src/github-apps/data/fpt-2022-11-28/server-to-server-permissions.json @@ -163,6 +163,17 @@ "server-to-server": true, "additional-permissions": false }, + { + "category": "billing", + "slug": "get-billing-usage-summary-report-for-an-organization", + "subcategory": "enhanced-billing", + "verb": "get", + "requestPath": "/organizations/{org}/settings/billing/usage/summary", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, { "category": "orgs", "slug": "update-an-organization", @@ -11038,6 +11049,17 @@ "user-to-server": true, "server-to-server": false, "additional-permissions": false + }, + { + "category": "billing", + "slug": "get-billing-usage-summary-report-for-a-user", + "subcategory": "enhanced-billing", + "verb": "get", + "requestPath": "/users/{username}/settings/billing/usage/summary", + "access": "read", + "user-to-server": true, + "server-to-server": false, + "additional-permissions": false } ] }, diff --git a/src/github-apps/data/fpt-2022-11-28/server-to-server-rest.json b/src/github-apps/data/fpt-2022-11-28/server-to-server-rest.json index 1125df4ce0f4..62ef7121110f 100644 --- a/src/github-apps/data/fpt-2022-11-28/server-to-server-rest.json +++ b/src/github-apps/data/fpt-2022-11-28/server-to-server-rest.json @@ -1158,6 +1158,12 @@ "verb": "get", "requestPath": "/organizations/{org}/settings/billing/usage" }, + { + "slug": "get-billing-usage-summary-report-for-an-organization", + "subcategory": "enhanced-billing", + "verb": "get", + "requestPath": "/organizations/{org}/settings/billing/usage/summary" + }, { "slug": "get-github-actions-billing-for-an-organization", "subcategory": "billing", diff --git a/src/github-apps/data/fpt-2022-11-28/user-to-server-rest.json b/src/github-apps/data/fpt-2022-11-28/user-to-server-rest.json index 6f8ad411cfd3..a0065cfff688 100644 --- a/src/github-apps/data/fpt-2022-11-28/user-to-server-rest.json +++ b/src/github-apps/data/fpt-2022-11-28/user-to-server-rest.json @@ -1200,6 +1200,12 @@ "verb": "get", "requestPath": "/organizations/{org}/settings/billing/usage" }, + { + "slug": "get-billing-usage-summary-report-for-an-organization", + "subcategory": "enhanced-billing", + "verb": "get", + "requestPath": "/organizations/{org}/settings/billing/usage/summary" + }, { "slug": "get-github-actions-billing-for-an-organization", "subcategory": "billing", @@ -1247,6 +1253,12 @@ "subcategory": "enhanced-billing", "verb": "get", "requestPath": "/users/{username}/settings/billing/usage" + }, + { + "slug": "get-billing-usage-summary-report-for-a-user", + "subcategory": "enhanced-billing", + "verb": "get", + "requestPath": "/users/{username}/settings/billing/usage/summary" } ], "branches": [ 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 b04d9fcd73d4..9a1a82ea2bda 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 @@ -213,6 +213,15 @@ "additional-permissions": false, "access": "read" }, + { + "category": "billing", + "slug": "get-billing-usage-summary-report-for-an-organization", + "subcategory": "enhanced-billing", + "verb": "get", + "requestPath": "/organizations/{org}/settings/billing/usage/summary", + "additional-permissions": false, + "access": "read" + }, { "category": "orgs", "slug": "update-an-organization", @@ -9608,6 +9617,15 @@ "requestPath": "/users/{username}/settings/billing/usage", "additional-permissions": false, "access": "read" + }, + { + "category": "billing", + "slug": "get-billing-usage-summary-report-for-a-user", + "subcategory": "enhanced-billing", + "verb": "get", + "requestPath": "/users/{username}/settings/billing/usage/summary", + "additional-permissions": false, + "access": "read" } ] }, 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 91514494b504..814b730be938 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 @@ -1140,6 +1140,12 @@ "verb": "get", "requestPath": "/organizations/{org}/settings/billing/usage" }, + { + "slug": "get-billing-usage-summary-report-for-an-organization", + "subcategory": "enhanced-billing", + "verb": "get", + "requestPath": "/organizations/{org}/settings/billing/usage/summary" + }, { "slug": "get-github-actions-billing-for-an-organization", "subcategory": "billing", @@ -1193,6 +1199,12 @@ "subcategory": "enhanced-billing", "verb": "get", "requestPath": "/users/{username}/settings/billing/usage" + }, + { + "slug": "get-billing-usage-summary-report-for-a-user", + "subcategory": "enhanced-billing", + "verb": "get", + "requestPath": "/users/{username}/settings/billing/usage/summary" } ], "branches": [ 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 a650eb36061e..d3fce01a0bea 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 @@ -760,6 +760,17 @@ "server-to-server": true, "additional-permissions": false }, + { + "category": "billing", + "slug": "get-billing-usage-summary-report-for-an-organization", + "subcategory": "enhanced-billing", + "verb": "get", + "requestPath": "/organizations/{org}/settings/billing/usage/summary", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, { "category": "orgs", "slug": "update-an-organization", @@ -12590,6 +12601,17 @@ "user-to-server": true, "server-to-server": false, "additional-permissions": false + }, + { + "category": "billing", + "slug": "get-billing-usage-summary-report-for-a-user", + "subcategory": "enhanced-billing", + "verb": "get", + "requestPath": "/users/{username}/settings/billing/usage/summary", + "access": "read", + "user-to-server": true, + "server-to-server": false, + "additional-permissions": false } ] }, 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 e8e4a846ff19..ca2e3ae5195f 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 @@ -1190,6 +1190,12 @@ "verb": "get", "requestPath": "/organizations/{org}/settings/billing/usage" }, + { + "slug": "get-billing-usage-summary-report-for-an-organization", + "subcategory": "enhanced-billing", + "verb": "get", + "requestPath": "/organizations/{org}/settings/billing/usage/summary" + }, { "slug": "get-github-actions-billing-for-an-organization", "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 7051faf508bd..50cd2fece2af 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 @@ -1232,6 +1232,12 @@ "verb": "get", "requestPath": "/organizations/{org}/settings/billing/usage" }, + { + "slug": "get-billing-usage-summary-report-for-an-organization", + "subcategory": "enhanced-billing", + "verb": "get", + "requestPath": "/organizations/{org}/settings/billing/usage/summary" + }, { "slug": "get-github-actions-billing-for-an-organization", "subcategory": "billing", @@ -1285,6 +1291,12 @@ "subcategory": "enhanced-billing", "verb": "get", "requestPath": "/users/{username}/settings/billing/usage" + }, + { + "slug": "get-billing-usage-summary-report-for-a-user", + "subcategory": "enhanced-billing", + "verb": "get", + "requestPath": "/users/{username}/settings/billing/usage/summary" } ], "branches": [ diff --git a/src/github-apps/lib/config.json b/src/github-apps/lib/config.json index 61fa29449c9c..8c4dcb1e612e 100644 --- a/src/github-apps/lib/config.json +++ b/src/github-apps/lib/config.json @@ -60,5 +60,5 @@ "2022-11-28" ] }, - "sha": "e8e7ce91c9f7b8171f2cb856842e1d1f930a0837" + "sha": "ebc1fecbcfb4449cc61d45e2608ac765b5b144a0" } \ 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 0e1538dfbb45..49bb8708b1f1 100644 --- a/src/rest/data/fpt-2022-11-28/schema.json +++ b/src/rest/data/fpt-2022-11-28/schema.json @@ -114644,6 +114644,257 @@ ] } }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/organizations/{org}/settings/billing/usage/summary", + "title": "Get billing usage summary report for an organization", + "category": "billing", + "subcategory": "enhanced-billing", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

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

If specified, only return results for a single year. The value of year is an integer with four digits representing a year. For example, 2025. Default value is the current year.

", + "in": "query", + "required": false, + "schema": { + "type": "integer" + } + }, + { + "name": "month", + "description": "

If specified, only return results for a single month. The value of month is an integer between 1 and 12. Default value is the current month. If no year is specified the default year is used.

", + "in": "query", + "required": false, + "schema": { + "type": "integer" + } + }, + { + "name": "day", + "description": "

If specified, only return results for a single day. The value of day is an integer between 1 and 31. If no year or month is specified, the default year and month are used.

", + "in": "query", + "required": false, + "schema": { + "type": "integer" + } + }, + { + "name": "repository", + "description": "

The repository name to query for usage in the format owner/repository.

", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "product", + "description": "

The product name to query usage for. The name is not case sensitive.

", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "sku", + "description": "

The SKU to query for usage.

", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "

Note

\n

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

\n
\n

Gets a summary report of usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account.

\n

Note: Only data from the past 24 months is accessible via this endpoint.

", + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response when getting a billing usage summary report

", + "example": { + "timePeriod": { + "year": 2025 + }, + "organization": "GitHub", + "usageItems": [ + { + "product": "Actions", + "sku": "actions_linux", + "unitType": "minutes", + "pricePerUnit": 0.008, + "grossQuantity": 1000, + "grossAmount": 8, + "discountQuantity": 0, + "discountAmount": 0, + "netQuantity": 1000, + "netAmount": 8 + } + ] + }, + "schema": { + "type": "object", + "properties": { + "timePeriod": { + "type": "object", + "properties": { + "year": { + "type": "integer", + "description": "The year for the usage report." + }, + "month": { + "type": "integer", + "description": "The month for the usage report." + }, + "day": { + "type": "integer", + "description": "The day for the usage report." + } + }, + "required": [ + "year" + ] + }, + "organization": { + "type": "string", + "description": "The unique identifier of the organization." + }, + "repository": { + "type": "string", + "description": "The name of the repository for the usage report." + }, + "product": { + "type": "string", + "description": "The product for the usage report." + }, + "sku": { + "type": "string", + "description": "The SKU for the usage report." + }, + "usageItems": { + "type": "array", + "items": { + "type": "object", + "properties": { + "product": { + "type": "string", + "description": "Product name." + }, + "sku": { + "type": "string", + "description": "SKU name." + }, + "unitType": { + "type": "string", + "description": "Unit type of the usage line item." + }, + "pricePerUnit": { + "type": "number", + "description": "Price per unit of the usage line item." + }, + "grossQuantity": { + "type": "number", + "description": "Gross quantity of the usage line item." + }, + "grossAmount": { + "type": "number", + "description": "Gross amount of the usage line item." + }, + "discountQuantity": { + "type": "number", + "description": "Discount quantity of the usage line item." + }, + "discountAmount": { + "type": "number", + "description": "Discount amount of the usage line item." + }, + "netQuantity": { + "type": "number", + "description": "Net quantity of the usage line item." + }, + "netAmount": { + "type": "number", + "description": "Net amount of the usage line item." + } + }, + "required": [ + "product", + "sku", + "unitType", + "pricePerUnit", + "grossQuantity", + "grossAmount", + "discountQuantity", + "discountAmount", + "netQuantity", + "netAmount" + ] + } + } + }, + "required": [ + "timePeriod", + "organization", + "usageItems" + ] + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

Response when getting a billing usage summary report

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

Bad Request

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

Forbidden

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

Internal Error

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

Service unavailable

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Administration\" organization permissions": "read" + } + ] + } + }, { "serverUrl": "https://api.github.com", "verb": "get", @@ -114920,7 +115171,185 @@ }, { "name": "month", - "description": "

If specified, only return results for a single month. The value of month is an integer between 1 and 12. If no year is specified the default year is used.

", + "description": "

If specified, only return results for a single month. The value of month is an integer between 1 and 12. If no year is specified the default year is used.

", + "in": "query", + "required": false, + "schema": { + "type": "integer" + } + }, + { + "name": "day", + "description": "

If specified, only return results for a single day. The value of day is an integer between 1 and 31. If no year or month is specified, the default year and month are used.

", + "in": "query", + "required": false, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "

Gets a report of the total usage for a user.

\n

Note: This endpoint is only available to users with access to the enhanced billing platform.

", + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "username": "USERNAME" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response when getting a billing usage report

", + "example": { + "usageItems": [ + { + "date": "2023-08-01", + "product": "Actions", + "sku": "Actions Linux", + "quantity": 100, + "unitType": "minutes", + "pricePerUnit": 0.008, + "grossAmount": 0.8, + "discountAmount": 0, + "netAmount": 0.8, + "repositoryName": "user/example" + } + ] + }, + "schema": { + "type": "object", + "properties": { + "usageItems": { + "type": "array", + "items": { + "type": "object", + "properties": { + "date": { + "type": "string", + "description": "Date of the usage line item." + }, + "product": { + "type": "string", + "description": "Product name." + }, + "sku": { + "type": "string", + "description": "SKU name." + }, + "quantity": { + "type": "integer", + "description": "Quantity of the usage line item." + }, + "unitType": { + "type": "string", + "description": "Unit type of the usage line item." + }, + "pricePerUnit": { + "type": "number", + "description": "Price per unit of the usage line item." + }, + "grossAmount": { + "type": "number", + "description": "Gross amount of the usage line item." + }, + "discountAmount": { + "type": "number", + "description": "Discount amount of the usage line item." + }, + "netAmount": { + "type": "number", + "description": "Net amount of the usage line item." + }, + "repositoryName": { + "type": "string", + "description": "Name of the repository." + } + }, + "required": [ + "date", + "product", + "sku", + "quantity", + "unitType", + "pricePerUnit", + "grossAmount", + "discountAmount", + "netAmount" + ] + } + } + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

Response when getting a billing usage report

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

Bad Request

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

Forbidden

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

Internal Error

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

Service unavailable

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": false, + "fineGrainedPat": true, + "permissions": [ + { + "\"Plan\" user permissions": "read" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/users/{username}/settings/billing/usage/summary", + "title": "Get billing usage summary report for a user", + "category": "billing", + "subcategory": "enhanced-billing", + "parameters": [ + { + "name": "username", + "description": "

The handle for the GitHub user account.

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

If specified, only return results for a single year. The value of year is an integer with four digits representing a year. For example, 2025. Default value is the current year.

", + "in": "query", + "required": false, + "schema": { + "type": "integer" + } + }, + { + "name": "month", + "description": "

If specified, only return results for a single month. The value of month is an integer between 1 and 12. Default value is the current month. If no year is specified the default year is used.

", "in": "query", "required": false, "schema": { @@ -114935,10 +115364,37 @@ "schema": { "type": "integer" } + }, + { + "name": "repository", + "description": "

The repository name to query for usage in the format owner/repository.

", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "product", + "description": "

The product name to query usage for. The name is not case sensitive.

", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "sku", + "description": "

The SKU to query for usage.

", + "in": "query", + "required": false, + "schema": { + "type": "string" + } } ], "bodyParameters": [], - "descriptionHTML": "

Gets a report of the total usage for a user.

\n

Note: This endpoint is only available to users with access to the enhanced billing platform.

", + "descriptionHTML": "

Note

\n

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

\n
\n

Gets a summary report of usage for a user.

\n

Note: Only data from the past 24 months is accessible via this endpoint.

", "codeExamples": [ { "key": "default", @@ -114952,35 +115408,71 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "

Response when getting a billing usage report

", + "description": "

Response when getting a billing usage summary report

", "example": { + "timePeriod": { + "year": 2025 + }, + "user": "monalisa", "usageItems": [ { - "date": "2023-08-01", "product": "Actions", - "sku": "Actions Linux", - "quantity": 100, + "sku": "actions_linux", "unitType": "minutes", "pricePerUnit": 0.008, - "grossAmount": 0.8, + "grossQuantity": 1000, + "grossAmount": 8, + "discountQuantity": 0, "discountAmount": 0, - "netAmount": 0.8, - "repositoryName": "user/example" + "netQuantity": 1000, + "netAmount": 8 } ] }, "schema": { "type": "object", "properties": { + "timePeriod": { + "type": "object", + "properties": { + "year": { + "type": "integer", + "description": "The year for the usage report." + }, + "month": { + "type": "integer", + "description": "The month for the usage report." + }, + "day": { + "type": "integer", + "description": "The day for the usage report." + } + }, + "required": [ + "year" + ] + }, + "user": { + "type": "string", + "description": "The unique identifier of the user." + }, + "repository": { + "type": "string", + "description": "The name of the repository for the usage report." + }, + "product": { + "type": "string", + "description": "The product for the usage report." + }, + "sku": { + "type": "string", + "description": "The SKU for the usage report." + }, "usageItems": { "type": "array", "items": { "type": "object", "properties": { - "date": { - "type": "string", - "description": "Date of the usage line item." - }, "product": { "type": "string", "description": "Product name." @@ -114989,10 +115481,6 @@ "type": "string", "description": "SKU name." }, - "quantity": { - "type": "integer", - "description": "Quantity of the usage line item." - }, "unitType": { "type": "string", "description": "Unit type of the usage line item." @@ -115001,37 +115489,51 @@ "type": "number", "description": "Price per unit of the usage line item." }, + "grossQuantity": { + "type": "number", + "description": "Gross quantity of the usage line item." + }, "grossAmount": { "type": "number", "description": "Gross amount of the usage line item." }, + "discountQuantity": { + "type": "number", + "description": "Discount quantity of the usage line item." + }, "discountAmount": { "type": "number", "description": "Discount amount of the usage line item." }, + "netQuantity": { + "type": "number", + "description": "Net quantity of the usage line item." + }, "netAmount": { "type": "number", "description": "Net amount of the usage line item." - }, - "repositoryName": { - "type": "string", - "description": "Name of the repository." } }, "required": [ - "date", "product", "sku", - "quantity", "unitType", "pricePerUnit", + "grossQuantity", "grossAmount", + "discountQuantity", "discountAmount", + "netQuantity", "netAmount" ] } } - } + }, + "required": [ + "timePeriod", + "user", + "usageItems" + ] } } } @@ -115039,7 +115541,7 @@ "statusCodes": [ { "httpStatusCode": "200", - "description": "

Response when getting a billing usage report

" + "description": "

Response when getting a billing usage summary report

" }, { "httpStatusCode": "400", @@ -115049,6 +115551,10 @@ "httpStatusCode": "403", "description": "

Forbidden

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

Resource not found

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

Internal Error

" @@ -426621,6 +427127,12 @@ "deleted" ], "default": "active" + }, + { + "type": "string", + "name": "github_repository", + "in": "body", + "description": "

The name of the GitHub repository associated with the artifact. This should be used\nwhen there are no provenance attestations available for the artifact. The repository\nmust belong to the organization specified in the path parameter.

\n

If a provenance attestation is available for the artifact, the API will use\nthe repository information from the attestation instead of this parameter.

" } ], "descriptionHTML": "

Create metadata storage records for artifacts associated with an organization.\nThis endpoint will create a new artifact storage record on behalf of any artifact matching the provided digest and\nassociated with a repository owned by the organization.

", @@ -470162,6 +470674,11 @@ ], "type": "string" }, + "url": { + "description": "The URL of the private registry.", + "type": "string", + "format": "uri" + }, "username": { "description": "The username to use when authenticating with the private registry.", "type": [ @@ -470172,6 +470689,11 @@ "monalisa" ] }, + "replaces_base": { + "description": "Whether this private registry replaces the base registry (e.g., npmjs.org for npm, rubygems.org for rubygems). When `true`, Dependabot will only use this registry and will not fall back to the public registry. When `false` (default), Dependabot will use this registry for scoped packages but may fall back to the public registry for other packages.", + "type": "boolean", + "default": false + }, "visibility": { "description": "Which type of organization repositories have access to the private registry.", "enum": [ @@ -470286,6 +470808,13 @@ "in": "body", "description": "

The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication.

" }, + { + "type": "boolean", + "name": "replaces_base", + "in": "body", + "description": "

Whether this private registry should replace the base registry (e.g., npmjs.org for npm, rubygems.org for rubygems). When set to true, Dependabot will only use this registry and will not fall back to the public registry. When set to false (default), Dependabot will use this registry for scoped packages but may fall back to the public registry for other packages.

", + "default": false + }, { "type": "string", "name": "encrypted_value", @@ -470331,6 +470860,7 @@ "registry_type": "maven_repository", "url": "https://maven.pkg.github.com/organization/", "username": "monalisa", + "replaces_base": true, "encrypted_value": "c2VjcmV0", "key_id": "012345678912345678", "visibility": "private" @@ -470388,6 +470918,11 @@ ], "type": "string" }, + "url": { + "description": "The URL of the private registry.", + "type": "string", + "format": "uri" + }, "username": { "description": "The username to use when authenticating with the private registry.", "type": "string", @@ -470395,6 +470930,11 @@ "monalisa" ] }, + "replaces_base": { + "description": "Whether this private registry replaces the base registry (e.g., npmjs.org for npm, rubygems.org for rubygems). When `true`, Dependabot will only use this registry and will not fall back to the public registry. When `false` (default), Dependabot will use this registry for scoped packages but may fall back to the public registry for other packages.", + "type": "boolean", + "default": false + }, "visibility": { "description": "Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access the private registry.", "enum": [ @@ -470497,6 +471037,11 @@ ], "type": "string" }, + "url": { + "description": "The URL of the private registry.", + "type": "string", + "format": "uri" + }, "username": { "description": "The username to use when authenticating with the private registry.", "type": "string", @@ -470504,6 +471049,11 @@ "monalisa" ] }, + "replaces_base": { + "description": "Whether this private registry replaces the base registry (e.g., npmjs.org for npm, rubygems.org for rubygems). When `true`, Dependabot will only use this registry and will not fall back to the public registry. When `false` (default), Dependabot will use this registry for scoped packages but may fall back to the public registry for other packages.", + "type": "boolean", + "default": false + }, "visibility": { "description": "Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access the private registry.", "enum": [ @@ -470737,6 +471287,11 @@ ], "type": "string" }, + "url": { + "description": "The URL of the private registry.", + "type": "string", + "format": "uri" + }, "username": { "description": "The username to use when authenticating with the private registry.", "type": [ @@ -470747,6 +471302,11 @@ "monalisa" ] }, + "replaces_base": { + "description": "Whether this private registry replaces the base registry (e.g., npmjs.org for npm, rubygems.org for rubygems). When `true`, Dependabot will only use this registry and will not fall back to the public registry. When `false` (default), Dependabot will use this registry for scoped packages but may fall back to the public registry for other packages.", + "type": "boolean", + "default": false + }, "visibility": { "description": "Which type of organization repositories have access to the private registry.", "enum": [ @@ -470861,6 +471421,13 @@ "in": "body", "description": "

The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication.

" }, + { + "type": "boolean", + "name": "replaces_base", + "in": "body", + "description": "

Whether this private registry should replace the base registry (e.g., npmjs.org for npm, rubygems.org for rubygems). When set to true, Dependabot will only use this registry and will not fall back to the public registry. When set to false (default), Dependabot will use this registry for scoped packages but may fall back to the public registry for other packages.

", + "default": false + }, { "type": "string", "name": "encrypted_value", @@ -475294,35 +475861,120 @@ "statusCode": "200", "contentType": "application/json", "description": "

Response

", - "example": { - "id": 12345, - "node_id": "PVTF_lADOABCD1234567890", - "name": "Priority", - "data_type": "single_select", - "project_url": "https://api.github.com/projects/67890", - "options": [ - { - "id": "option_1", - "name": "Low", - "color": "GREEN", - "description": "Low priority items" - }, - { - "id": "option_2", - "name": "Medium", - "color": "YELLOW", - "description": "Medium priority items" + "example": [ + { + "id": 12345, + "node_id": "PVTF_lADOABCD1234567890", + "name": "Priority", + "data_type": "single_select", + "project_url": "https://api.github.com/projects/67890", + "options": [ + { + "id": "option_1", + "name": "Low", + "color": "GREEN", + "description": "Low priority items" + }, + { + "id": "option_2", + "name": "Medium", + "color": "YELLOW", + "description": "Medium priority items" + }, + { + "id": "option_3", + "name": "High", + "color": "RED", + "description": "High priority items" + } + ], + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z" + }, + { + "id": 67891, + "node_id": "PVTF_lADOABCD9876543210", + "name": "Status", + "data_type": "single_select", + "project_url": "https://api.github.com/projects/67890", + "options": [ + { + "id": "option_4", + "name": "Todo", + "color": "GRAY", + "description": "Items to be worked on" + }, + { + "id": "option_5", + "name": "In Progress", + "color": "BLUE", + "description": "Items currently being worked on" + }, + { + "id": "option_6", + "name": "Done", + "color": "GREEN", + "description": "Completed items" + } + ], + "created_at": "2022-04-29T10:30:00Z", + "updated_at": "2022-04-29T10:30:00Z" + }, + { + "id": 24680, + "node_id": "PVTF_lADOABCD2468024680", + "name": "Team notes", + "data_type": "text", + "project_url": "https://api.github.com/projects/67890", + "created_at": "2022-05-15T08:00:00Z", + "updated_at": "2022-05-15T08:00:00Z" + }, + { + "id": 13579, + "node_id": "PVTF_lADOABCD1357913579", + "name": "Story points", + "data_type": "number", + "project_url": "https://api.github.com/projects/67890", + "created_at": "2022-06-01T14:30:00Z", + "updated_at": "2022-06-01T14:30:00Z" + }, + { + "id": 98765, + "node_id": "PVTF_lADOABCD9876598765", + "name": "Due date", + "data_type": "date", + "project_url": "https://api.github.com/projects/67890", + "created_at": "2022-06-10T09:15:00Z", + "updated_at": "2022-06-10T09:15:00Z" + }, + { + "id": 11223, + "node_id": "PVTF_lADOABCD1122311223", + "name": "Sprint", + "data_type": "iteration", + "project_url": "https://api.github.com/projects/67890", + "configuration": { + "duration": 14, + "start_day": 1, + "iterations": [ + { + "id": "iter_1", + "title": "Sprint 1", + "start_date": "2022-07-01", + "duration": 14 + }, + { + "id": "iter_2", + "title": "Sprint 2", + "start_date": "2022-07-15", + "duration": 14 + } + ] }, - { - "id": "option_3", - "name": "High", - "color": "RED", - "description": "High priority items" - } - ], - "created_at": "2022-04-28T12:00:00Z", - "updated_at": "2022-04-28T12:00:00Z" - }, + "created_at": "2022-06-20T16:45:00Z", + "updated_at": "2022-06-20T16:45:00Z" + } + ], "schema": { "type": "array", "items": { @@ -475932,35 +476584,120 @@ "statusCode": "200", "contentType": "application/json", "description": "

Response

", - "example": { - "id": 12345, - "node_id": "PVTF_lADOABCD1234567890", - "name": "Priority", - "data_type": "single_select", - "project_url": "https://api.github.com/projects/67890", - "options": [ - { - "id": "option_1", - "name": "Low", - "color": "GREEN", - "description": "Low priority items" - }, - { - "id": "option_2", - "name": "Medium", - "color": "YELLOW", - "description": "Medium priority items" + "example": [ + { + "id": 12345, + "node_id": "PVTF_lADOABCD1234567890", + "name": "Priority", + "data_type": "single_select", + "project_url": "https://api.github.com/projects/67890", + "options": [ + { + "id": "option_1", + "name": "Low", + "color": "GREEN", + "description": "Low priority items" + }, + { + "id": "option_2", + "name": "Medium", + "color": "YELLOW", + "description": "Medium priority items" + }, + { + "id": "option_3", + "name": "High", + "color": "RED", + "description": "High priority items" + } + ], + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z" + }, + { + "id": 67891, + "node_id": "PVTF_lADOABCD9876543210", + "name": "Status", + "data_type": "single_select", + "project_url": "https://api.github.com/projects/67890", + "options": [ + { + "id": "option_4", + "name": "Todo", + "color": "GRAY", + "description": "Items to be worked on" + }, + { + "id": "option_5", + "name": "In Progress", + "color": "BLUE", + "description": "Items currently being worked on" + }, + { + "id": "option_6", + "name": "Done", + "color": "GREEN", + "description": "Completed items" + } + ], + "created_at": "2022-04-29T10:30:00Z", + "updated_at": "2022-04-29T10:30:00Z" + }, + { + "id": 24680, + "node_id": "PVTF_lADOABCD2468024680", + "name": "Team notes", + "data_type": "text", + "project_url": "https://api.github.com/projects/67890", + "created_at": "2022-05-15T08:00:00Z", + "updated_at": "2022-05-15T08:00:00Z" + }, + { + "id": 13579, + "node_id": "PVTF_lADOABCD1357913579", + "name": "Story points", + "data_type": "number", + "project_url": "https://api.github.com/projects/67890", + "created_at": "2022-06-01T14:30:00Z", + "updated_at": "2022-06-01T14:30:00Z" + }, + { + "id": 98765, + "node_id": "PVTF_lADOABCD9876598765", + "name": "Due date", + "data_type": "date", + "project_url": "https://api.github.com/projects/67890", + "created_at": "2022-06-10T09:15:00Z", + "updated_at": "2022-06-10T09:15:00Z" + }, + { + "id": 11223, + "node_id": "PVTF_lADOABCD1122311223", + "name": "Sprint", + "data_type": "iteration", + "project_url": "https://api.github.com/projects/67890", + "configuration": { + "duration": 14, + "start_day": 1, + "iterations": [ + { + "id": "iter_1", + "title": "Sprint 1", + "start_date": "2022-07-01", + "duration": 14 + }, + { + "id": "iter_2", + "title": "Sprint 2", + "start_date": "2022-07-15", + "duration": 14 + } + ] }, - { - "id": "option_3", - "name": "High", - "color": "RED", - "description": "High priority items" - } - ], - "created_at": "2022-04-28T12:00:00Z", - "updated_at": "2022-04-28T12:00:00Z" - }, + "created_at": "2022-06-20T16:45:00Z", + "updated_at": "2022-06-20T16:45:00Z" + } + ], "schema": { "type": "array", "items": { diff --git a/src/rest/data/ghec-2022-11-28/schema.json b/src/rest/data/ghec-2022-11-28/schema.json index 79c4480a657b..85522f0ec036 100644 --- a/src/rest/data/ghec-2022-11-28/schema.json +++ b/src/rest/data/ghec-2022-11-28/schema.json @@ -125685,6 +125685,257 @@ ] } }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/organizations/{org}/settings/billing/usage/summary", + "title": "Get billing usage summary report for an organization", + "category": "billing", + "subcategory": "enhanced-billing", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

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

If specified, only return results for a single year. The value of year is an integer with four digits representing a year. For example, 2025. Default value is the current year.

", + "in": "query", + "required": false, + "schema": { + "type": "integer" + } + }, + { + "name": "month", + "description": "

If specified, only return results for a single month. The value of month is an integer between 1 and 12. Default value is the current month. If no year is specified the default year is used.

", + "in": "query", + "required": false, + "schema": { + "type": "integer" + } + }, + { + "name": "day", + "description": "

If specified, only return results for a single day. The value of day is an integer between 1 and 31. If no year or month is specified, the default year and month are used.

", + "in": "query", + "required": false, + "schema": { + "type": "integer" + } + }, + { + "name": "repository", + "description": "

The repository name to query for usage in the format owner/repository.

", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "product", + "description": "

The product name to query usage for. The name is not case sensitive.

", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "sku", + "description": "

The SKU to query for usage.

", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "

Note

\n

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

\n
\n

Gets a summary report of usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account.

\n

Note: Only data from the past 24 months is accessible via this endpoint.

", + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response when getting a billing usage summary report

", + "example": { + "timePeriod": { + "year": 2025 + }, + "organization": "GitHub", + "usageItems": [ + { + "product": "Actions", + "sku": "actions_linux", + "unitType": "minutes", + "pricePerUnit": 0.008, + "grossQuantity": 1000, + "grossAmount": 8, + "discountQuantity": 0, + "discountAmount": 0, + "netQuantity": 1000, + "netAmount": 8 + } + ] + }, + "schema": { + "type": "object", + "properties": { + "timePeriod": { + "type": "object", + "properties": { + "year": { + "type": "integer", + "description": "The year for the usage report." + }, + "month": { + "type": "integer", + "description": "The month for the usage report." + }, + "day": { + "type": "integer", + "description": "The day for the usage report." + } + }, + "required": [ + "year" + ] + }, + "organization": { + "type": "string", + "description": "The unique identifier of the organization." + }, + "repository": { + "type": "string", + "description": "The name of the repository for the usage report." + }, + "product": { + "type": "string", + "description": "The product for the usage report." + }, + "sku": { + "type": "string", + "description": "The SKU for the usage report." + }, + "usageItems": { + "type": "array", + "items": { + "type": "object", + "properties": { + "product": { + "type": "string", + "description": "Product name." + }, + "sku": { + "type": "string", + "description": "SKU name." + }, + "unitType": { + "type": "string", + "description": "Unit type of the usage line item." + }, + "pricePerUnit": { + "type": "number", + "description": "Price per unit of the usage line item." + }, + "grossQuantity": { + "type": "number", + "description": "Gross quantity of the usage line item." + }, + "grossAmount": { + "type": "number", + "description": "Gross amount of the usage line item." + }, + "discountQuantity": { + "type": "number", + "description": "Discount quantity of the usage line item." + }, + "discountAmount": { + "type": "number", + "description": "Discount amount of the usage line item." + }, + "netQuantity": { + "type": "number", + "description": "Net quantity of the usage line item." + }, + "netAmount": { + "type": "number", + "description": "Net amount of the usage line item." + } + }, + "required": [ + "product", + "sku", + "unitType", + "pricePerUnit", + "grossQuantity", + "grossAmount", + "discountQuantity", + "discountAmount", + "netQuantity", + "netAmount" + ] + } + } + }, + "required": [ + "timePeriod", + "organization", + "usageItems" + ] + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

Response when getting a billing usage summary report

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

Bad Request

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

Forbidden

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

Internal Error

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

Service unavailable

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Administration\" organization permissions": "read" + } + ] + } + }, { "serverUrl": "https://api.github.com", "verb": "get", @@ -125961,7 +126212,185 @@ }, { "name": "month", - "description": "

If specified, only return results for a single month. The value of month is an integer between 1 and 12. If no year is specified the default year is used.

", + "description": "

If specified, only return results for a single month. The value of month is an integer between 1 and 12. If no year is specified the default year is used.

", + "in": "query", + "required": false, + "schema": { + "type": "integer" + } + }, + { + "name": "day", + "description": "

If specified, only return results for a single day. The value of day is an integer between 1 and 31. If no year or month is specified, the default year and month are used.

", + "in": "query", + "required": false, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "

Gets a report of the total usage for a user.

\n

Note: This endpoint is only available to users with access to the enhanced billing platform.

", + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "username": "USERNAME" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response when getting a billing usage report

", + "example": { + "usageItems": [ + { + "date": "2023-08-01", + "product": "Actions", + "sku": "Actions Linux", + "quantity": 100, + "unitType": "minutes", + "pricePerUnit": 0.008, + "grossAmount": 0.8, + "discountAmount": 0, + "netAmount": 0.8, + "repositoryName": "user/example" + } + ] + }, + "schema": { + "type": "object", + "properties": { + "usageItems": { + "type": "array", + "items": { + "type": "object", + "properties": { + "date": { + "type": "string", + "description": "Date of the usage line item." + }, + "product": { + "type": "string", + "description": "Product name." + }, + "sku": { + "type": "string", + "description": "SKU name." + }, + "quantity": { + "type": "integer", + "description": "Quantity of the usage line item." + }, + "unitType": { + "type": "string", + "description": "Unit type of the usage line item." + }, + "pricePerUnit": { + "type": "number", + "description": "Price per unit of the usage line item." + }, + "grossAmount": { + "type": "number", + "description": "Gross amount of the usage line item." + }, + "discountAmount": { + "type": "number", + "description": "Discount amount of the usage line item." + }, + "netAmount": { + "type": "number", + "description": "Net amount of the usage line item." + }, + "repositoryName": { + "type": "string", + "description": "Name of the repository." + } + }, + "required": [ + "date", + "product", + "sku", + "quantity", + "unitType", + "pricePerUnit", + "grossAmount", + "discountAmount", + "netAmount" + ] + } + } + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

Response when getting a billing usage report

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

Bad Request

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

Forbidden

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

Internal Error

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

Service unavailable

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": false, + "fineGrainedPat": true, + "permissions": [ + { + "\"Plan\" user permissions": "read" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/users/{username}/settings/billing/usage/summary", + "title": "Get billing usage summary report for a user", + "category": "billing", + "subcategory": "enhanced-billing", + "parameters": [ + { + "name": "username", + "description": "

The handle for the GitHub user account.

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

If specified, only return results for a single year. The value of year is an integer with four digits representing a year. For example, 2025. Default value is the current year.

", + "in": "query", + "required": false, + "schema": { + "type": "integer" + } + }, + { + "name": "month", + "description": "

If specified, only return results for a single month. The value of month is an integer between 1 and 12. Default value is the current month. If no year is specified the default year is used.

", "in": "query", "required": false, "schema": { @@ -125976,10 +126405,37 @@ "schema": { "type": "integer" } + }, + { + "name": "repository", + "description": "

The repository name to query for usage in the format owner/repository.

", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "product", + "description": "

The product name to query usage for. The name is not case sensitive.

", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "sku", + "description": "

The SKU to query for usage.

", + "in": "query", + "required": false, + "schema": { + "type": "string" + } } ], "bodyParameters": [], - "descriptionHTML": "

Gets a report of the total usage for a user.

\n

Note: This endpoint is only available to users with access to the enhanced billing platform.

", + "descriptionHTML": "

Note

\n

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

\n
\n

Gets a summary report of usage for a user.

\n

Note: Only data from the past 24 months is accessible via this endpoint.

", "codeExamples": [ { "key": "default", @@ -125993,35 +126449,71 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "

Response when getting a billing usage report

", + "description": "

Response when getting a billing usage summary report

", "example": { + "timePeriod": { + "year": 2025 + }, + "user": "monalisa", "usageItems": [ { - "date": "2023-08-01", "product": "Actions", - "sku": "Actions Linux", - "quantity": 100, + "sku": "actions_linux", "unitType": "minutes", "pricePerUnit": 0.008, - "grossAmount": 0.8, + "grossQuantity": 1000, + "grossAmount": 8, + "discountQuantity": 0, "discountAmount": 0, - "netAmount": 0.8, - "repositoryName": "user/example" + "netQuantity": 1000, + "netAmount": 8 } ] }, "schema": { "type": "object", "properties": { + "timePeriod": { + "type": "object", + "properties": { + "year": { + "type": "integer", + "description": "The year for the usage report." + }, + "month": { + "type": "integer", + "description": "The month for the usage report." + }, + "day": { + "type": "integer", + "description": "The day for the usage report." + } + }, + "required": [ + "year" + ] + }, + "user": { + "type": "string", + "description": "The unique identifier of the user." + }, + "repository": { + "type": "string", + "description": "The name of the repository for the usage report." + }, + "product": { + "type": "string", + "description": "The product for the usage report." + }, + "sku": { + "type": "string", + "description": "The SKU for the usage report." + }, "usageItems": { "type": "array", "items": { "type": "object", "properties": { - "date": { - "type": "string", - "description": "Date of the usage line item." - }, "product": { "type": "string", "description": "Product name." @@ -126030,10 +126522,6 @@ "type": "string", "description": "SKU name." }, - "quantity": { - "type": "integer", - "description": "Quantity of the usage line item." - }, "unitType": { "type": "string", "description": "Unit type of the usage line item." @@ -126042,37 +126530,51 @@ "type": "number", "description": "Price per unit of the usage line item." }, + "grossQuantity": { + "type": "number", + "description": "Gross quantity of the usage line item." + }, "grossAmount": { "type": "number", "description": "Gross amount of the usage line item." }, + "discountQuantity": { + "type": "number", + "description": "Discount quantity of the usage line item." + }, "discountAmount": { "type": "number", "description": "Discount amount of the usage line item." }, + "netQuantity": { + "type": "number", + "description": "Net quantity of the usage line item." + }, "netAmount": { "type": "number", "description": "Net amount of the usage line item." - }, - "repositoryName": { - "type": "string", - "description": "Name of the repository." } }, "required": [ - "date", "product", "sku", - "quantity", "unitType", "pricePerUnit", + "grossQuantity", "grossAmount", + "discountQuantity", "discountAmount", + "netQuantity", "netAmount" ] } } - } + }, + "required": [ + "timePeriod", + "user", + "usageItems" + ] } } } @@ -126080,7 +126582,7 @@ "statusCodes": [ { "httpStatusCode": "200", - "description": "

Response when getting a billing usage report

" + "description": "

Response when getting a billing usage summary report

" }, { "httpStatusCode": "400", @@ -126090,6 +126592,10 @@ "httpStatusCode": "403", "description": "

Forbidden

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

Resource not found

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

Internal Error

" @@ -297387,7 +297893,196 @@ }, { "name": "month", - "description": "

If specified, only return results for a single month. The value of month is an integer between 1 and 12. If no year is specified the default year is used.

", + "description": "

If specified, only return results for a single month. The value of month is an integer between 1 and 12. If no year is specified the default year is used.

", + "in": "query", + "required": false, + "schema": { + "type": "integer" + } + }, + { + "name": "day", + "description": "

If specified, only return results for a single day. The value of day is an integer between 1 and 31. If no year or month is specified, the default year and month are used.

", + "in": "query", + "required": false, + "schema": { + "type": "integer" + } + }, + { + "name": "cost_center_id", + "description": "

The ID corresponding to a cost center. The default value is no cost center.

", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "

Gets a report of usage by cost center for an enterprise. To use this endpoint, you must be an administrator or billing manager of the enterprise. By default this endpoint will return usage that does not have a cost center.

\n

Note: This endpoint is only available to enterprises with access to the enhanced billing platform. For more information, see \"About the enhanced billing platform for enterprises.\"

", + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "enterprise": "ENTERPRISE" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response when getting a billing usage report

", + "example": { + "usageItems": [ + { + "date": "2023-08-01", + "product": "Actions", + "sku": "Actions Linux", + "quantity": 100, + "unitType": "minutes", + "pricePerUnit": 0.008, + "grossAmount": 0.8, + "discountAmount": 0, + "netAmount": 0.8, + "organizationName": "GitHub", + "repositoryName": "github/example" + } + ] + }, + "schema": { + "type": "object", + "properties": { + "usageItems": { + "type": "array", + "items": { + "type": "object", + "properties": { + "date": { + "type": "string", + "description": "Date of the usage line item." + }, + "product": { + "type": "string", + "description": "Product name." + }, + "sku": { + "type": "string", + "description": "SKU name." + }, + "quantity": { + "type": "integer", + "description": "Quantity of the usage line item." + }, + "unitType": { + "type": "string", + "description": "Unit type of the usage line item." + }, + "pricePerUnit": { + "type": "number", + "description": "Price per unit of the usage line item." + }, + "grossAmount": { + "type": "number", + "description": "Gross amount of the usage line item." + }, + "discountAmount": { + "type": "number", + "description": "Discount amount of the usage line item." + }, + "netAmount": { + "type": "number", + "description": "Net amount of the usage line item." + }, + "organizationName": { + "type": "string", + "description": "Name of the organization." + }, + "repositoryName": { + "type": "string", + "description": "Name of the repository." + } + }, + "required": [ + "date", + "product", + "sku", + "quantity", + "unitType", + "pricePerUnit", + "grossAmount", + "discountAmount", + "netAmount", + "organizationName" + ] + } + } + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

Response when getting a billing usage report

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

Bad Request

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

Forbidden

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

Internal Error

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

Service unavailable

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/enterprises/{enterprise}/settings/billing/usage/summary", + "title": "Get billing usage summary report for an enterprise", + "category": "enterprise-admin", + "subcategory": "billing", + "parameters": [ + { + "name": "enterprise", + "description": "

The slug version of the enterprise name.

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

If specified, only return results for a single year. The value of year is an integer with four digits representing a year. For example, 2025. Default value is the current year.

", + "in": "query", + "required": false, + "schema": { + "type": "integer" + } + }, + { + "name": "month", + "description": "

If specified, only return results for a single month. The value of month is an integer between 1 and 12. Default value is the current month. If no year is specified the default year is used.

", "in": "query", "required": false, "schema": { @@ -297403,9 +298098,45 @@ "type": "integer" } }, + { + "name": "organization", + "description": "

The organization name to query usage for. The name is not case sensitive.

", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "repository", + "description": "

The repository name to query for usage in the format owner/repository.

", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "product", + "description": "

The product name to query usage for. The name is not case sensitive.

", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "sku", + "description": "

The SKU to query for usage.

", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, { "name": "cost_center_id", - "description": "

The ID corresponding to a cost center. The default value is no cost center.

", + "description": "

The ID corresponding to a cost center. An ID of 'none' will target usage not associated to any cost center.

", "in": "query", "required": false, "schema": { @@ -297414,7 +298145,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Gets a report of usage by cost center for an enterprise. To use this endpoint, you must be an administrator or billing manager of the enterprise. By default this endpoint will return usage that does not have a cost center.

\n

Note: This endpoint is only available to enterprises with access to the enhanced billing platform. For more information, see \"About the enhanced billing platform for enterprises.\"

", + "descriptionHTML": "

Note

\n

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

\n
\n

Gets a summary report of usage for an enterprise. To use this endpoint, you must be an administrator or billing manager of the enterprise. By default, this endpoint will return usage across all cost centers in the enterprise.

\n

Note: Only data from the past 24 months is accessible via this endpoint.

", "codeExamples": [ { "key": "default", @@ -297428,36 +298159,92 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "

Response when getting a billing usage report

", + "description": "

Response when getting a billing usage summary report

", "example": { + "timePeriod": { + "year": 2025 + }, + "enterprise": "GitHub", "usageItems": [ { - "date": "2023-08-01", "product": "Actions", - "sku": "Actions Linux", - "quantity": 100, + "sku": "actions_linux", "unitType": "minutes", "pricePerUnit": 0.008, - "grossAmount": 0.8, + "grossQuantity": 1000, + "grossAmount": 8, + "discountQuantity": 0, "discountAmount": 0, - "netAmount": 0.8, - "organizationName": "GitHub", - "repositoryName": "github/example" + "netQuantity": 1000, + "netAmount": 8 } ] }, "schema": { "type": "object", "properties": { + "timePeriod": { + "type": "object", + "properties": { + "year": { + "type": "integer", + "description": "The year for the usage report." + }, + "month": { + "type": "integer", + "description": "The month for the usage report." + }, + "day": { + "type": "integer", + "description": "The day for the usage report." + } + }, + "required": [ + "year" + ] + }, + "enterprise": { + "type": "string", + "description": "The unique identifier of the enterprise." + }, + "organization": { + "type": "string", + "description": "The name of the organization for the usage report." + }, + "repository": { + "type": "string", + "description": "The name of the repository for the usage report." + }, + "product": { + "type": "string", + "description": "The product for the usage report." + }, + "sku": { + "type": "string", + "description": "The SKU for the usage report." + }, + "costCenter": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier of the cost center." + }, + "name": { + "type": "string", + "description": "The name of the cost center." + } + }, + "required": [ + "id", + "name" + ] + }, "usageItems": { "type": "array", "items": { "type": "object", "properties": { - "date": { - "type": "string", - "description": "Date of the usage line item." - }, "product": { "type": "string", "description": "Product name." @@ -297466,10 +298253,6 @@ "type": "string", "description": "SKU name." }, - "quantity": { - "type": "integer", - "description": "Quantity of the usage line item." - }, "unitType": { "type": "string", "description": "Unit type of the usage line item." @@ -297478,42 +298261,51 @@ "type": "number", "description": "Price per unit of the usage line item." }, + "grossQuantity": { + "type": "number", + "description": "Gross quantity of the usage line item." + }, "grossAmount": { "type": "number", "description": "Gross amount of the usage line item." }, + "discountQuantity": { + "type": "number", + "description": "Discount quantity of the usage line item." + }, "discountAmount": { "type": "number", "description": "Discount amount of the usage line item." }, + "netQuantity": { + "type": "number", + "description": "Net quantity of the usage line item." + }, "netAmount": { "type": "number", "description": "Net amount of the usage line item." - }, - "organizationName": { - "type": "string", - "description": "Name of the organization." - }, - "repositoryName": { - "type": "string", - "description": "Name of the repository." } }, "required": [ - "date", "product", "sku", - "quantity", "unitType", "pricePerUnit", + "grossQuantity", "grossAmount", + "discountQuantity", "discountAmount", - "netAmount", - "organizationName" + "netQuantity", + "netAmount" ] } } - } + }, + "required": [ + "timePeriod", + "enterprise", + "usageItems" + ] } } } @@ -297521,7 +298313,7 @@ "statusCodes": [ { "httpStatusCode": "200", - "description": "

Response when getting a billing usage report

" + "description": "

Response when getting a billing usage summary report

" }, { "httpStatusCode": "400", @@ -471564,6 +472356,12 @@ "deleted" ], "default": "active" + }, + { + "type": "string", + "name": "github_repository", + "in": "body", + "description": "

The name of the GitHub repository associated with the artifact. This should be used\nwhen there are no provenance attestations available for the artifact. The repository\nmust belong to the organization specified in the path parameter.

\n

If a provenance attestation is available for the artifact, the API will use\nthe repository information from the attestation instead of this parameter.

" } ], "descriptionHTML": "

Create metadata storage records for artifacts associated with an organization.\nThis endpoint will create a new artifact storage record on behalf of any artifact matching the provided digest and\nassociated with a repository owned by the organization.

", @@ -519716,6 +520514,11 @@ ], "type": "string" }, + "url": { + "description": "The URL of the private registry.", + "type": "string", + "format": "uri" + }, "username": { "description": "The username to use when authenticating with the private registry.", "type": [ @@ -519726,6 +520529,11 @@ "monalisa" ] }, + "replaces_base": { + "description": "Whether this private registry replaces the base registry (e.g., npmjs.org for npm, rubygems.org for rubygems). When `true`, Dependabot will only use this registry and will not fall back to the public registry. When `false` (default), Dependabot will use this registry for scoped packages but may fall back to the public registry for other packages.", + "type": "boolean", + "default": false + }, "visibility": { "description": "Which type of organization repositories have access to the private registry.", "enum": [ @@ -519840,6 +520648,13 @@ "in": "body", "description": "

The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication.

" }, + { + "type": "boolean", + "name": "replaces_base", + "in": "body", + "description": "

Whether this private registry should replace the base registry (e.g., npmjs.org for npm, rubygems.org for rubygems). When set to true, Dependabot will only use this registry and will not fall back to the public registry. When set to false (default), Dependabot will use this registry for scoped packages but may fall back to the public registry for other packages.

", + "default": false + }, { "type": "string", "name": "encrypted_value", @@ -519885,6 +520700,7 @@ "registry_type": "maven_repository", "url": "https://maven.pkg.github.com/organization/", "username": "monalisa", + "replaces_base": true, "encrypted_value": "c2VjcmV0", "key_id": "012345678912345678", "visibility": "private" @@ -519942,6 +520758,11 @@ ], "type": "string" }, + "url": { + "description": "The URL of the private registry.", + "type": "string", + "format": "uri" + }, "username": { "description": "The username to use when authenticating with the private registry.", "type": "string", @@ -519949,6 +520770,11 @@ "monalisa" ] }, + "replaces_base": { + "description": "Whether this private registry replaces the base registry (e.g., npmjs.org for npm, rubygems.org for rubygems). When `true`, Dependabot will only use this registry and will not fall back to the public registry. When `false` (default), Dependabot will use this registry for scoped packages but may fall back to the public registry for other packages.", + "type": "boolean", + "default": false + }, "visibility": { "description": "Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access the private registry.", "enum": [ @@ -520051,6 +520877,11 @@ ], "type": "string" }, + "url": { + "description": "The URL of the private registry.", + "type": "string", + "format": "uri" + }, "username": { "description": "The username to use when authenticating with the private registry.", "type": "string", @@ -520058,6 +520889,11 @@ "monalisa" ] }, + "replaces_base": { + "description": "Whether this private registry replaces the base registry (e.g., npmjs.org for npm, rubygems.org for rubygems). When `true`, Dependabot will only use this registry and will not fall back to the public registry. When `false` (default), Dependabot will use this registry for scoped packages but may fall back to the public registry for other packages.", + "type": "boolean", + "default": false + }, "visibility": { "description": "Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access the private registry.", "enum": [ @@ -520291,6 +521127,11 @@ ], "type": "string" }, + "url": { + "description": "The URL of the private registry.", + "type": "string", + "format": "uri" + }, "username": { "description": "The username to use when authenticating with the private registry.", "type": [ @@ -520301,6 +521142,11 @@ "monalisa" ] }, + "replaces_base": { + "description": "Whether this private registry replaces the base registry (e.g., npmjs.org for npm, rubygems.org for rubygems). When `true`, Dependabot will only use this registry and will not fall back to the public registry. When `false` (default), Dependabot will use this registry for scoped packages but may fall back to the public registry for other packages.", + "type": "boolean", + "default": false + }, "visibility": { "description": "Which type of organization repositories have access to the private registry.", "enum": [ @@ -520415,6 +521261,13 @@ "in": "body", "description": "

The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication.

" }, + { + "type": "boolean", + "name": "replaces_base", + "in": "body", + "description": "

Whether this private registry should replace the base registry (e.g., npmjs.org for npm, rubygems.org for rubygems). When set to true, Dependabot will only use this registry and will not fall back to the public registry. When set to false (default), Dependabot will use this registry for scoped packages but may fall back to the public registry for other packages.

", + "default": false + }, { "type": "string", "name": "encrypted_value", @@ -524848,35 +525701,120 @@ "statusCode": "200", "contentType": "application/json", "description": "

Response

", - "example": { - "id": 12345, - "node_id": "PVTF_lADOABCD1234567890", - "name": "Priority", - "data_type": "single_select", - "project_url": "https://api.github.com/projects/67890", - "options": [ - { - "id": "option_1", - "name": "Low", - "color": "GREEN", - "description": "Low priority items" - }, - { - "id": "option_2", - "name": "Medium", - "color": "YELLOW", - "description": "Medium priority items" + "example": [ + { + "id": 12345, + "node_id": "PVTF_lADOABCD1234567890", + "name": "Priority", + "data_type": "single_select", + "project_url": "https://api.github.com/projects/67890", + "options": [ + { + "id": "option_1", + "name": "Low", + "color": "GREEN", + "description": "Low priority items" + }, + { + "id": "option_2", + "name": "Medium", + "color": "YELLOW", + "description": "Medium priority items" + }, + { + "id": "option_3", + "name": "High", + "color": "RED", + "description": "High priority items" + } + ], + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z" + }, + { + "id": 67891, + "node_id": "PVTF_lADOABCD9876543210", + "name": "Status", + "data_type": "single_select", + "project_url": "https://api.github.com/projects/67890", + "options": [ + { + "id": "option_4", + "name": "Todo", + "color": "GRAY", + "description": "Items to be worked on" + }, + { + "id": "option_5", + "name": "In Progress", + "color": "BLUE", + "description": "Items currently being worked on" + }, + { + "id": "option_6", + "name": "Done", + "color": "GREEN", + "description": "Completed items" + } + ], + "created_at": "2022-04-29T10:30:00Z", + "updated_at": "2022-04-29T10:30:00Z" + }, + { + "id": 24680, + "node_id": "PVTF_lADOABCD2468024680", + "name": "Team notes", + "data_type": "text", + "project_url": "https://api.github.com/projects/67890", + "created_at": "2022-05-15T08:00:00Z", + "updated_at": "2022-05-15T08:00:00Z" + }, + { + "id": 13579, + "node_id": "PVTF_lADOABCD1357913579", + "name": "Story points", + "data_type": "number", + "project_url": "https://api.github.com/projects/67890", + "created_at": "2022-06-01T14:30:00Z", + "updated_at": "2022-06-01T14:30:00Z" + }, + { + "id": 98765, + "node_id": "PVTF_lADOABCD9876598765", + "name": "Due date", + "data_type": "date", + "project_url": "https://api.github.com/projects/67890", + "created_at": "2022-06-10T09:15:00Z", + "updated_at": "2022-06-10T09:15:00Z" + }, + { + "id": 11223, + "node_id": "PVTF_lADOABCD1122311223", + "name": "Sprint", + "data_type": "iteration", + "project_url": "https://api.github.com/projects/67890", + "configuration": { + "duration": 14, + "start_day": 1, + "iterations": [ + { + "id": "iter_1", + "title": "Sprint 1", + "start_date": "2022-07-01", + "duration": 14 + }, + { + "id": "iter_2", + "title": "Sprint 2", + "start_date": "2022-07-15", + "duration": 14 + } + ] }, - { - "id": "option_3", - "name": "High", - "color": "RED", - "description": "High priority items" - } - ], - "created_at": "2022-04-28T12:00:00Z", - "updated_at": "2022-04-28T12:00:00Z" - }, + "created_at": "2022-06-20T16:45:00Z", + "updated_at": "2022-06-20T16:45:00Z" + } + ], "schema": { "type": "array", "items": { @@ -525486,35 +526424,120 @@ "statusCode": "200", "contentType": "application/json", "description": "

Response

", - "example": { - "id": 12345, - "node_id": "PVTF_lADOABCD1234567890", - "name": "Priority", - "data_type": "single_select", - "project_url": "https://api.github.com/projects/67890", - "options": [ - { - "id": "option_1", - "name": "Low", - "color": "GREEN", - "description": "Low priority items" - }, - { - "id": "option_2", - "name": "Medium", - "color": "YELLOW", - "description": "Medium priority items" + "example": [ + { + "id": 12345, + "node_id": "PVTF_lADOABCD1234567890", + "name": "Priority", + "data_type": "single_select", + "project_url": "https://api.github.com/projects/67890", + "options": [ + { + "id": "option_1", + "name": "Low", + "color": "GREEN", + "description": "Low priority items" + }, + { + "id": "option_2", + "name": "Medium", + "color": "YELLOW", + "description": "Medium priority items" + }, + { + "id": "option_3", + "name": "High", + "color": "RED", + "description": "High priority items" + } + ], + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z" + }, + { + "id": 67891, + "node_id": "PVTF_lADOABCD9876543210", + "name": "Status", + "data_type": "single_select", + "project_url": "https://api.github.com/projects/67890", + "options": [ + { + "id": "option_4", + "name": "Todo", + "color": "GRAY", + "description": "Items to be worked on" + }, + { + "id": "option_5", + "name": "In Progress", + "color": "BLUE", + "description": "Items currently being worked on" + }, + { + "id": "option_6", + "name": "Done", + "color": "GREEN", + "description": "Completed items" + } + ], + "created_at": "2022-04-29T10:30:00Z", + "updated_at": "2022-04-29T10:30:00Z" + }, + { + "id": 24680, + "node_id": "PVTF_lADOABCD2468024680", + "name": "Team notes", + "data_type": "text", + "project_url": "https://api.github.com/projects/67890", + "created_at": "2022-05-15T08:00:00Z", + "updated_at": "2022-05-15T08:00:00Z" + }, + { + "id": 13579, + "node_id": "PVTF_lADOABCD1357913579", + "name": "Story points", + "data_type": "number", + "project_url": "https://api.github.com/projects/67890", + "created_at": "2022-06-01T14:30:00Z", + "updated_at": "2022-06-01T14:30:00Z" + }, + { + "id": 98765, + "node_id": "PVTF_lADOABCD9876598765", + "name": "Due date", + "data_type": "date", + "project_url": "https://api.github.com/projects/67890", + "created_at": "2022-06-10T09:15:00Z", + "updated_at": "2022-06-10T09:15:00Z" + }, + { + "id": 11223, + "node_id": "PVTF_lADOABCD1122311223", + "name": "Sprint", + "data_type": "iteration", + "project_url": "https://api.github.com/projects/67890", + "configuration": { + "duration": 14, + "start_day": 1, + "iterations": [ + { + "id": "iter_1", + "title": "Sprint 1", + "start_date": "2022-07-01", + "duration": 14 + }, + { + "id": "iter_2", + "title": "Sprint 2", + "start_date": "2022-07-15", + "duration": 14 + } + ] }, - { - "id": "option_3", - "name": "High", - "color": "RED", - "description": "High priority items" - } - ], - "created_at": "2022-04-28T12:00:00Z", - "updated_at": "2022-04-28T12:00:00Z" - }, + "created_at": "2022-06-20T16:45:00Z", + "updated_at": "2022-06-20T16:45:00Z" + } + ], "schema": { "type": "array", "items": { diff --git a/src/rest/data/ghes-3.16-2022-11-28/schema.json b/src/rest/data/ghes-3.16-2022-11-28/schema.json index ab179faedfe0..f73aed8d5c44 100644 --- a/src/rest/data/ghes-3.16-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.16-2022-11-28/schema.json @@ -391719,6 +391719,11 @@ ], "type": "string" }, + "url": { + "description": "The URL of the private registry.", + "type": "string", + "format": "uri" + }, "username": { "description": "The username to use when authenticating with the private registry.", "type": [ @@ -391729,6 +391734,11 @@ "monalisa" ] }, + "replaces_base": { + "description": "Whether this private registry replaces the base registry (e.g., npmjs.org for npm, rubygems.org for rubygems). When `true`, Dependabot will only use this registry and will not fall back to the public registry. When `false` (default), Dependabot will use this registry for scoped packages but may fall back to the public registry for other packages.", + "type": "boolean", + "default": false + }, "visibility": { "description": "Which type of organization repositories have access to the private registry.", "enum": [ @@ -391958,6 +391968,11 @@ ], "type": "string" }, + "url": { + "description": "The URL of the private registry.", + "type": "string", + "format": "uri" + }, "username": { "description": "The username to use when authenticating with the private registry.", "type": [ @@ -391968,6 +391983,11 @@ "monalisa" ] }, + "replaces_base": { + "description": "Whether this private registry replaces the base registry (e.g., npmjs.org for npm, rubygems.org for rubygems). When `true`, Dependabot will only use this registry and will not fall back to the public registry. When `false` (default), Dependabot will use this registry for scoped packages but may fall back to the public registry for other packages.", + "type": "boolean", + "default": false + }, "visibility": { "description": "Which type of organization repositories have access to the private registry.", "enum": [ @@ -392082,6 +392102,13 @@ "in": "body", "description": "

The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication.

" }, + { + "type": "boolean", + "name": "replaces_base", + "in": "body", + "description": "

Whether this private registry should replace the base registry (e.g., npmjs.org for npm, rubygems.org for rubygems). When set to true, Dependabot will only use this registry and will not fall back to the public registry. When set to false (default), Dependabot will use this registry for scoped packages but may fall back to the public registry for other packages.

", + "default": false + }, { "type": "string", "name": "encrypted_value", diff --git a/src/rest/data/ghes-3.17-2022-11-28/schema.json b/src/rest/data/ghes-3.17-2022-11-28/schema.json index 2f841090a47d..eafdb7fe43d7 100644 --- a/src/rest/data/ghes-3.17-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.17-2022-11-28/schema.json @@ -394036,6 +394036,11 @@ ], "type": "string" }, + "url": { + "description": "The URL of the private registry.", + "type": "string", + "format": "uri" + }, "username": { "description": "The username to use when authenticating with the private registry.", "type": [ @@ -394046,6 +394051,11 @@ "monalisa" ] }, + "replaces_base": { + "description": "Whether this private registry replaces the base registry (e.g., npmjs.org for npm, rubygems.org for rubygems). When `true`, Dependabot will only use this registry and will not fall back to the public registry. When `false` (default), Dependabot will use this registry for scoped packages but may fall back to the public registry for other packages.", + "type": "boolean", + "default": false + }, "visibility": { "description": "Which type of organization repositories have access to the private registry.", "enum": [ @@ -394275,6 +394285,11 @@ ], "type": "string" }, + "url": { + "description": "The URL of the private registry.", + "type": "string", + "format": "uri" + }, "username": { "description": "The username to use when authenticating with the private registry.", "type": [ @@ -394285,6 +394300,11 @@ "monalisa" ] }, + "replaces_base": { + "description": "Whether this private registry replaces the base registry (e.g., npmjs.org for npm, rubygems.org for rubygems). When `true`, Dependabot will only use this registry and will not fall back to the public registry. When `false` (default), Dependabot will use this registry for scoped packages but may fall back to the public registry for other packages.", + "type": "boolean", + "default": false + }, "visibility": { "description": "Which type of organization repositories have access to the private registry.", "enum": [ @@ -394399,6 +394419,13 @@ "in": "body", "description": "

The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication.

" }, + { + "type": "boolean", + "name": "replaces_base", + "in": "body", + "description": "

Whether this private registry should replace the base registry (e.g., npmjs.org for npm, rubygems.org for rubygems). When set to true, Dependabot will only use this registry and will not fall back to the public registry. When set to false (default), Dependabot will use this registry for scoped packages but may fall back to the public registry for other packages.

", + "default": false + }, { "type": "string", "name": "encrypted_value", diff --git a/src/rest/data/ghes-3.18-2022-11-28/schema.json b/src/rest/data/ghes-3.18-2022-11-28/schema.json index 804e5b0e7e44..4afcf3a02d6c 100644 --- a/src/rest/data/ghes-3.18-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.18-2022-11-28/schema.json @@ -396428,6 +396428,11 @@ ], "type": "string" }, + "url": { + "description": "The URL of the private registry.", + "type": "string", + "format": "uri" + }, "username": { "description": "The username to use when authenticating with the private registry.", "type": [ @@ -396438,6 +396443,11 @@ "monalisa" ] }, + "replaces_base": { + "description": "Whether this private registry replaces the base registry (e.g., npmjs.org for npm, rubygems.org for rubygems). When `true`, Dependabot will only use this registry and will not fall back to the public registry. When `false` (default), Dependabot will use this registry for scoped packages but may fall back to the public registry for other packages.", + "type": "boolean", + "default": false + }, "visibility": { "description": "Which type of organization repositories have access to the private registry.", "enum": [ @@ -396552,6 +396562,13 @@ "in": "body", "description": "

The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication.

" }, + { + "type": "boolean", + "name": "replaces_base", + "in": "body", + "description": "

Whether this private registry should replace the base registry (e.g., npmjs.org for npm, rubygems.org for rubygems). When set to true, Dependabot will only use this registry and will not fall back to the public registry. When set to false (default), Dependabot will use this registry for scoped packages but may fall back to the public registry for other packages.

", + "default": false + }, { "type": "string", "name": "encrypted_value", @@ -396597,6 +396614,7 @@ "registry_type": "maven_repository", "url": "https://maven.pkg.github.com/organization/", "username": "monalisa", + "replaces_base": true, "encrypted_value": "c2VjcmV0", "key_id": "012345678912345678", "visibility": "private" @@ -396654,6 +396672,11 @@ ], "type": "string" }, + "url": { + "description": "The URL of the private registry.", + "type": "string", + "format": "uri" + }, "username": { "description": "The username to use when authenticating with the private registry.", "type": "string", @@ -396661,6 +396684,11 @@ "monalisa" ] }, + "replaces_base": { + "description": "Whether this private registry replaces the base registry (e.g., npmjs.org for npm, rubygems.org for rubygems). When `true`, Dependabot will only use this registry and will not fall back to the public registry. When `false` (default), Dependabot will use this registry for scoped packages but may fall back to the public registry for other packages.", + "type": "boolean", + "default": false + }, "visibility": { "description": "Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access the private registry.", "enum": [ @@ -396763,6 +396791,11 @@ ], "type": "string" }, + "url": { + "description": "The URL of the private registry.", + "type": "string", + "format": "uri" + }, "username": { "description": "The username to use when authenticating with the private registry.", "type": "string", @@ -396770,6 +396803,11 @@ "monalisa" ] }, + "replaces_base": { + "description": "Whether this private registry replaces the base registry (e.g., npmjs.org for npm, rubygems.org for rubygems). When `true`, Dependabot will only use this registry and will not fall back to the public registry. When `false` (default), Dependabot will use this registry for scoped packages but may fall back to the public registry for other packages.", + "type": "boolean", + "default": false + }, "visibility": { "description": "Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access the private registry.", "enum": [ @@ -397003,6 +397041,11 @@ ], "type": "string" }, + "url": { + "description": "The URL of the private registry.", + "type": "string", + "format": "uri" + }, "username": { "description": "The username to use when authenticating with the private registry.", "type": [ @@ -397013,6 +397056,11 @@ "monalisa" ] }, + "replaces_base": { + "description": "Whether this private registry replaces the base registry (e.g., npmjs.org for npm, rubygems.org for rubygems). When `true`, Dependabot will only use this registry and will not fall back to the public registry. When `false` (default), Dependabot will use this registry for scoped packages but may fall back to the public registry for other packages.", + "type": "boolean", + "default": false + }, "visibility": { "description": "Which type of organization repositories have access to the private registry.", "enum": [ @@ -397127,6 +397175,13 @@ "in": "body", "description": "

The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication.

" }, + { + "type": "boolean", + "name": "replaces_base", + "in": "body", + "description": "

Whether this private registry should replace the base registry (e.g., npmjs.org for npm, rubygems.org for rubygems). When set to true, Dependabot will only use this registry and will not fall back to the public registry. When set to false (default), Dependabot will use this registry for scoped packages but may fall back to the public registry for other packages.

", + "default": false + }, { "type": "string", "name": "encrypted_value", diff --git a/src/rest/lib/config.json b/src/rest/lib/config.json index c1484df86555..9295543d0d93 100644 --- a/src/rest/lib/config.json +++ b/src/rest/lib/config.json @@ -47,5 +47,5 @@ ] } }, - "sha": "e8e7ce91c9f7b8171f2cb856842e1d1f930a0837" + "sha": "ebc1fecbcfb4449cc61d45e2608ac765b5b144a0" } \ No newline at end of file diff --git a/src/webhooks/lib/config.json b/src/webhooks/lib/config.json index 37a030df88bd..5f5418275b3d 100644 --- a/src/webhooks/lib/config.json +++ b/src/webhooks/lib/config.json @@ -1,3 +1,3 @@ { - "sha": "e8e7ce91c9f7b8171f2cb856842e1d1f930a0837" + "sha": "ebc1fecbcfb4449cc61d45e2608ac765b5b144a0" } \ No newline at end of file