diff --git a/content/rest/projects/drafts.md b/content/rest/projects/drafts.md new file mode 100644 index 0000000000..b32038d179 --- /dev/null +++ b/content/rest/projects/drafts.md @@ -0,0 +1,14 @@ +--- +title: REST API endpoints for draft Project items +shortTitle: Draft Project items +intro: Use the REST API to manage draft items in Projects. +versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖 + fpt: '*' + ghec: '*' +topics: + - API +autogenerated: rest +allowTitleToDifferFromFilename: true +--- + + diff --git a/content/rest/projects/index.md b/content/rest/projects/index.md index fa72cfcbe8..4e1ce1be5a 100644 --- a/content/rest/projects/index.md +++ b/content/rest/projects/index.md @@ -5,6 +5,7 @@ topics: autogenerated: rest allowTitleToDifferFromFilename: true children: + - /drafts - /fields - /items - /projects 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 5033132bc6..ccc55ddad0 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 @@ -2325,6 +2325,15 @@ "additional-permissions": false, "access": "read" }, + { + "category": "projects", + "slug": "create-draft-item-for-organization-owned-project", + "subcategory": "drafts", + "verb": "post", + "requestPath": "/orgs/{org}/projectsV2/{project_number}/drafts", + "additional-permissions": false, + "access": "write" + }, { "category": "projects", "slug": "list-project-fields-for-organization", 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 755fb4a573..037f4dcbf9 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 @@ -3790,6 +3790,12 @@ "verb": "get", "requestPath": "/orgs/{org}/projectsV2/{project_number}" }, + { + "slug": "create-draft-item-for-organization-owned-project", + "subcategory": "drafts", + "verb": "post", + "requestPath": "/orgs/{org}/projectsV2/{project_number}/drafts" + }, { "slug": "list-project-fields-for-organization", "subcategory": "fields", 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 90bc275816..4f06e68371 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 @@ -2917,6 +2917,17 @@ "server-to-server": true, "additional-permissions": false }, + { + "category": "projects", + "slug": "create-draft-item-for-organization-owned-project", + "subcategory": "drafts", + "verb": "post", + "requestPath": "/orgs/{org}/projectsV2/{project_number}/drafts", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, { "category": "projects", "slug": "list-project-fields-for-organization", 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 6621cea1b2..a6a9cc2229 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 @@ -3886,6 +3886,12 @@ "verb": "get", "requestPath": "/orgs/{org}/projectsV2/{project_number}" }, + { + "slug": "create-draft-item-for-organization-owned-project", + "subcategory": "drafts", + "verb": "post", + "requestPath": "/orgs/{org}/projectsV2/{project_number}/drafts" + }, { "slug": "list-project-fields-for-organization", "subcategory": "fields", 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 6dd07139ba..aea4ed8851 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 @@ -4366,6 +4366,12 @@ "verb": "get", "requestPath": "/orgs/{org}/projectsV2/{project_number}" }, + { + "slug": "create-draft-item-for-organization-owned-project", + "subcategory": "drafts", + "verb": "post", + "requestPath": "/orgs/{org}/projectsV2/{project_number}/drafts" + }, { "slug": "list-project-fields-for-organization", "subcategory": "fields", 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 4fb3219f6d..681d336bfb 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 @@ -2946,6 +2946,15 @@ "additional-permissions": false, "access": "read" }, + { + "category": "projects", + "slug": "create-draft-item-for-organization-owned-project", + "subcategory": "drafts", + "verb": "post", + "requestPath": "/orgs/{org}/projectsV2/{project_number}/drafts", + "additional-permissions": false, + "access": "write" + }, { "category": "projects", "slug": "list-project-fields-for-organization", 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 cf30feebc9..d373162dce 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 @@ -4064,6 +4064,12 @@ "verb": "get", "requestPath": "/orgs/{org}/projectsV2/{project_number}" }, + { + "slug": "create-draft-item-for-organization-owned-project", + "subcategory": "drafts", + "verb": "post", + "requestPath": "/orgs/{org}/projectsV2/{project_number}/drafts" + }, { "slug": "list-project-fields-for-organization", "subcategory": "fields", 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 f639905e55..a390c19196 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 @@ -4171,6 +4171,17 @@ "server-to-server": true, "additional-permissions": false }, + { + "category": "projects", + "slug": "create-draft-item-for-organization-owned-project", + "subcategory": "drafts", + "verb": "post", + "requestPath": "/orgs/{org}/projectsV2/{project_number}/drafts", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, { "category": "projects", "slug": "list-project-fields-for-organization", 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 9770f9b67a..911c3d577b 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 @@ -4430,6 +4430,12 @@ "verb": "get", "requestPath": "/orgs/{org}/projectsV2/{project_number}" }, + { + "slug": "create-draft-item-for-organization-owned-project", + "subcategory": "drafts", + "verb": "post", + "requestPath": "/orgs/{org}/projectsV2/{project_number}/drafts" + }, { "slug": "list-project-fields-for-organization", "subcategory": "fields", 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 0776b01ba4..f18b9c9842 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 @@ -4910,6 +4910,12 @@ "verb": "get", "requestPath": "/orgs/{org}/projectsV2/{project_number}" }, + { + "slug": "create-draft-item-for-organization-owned-project", + "subcategory": "drafts", + "verb": "post", + "requestPath": "/orgs/{org}/projectsV2/{project_number}/drafts" + }, { "slug": "list-project-fields-for-organization", "subcategory": "fields", diff --git a/src/github-apps/lib/config.json b/src/github-apps/lib/config.json index 5ff5c141d9..a17875fb5c 100644 --- a/src/github-apps/lib/config.json +++ b/src/github-apps/lib/config.json @@ -60,5 +60,5 @@ "2022-11-28" ] }, - "sha": "76075d48c896654c8e9e122ee1e162ccc546ace1" + "sha": "0fb9cbe3fd548654115fbe4d8beb758228826ae6" } \ 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 cf1efd70a9..c73760af1a 100644 --- a/src/rest/data/fpt-2022-11-28/schema.json +++ b/src/rest/data/fpt-2022-11-28/schema.json @@ -427847,6 +427847,12 @@ "description": "

The digest of the artifact (algorithm:hex-encoded-digest).

", "isRequired": true }, + { + "type": "string", + "name": "version", + "in": "body", + "description": "

The artifact version.

" + }, { "type": "string", "name": "artifact_url", @@ -427900,7 +427906,8 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { - "name": "libfoo-1.2.3", + "name": "libfoo", + "version": "1.2.3", "digest": "sha256:1bb1e949e55dcefc6353e7b36c8897d2a107d8e8dca49d4e3c0ea8493fc0bc72", "artifact_url": "https://reg.example.com/artifactory/bar/libfoo-1.2.3", "registry_url": "https://reg.example.com/artifactory/", @@ -427919,7 +427926,7 @@ "total_count": 1, "storage_records": [ { - "name": "libfoo-1.2.3", + "name": "libfoo", "digest": "sha256:1bb1e949e55dcefc6353e7b36c8897d2a107d8e8dca49d4e3c0ea8493fc0bc72", "artifact_url": "https://reg.example.com/artifactory/bar/libfoo-1.2.3", "registry_url": "https://reg.example.com/artifactory/", @@ -476545,6 +476552,83 @@ } } ], + "drafts": [ + { + "serverUrl": "https://api.github.com", + "verb": "post", + "requestPath": "/orgs/{org}/projectsV2/{project_number}/drafts", + "title": "Create draft item for organization owned project", + "category": "projects", + "subcategory": "drafts", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

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

The project's number.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "title", + "in": "body", + "description": "

The title of the draft issue item to create in the project.

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

The body content of the draft issue item to create in the project.

" + } + ], + "descriptionHTML": "

Create draft issue item for the specified organization owned project.

", + "codeExamples": [], + "statusCodes": [ + { + "httpStatusCode": "201", + "description": "

Created

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

Not modified

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

Requires authentication

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

Forbidden

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" organization permissions": "write" + } + ], + "allowsPublicRead": true + } + } + ], "fields": [ { "serverUrl": "https://api.github.com", diff --git a/src/rest/data/ghec-2022-11-28/schema.json b/src/rest/data/ghec-2022-11-28/schema.json index 12c770ae48..e74d8046a5 100644 --- a/src/rest/data/ghec-2022-11-28/schema.json +++ b/src/rest/data/ghec-2022-11-28/schema.json @@ -265715,7 +265715,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Use this endpoint to retrieve download links for the Copilot enterprise usage metrics report for a specific day. The report provides comprehensive usage data for Copilot features across the enterprise.

\n

The report contains aggregated metrics for the specified day, including usage statistics for various Copilot features, user engagement data, and feature adoption metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time.

\n

The response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed. Reports are available starting from October 10, 2025, and historical data can be accessed for up to 1 year from the current date.

\n

Only enterprise owners and billing managers can retrieve Copilot metrics reports for the enterprise. OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or read:enterprise scopes to use this endpoint.

", + "descriptionHTML": "

Use this endpoint to retrieve download links for the Copilot enterprise usage metrics report for a specific day. The report provides comprehensive usage data for Copilot features across the enterprise.

\n

The report contains aggregated metrics for the specified day, including usage statistics for various Copilot features, user engagement data, and feature adoption metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time.

\n

The response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed. Reports are available starting from October 10, 2025, and historical data can be accessed for up to 1 year from the current date.

\n

Enterprise owners, billing managers, and authorized users with fine-grained \"View Enterprise Copilot Metrics\" permission can retrieve Copilot metrics reports for the enterprise. OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or read:enterprise scopes to use this endpoint.

", "codeExamples": [ { "key": "default", @@ -265813,7 +265813,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Use this endpoint to retrieve download links for the latest 28-day enterprise Copilot usage metrics report. The report provides comprehensive usage data for Copilot features across the enterprise.

\n

The report contains aggregated metrics for the previous 28 days, including usage statistics for various Copilot features, user engagement data, and feature adoption metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time.

\n

The response includes download links to the report files, along with the specific date range covered by the report. The report covers a complete 28-day period ending on the most recent day for which data has been processed.

\n

Only enterprise owners and billing managers can retrieve Copilot metrics reports for the enterprise. OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or read:enterprise scopes to use this endpoint.

", + "descriptionHTML": "

Use this endpoint to retrieve download links for the latest 28-day enterprise Copilot usage metrics report. The report provides comprehensive usage data for Copilot features across the enterprise.

\n

The report contains aggregated metrics for the previous 28 days, including usage statistics for various Copilot features, user engagement data, and feature adoption metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time.

\n

The response includes download links to the report files, along with the specific date range covered by the report. The report covers a complete 28-day period ending on the most recent day for which data has been processed.

\n

Enterprise owners, billing managers, and authorized users with fine-grained \"View Enterprise Copilot Metrics\" permission can retrieve Copilot metrics reports for the enterprise. OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or read:enterprise scopes to use this endpoint.

", "codeExamples": [ { "key": "default", @@ -265931,7 +265931,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Use this endpoint to retrieve download links for the Copilot user usage metrics report for a specific day. The report provides detailed user-level usage data and engagement metrics for Copilot features across the enterprise.

\n

The report contains user-specific metrics for the specified day, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows enterprise administrators to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement.

\n

Reports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed. Reports are available starting from October 10, 2025, and historical data can be accessed for up to 1 year from the current date.

\n

Only enterprise owners and billing managers can retrieve Copilot user metrics reports for the enterprise. OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or read:enterprise scopes to use this endpoint.

", + "descriptionHTML": "

Use this endpoint to retrieve download links for the Copilot user usage metrics report for a specific day. The report provides detailed user-level usage data and engagement metrics for Copilot features across the enterprise.

\n

The report contains user-specific metrics for the specified day, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows authorized users to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement.

\n

Reports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed. Reports are available starting from October 10, 2025, and historical data can be accessed for up to 1 year from the current date.

\n

Enterprise owners, billing managers, and authorized users with fine-grained \"View Enterprise Copilot Metrics\" permission can retrieve Copilot metrics reports for the enterprise. OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or read:enterprise scopes to use this endpoint.

", "codeExamples": [ { "key": "default", @@ -266029,7 +266029,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Use this endpoint to retrieve download links for the latest 28-day enterprise users Copilot usage metrics report. The report provides detailed user-level usage data and engagement metrics for Copilot features across the enterprise.

\n

The report contains user-specific metrics for the previous 28 days, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows enterprise administrators to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement.

\n

Reports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date range covered by the report. The report covers a complete 28-day period ending on the most recent day for which data has been processed.

\n

Only enterprise owners and billing managers can retrieve Copilot users metrics reports for the enterprise. OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or read:enterprise scopes to use this endpoint.

", + "descriptionHTML": "

Use this endpoint to retrieve download links for the latest 28-day enterprise users Copilot usage metrics report. The report provides detailed user-level usage data and engagement metrics for Copilot features across the enterprise.

\n

The report contains user-specific metrics for the previous 28 days, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows authorized users to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement.

\n

Reports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date range covered by the report. The report covers a complete 28-day period ending on the most recent day for which data has been processed.

\n

Enterprise owners, billing managers, and authorized users with fine-grained \"View Enterprise Copilot Metrics\" permission can retrieve Copilot metrics reports for the enterprise. OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or read:enterprise scopes to use this endpoint.

", "codeExamples": [ { "key": "default", @@ -474121,6 +474121,12 @@ "description": "

The digest of the artifact (algorithm:hex-encoded-digest).

", "isRequired": true }, + { + "type": "string", + "name": "version", + "in": "body", + "description": "

The artifact version.

" + }, { "type": "string", "name": "artifact_url", @@ -474174,7 +474180,8 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { - "name": "libfoo-1.2.3", + "name": "libfoo", + "version": "1.2.3", "digest": "sha256:1bb1e949e55dcefc6353e7b36c8897d2a107d8e8dca49d4e3c0ea8493fc0bc72", "artifact_url": "https://reg.example.com/artifactory/bar/libfoo-1.2.3", "registry_url": "https://reg.example.com/artifactory/", @@ -474193,7 +474200,7 @@ "total_count": 1, "storage_records": [ { - "name": "libfoo-1.2.3", + "name": "libfoo", "digest": "sha256:1bb1e949e55dcefc6353e7b36c8897d2a107d8e8dca49d4e3c0ea8493fc0bc72", "artifact_url": "https://reg.example.com/artifactory/bar/libfoo-1.2.3", "registry_url": "https://reg.example.com/artifactory/", @@ -527430,6 +527437,83 @@ } } ], + "drafts": [ + { + "serverUrl": "https://api.github.com", + "verb": "post", + "requestPath": "/orgs/{org}/projectsV2/{project_number}/drafts", + "title": "Create draft item for organization owned project", + "category": "projects", + "subcategory": "drafts", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

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

The project's number.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "title", + "in": "body", + "description": "

The title of the draft issue item to create in the project.

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

The body content of the draft issue item to create in the project.

" + } + ], + "descriptionHTML": "

Create draft issue item for the specified organization owned project.

", + "codeExamples": [], + "statusCodes": [ + { + "httpStatusCode": "201", + "description": "

Created

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

Not modified

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

Requires authentication

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

Forbidden

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" organization permissions": "write" + } + ], + "allowsPublicRead": true + } + } + ], "fields": [ { "serverUrl": "https://api.github.com", diff --git a/src/rest/lib/config.json b/src/rest/lib/config.json index 5c0a986a2f..367099fda3 100644 --- a/src/rest/lib/config.json +++ b/src/rest/lib/config.json @@ -47,5 +47,5 @@ ] } }, - "sha": "76075d48c896654c8e9e122ee1e162ccc546ace1" + "sha": "0fb9cbe3fd548654115fbe4d8beb758228826ae6" } \ No newline at end of file diff --git a/src/webhooks/lib/config.json b/src/webhooks/lib/config.json index 900e7b1ece..8c4d98cec5 100644 --- a/src/webhooks/lib/config.json +++ b/src/webhooks/lib/config.json @@ -1,3 +1,3 @@ { - "sha": "76075d48c896654c8e9e122ee1e162ccc546ace1" + "sha": "0fb9cbe3fd548654115fbe4d8beb758228826ae6" } \ No newline at end of file