jprdonnelly/docs
1
0
Fork 0
mirror of synced 2025-12-19 18:10:59 -05:00
Code Issues Projects Releases Wiki Activity

Update OpenAPI Description (#58416)

Browse Source 
Co-authored-by: Sam Browning <106113886+sabrowning1@users.noreply.github.com>
This commit is contained in:
docs-bot
2025-11-10 06:00:40 -08:00
committed by GitHub
parent 166f36f1ca
commit 94aaa96257
17 changed files with 270 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
content/rest/projects/drafts.md Normal file
View File

@@ -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
---
<!-- Content after this section is automatically generated -->

1
content/rest/projects/index.md
View File

@@ -5,6 +5,7 @@ topics:
autogenerated: rest
allowTitleToDifferFromFilename: true
children:
- /drafts
- /fields
- /items
- /projects

9
src/github-apps/data/fpt-2022-11-28/fine-grained-pat-permissions.json
View File

@@ -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",

6
src/github-apps/data/fpt-2022-11-28/fine-grained-pat.json
View File

@@ -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",

11
src/github-apps/data/fpt-2022-11-28/server-to-server-permissions.json
View File

@@ -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",

6
src/github-apps/data/fpt-2022-11-28/server-to-server-rest.json
View File

@@ -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",

6
src/github-apps/data/fpt-2022-11-28/user-to-server-rest.json
View File

@@ -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",

9
src/github-apps/data/ghec-2022-11-28/fine-grained-pat-permissions.json
View File

@@ -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",

6
src/github-apps/data/ghec-2022-11-28/fine-grained-pat.json
View File

@@ -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",

11
src/github-apps/data/ghec-2022-11-28/server-to-server-permissions.json
View File

@@ -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",

6
src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json
View File

@@ -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",

6
src/github-apps/data/ghec-2022-11-28/user-to-server-rest.json
View File

@@ -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",

2
src/github-apps/lib/config.json
View File

@@ -60,5 +60,5 @@
"2022-11-28"
]
},
"sha": "76075d48c896654c8e9e122ee1e162ccc546ace1"
"sha": "0fb9cbe3fd548654115fbe4d8beb758228826ae6"
}

88
src/rest/data/fpt-2022-11-28/schema.json
View File

@@ -427847,6 +427847,12 @@
"description": "<p>The digest of the artifact (algorithm:hex-encoded-digest).</p>",
"isRequired": true
},
{
"type": "string",
"name": "version",
"in": "body",
"description": "<p>The artifact version.</p>"
},
{
"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": "<p>The organization name. The name is not case sensitive.</p>",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project_number",
"description": "<p>The project's number.</p>",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"bodyParameters": [
{
"type": "string",
"name": "title",
"in": "body",
"description": "<p>The title of the draft issue item to create in the project.</p>",
"isRequired": true
},
{
"type": "string",
"name": "body",
"in": "body",
"description": "<p>The body content of the draft issue item to create in the project.</p>"
}
],
"descriptionHTML": "<p>Create draft issue item for the specified organization owned project.</p>",
"codeExamples": [],
"statusCodes": [
{
"httpStatusCode": "201",
"description": "<p>Created</p>"
},
{
"httpStatusCode": "304",
"description": "<p>Not modified</p>"
},
{
"httpStatusCode": "401",
"description": "<p>Requires authentication</p>"
},
{
"httpStatusCode": "403",
"description": "<p>Forbidden</p>"
}
],
"previews": [],
"progAccess": {
"userToServerRest": true,
"serverToServer": true,
"fineGrainedPat": true,
"permissions": [
{
"\"Projects\" organization permissions": "write"
}
],
"allowsPublicRead": true
}
}
],
"fields": [
{
"serverUrl": "https://api.github.com",

96
src/rest/data/ghec-2022-11-28/schema.json
View File

@@ -265715,7 +265715,7 @@
}
],
"bodyParameters": [],
"descriptionHTML": "<p>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.</p>\n<p>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.</p>\n<p>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.</p>\n<p>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 <code>manage_billing:copilot</code> or <code>read:enterprise</code> scopes to use this endpoint.</p>",
"descriptionHTML": "<p>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.</p>\n<p>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.</p>\n<p>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.</p>\n<p>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 <code>manage_billing:copilot</code> or <code>read:enterprise</code> scopes to use this endpoint.</p>",
"codeExamples": [
{
"key": "default",
@@ -265813,7 +265813,7 @@
}
],
"bodyParameters": [],
"descriptionHTML": "<p>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.</p>\n<p>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.</p>\n<p>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.</p>\n<p>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 <code>manage_billing:copilot</code> or <code>read:enterprise</code> scopes to use this endpoint.</p>",
"descriptionHTML": "<p>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.</p>\n<p>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.</p>\n<p>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.</p>\n<p>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 <code>manage_billing:copilot</code> or <code>read:enterprise</code> scopes to use this endpoint.</p>",
"codeExamples": [
{
"key": "default",
@@ -265931,7 +265931,7 @@
}
],
"bodyParameters": [],
"descriptionHTML": "<p>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.</p>\n<p>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.</p>\n<p>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.</p>\n<p>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 <code>manage_billing:copilot</code> or <code>read:enterprise</code> scopes to use this endpoint.</p>",
"descriptionHTML": "<p>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.</p>\n<p>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.</p>\n<p>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.</p>\n<p>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 <code>manage_billing:copilot</code> or <code>read:enterprise</code> scopes to use this endpoint.</p>",
"codeExamples": [
{
"key": "default",
@@ -266029,7 +266029,7 @@
}
],
"bodyParameters": [],
"descriptionHTML": "<p>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.</p>\n<p>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.</p>\n<p>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.</p>\n<p>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 <code>manage_billing:copilot</code> or <code>read:enterprise</code> scopes to use this endpoint.</p>",
"descriptionHTML": "<p>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.</p>\n<p>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.</p>\n<p>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.</p>\n<p>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 <code>manage_billing:copilot</code> or <code>read:enterprise</code> scopes to use this endpoint.</p>",
"codeExamples": [
{
"key": "default",
@@ -474121,6 +474121,12 @@
"description": "<p>The digest of the artifact (algorithm:hex-encoded-digest).</p>",
"isRequired": true
},
{
"type": "string",
"name": "version",
"in": "body",
"description": "<p>The artifact version.</p>"
},
{
"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": "<p>The organization name. The name is not case sensitive.</p>",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project_number",
"description": "<p>The project's number.</p>",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"bodyParameters": [
{
"type": "string",
"name": "title",
"in": "body",
"description": "<p>The title of the draft issue item to create in the project.</p>",
"isRequired": true
},
{
"type": "string",
"name": "body",
"in": "body",
"description": "<p>The body content of the draft issue item to create in the project.</p>"
}
],
"descriptionHTML": "<p>Create draft issue item for the specified organization owned project.</p>",
"codeExamples": [],
"statusCodes": [
{
"httpStatusCode": "201",
"description": "<p>Created</p>"
},
{
"httpStatusCode": "304",
"description": "<p>Not modified</p>"
},
{
"httpStatusCode": "401",
"description": "<p>Requires authentication</p>"
},
{
"httpStatusCode": "403",
"description": "<p>Forbidden</p>"
}
],
"previews": [],
"progAccess": {
"userToServerRest": true,
"serverToServer": true,
"fineGrainedPat": true,
"permissions": [
{
"\"Projects\" organization permissions": "write"
}
],
"allowsPublicRead": true
}
}
],
"fields": [
{
"serverUrl": "https://api.github.com",

2
src/rest/lib/config.json
View File

@@ -47,5 +47,5 @@
]
}
},
"sha": "76075d48c896654c8e9e122ee1e162ccc546ace1"
"sha": "0fb9cbe3fd548654115fbe4d8beb758228826ae6"
}

2
src/webhooks/lib/config.json
View File

@@ -1,3 +1,3 @@
{
"sha": "76075d48c896654c8e9e122ee1e162ccc546ace1"
"sha": "0fb9cbe3fd548654115fbe4d8beb758228826ae6"
}