Update OpenAPI Description (#60633)

Co-authored-by: Sunbrye Ly <56200261+sunbrye@users.noreply.github.com>

Author: docs-bot

src/github-apps/lib/config.json

@@ -60,5 +60,5 @@
       "2022-11-28"
     ]
   },
-  "sha": "c8a7d24eac4f40d797db33e85d5aa1480b163c27"
+  "sha": "758e5523c8b6082bdd547cef042b884229a0355c"
 }

src/rest/data/fpt-2022-11-28/agent-tasks.json

@@ -85,9 +85,10 @@
           "name": "is_archived",
           "in": "query",
           "schema": {
-            "type": "boolean"
+            "type": "boolean",
+            "default": false
           },
-          "description": "<p>Filter by archived status. When <code>true</code>, returns only archived tasks. When <code>false</code>, returns only non-archived tasks.</p>"
+          "description": "<p>Filter by archived status. When <code>true</code>, returns only archived tasks. When <code>false</code> or omitted, returns only non-archived tasks. Defaults to <code>false</code>.</p>"
         },
         {
           "name": "since",
@@ -108,7 +109,7 @@
         }
       ],
       "bodyParameters": [],
-      "descriptionHTML": "<p>Returns a list of tasks for a specific repository</p>",
+      "descriptionHTML": "<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nThis endpoint is in public preview and is subject to change.</p>\n</div>\n<p>Returns a list of tasks for a specific repository</p>",
       "codeExamples": [
         {
           "request": {
@@ -451,7 +452,7 @@
         {
           "type": "string",
           "name": "model",
-          "description": "<p>Model identifier</p>"
+          "description": "<p>The model to use for this task. The allowed models may change over time and depend on the user's GitHub Copilot plan and organization policies. Currently supported values: <code>claude-sonnet-4.6</code>, <code>claude-opus-4.6</code>, <code>gpt-5.2-codex</code>, <code>gpt-5.3-codex</code>, <code>gpt-5.4</code>, <code>claude-sonnet-4.5</code>, <code>claude-opus-4.5</code></p>"
         },
         {
           "type": "string",
@@ -467,24 +468,9 @@
           "type": "string",
           "name": "base_ref",
           "description": "<p>Base ref for new branch/PR</p>"
-        },
-        {
-          "type": "string",
-          "name": "event_type",
-          "description": "<p>Type of event</p>"
-        },
-        {
-          "type": "string",
-          "name": "event_url",
-          "description": "<p>URL of the triggering event</p>"
-        },
-        {
-          "type": "array of strings",
-          "name": "event_identifiers",
-          "description": "<p>Identifiers for tracking</p>"
         }
       ],
-      "descriptionHTML": "<p>Creates a new task for a repository</p>",
+      "descriptionHTML": "<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nThis endpoint is in public preview and is subject to change.</p>\n</div>\n<p>Creates a new task for a repository</p>",
       "codeExamples": [
         {
           "request": {
@@ -784,7 +770,7 @@
         }
       ],
       "bodyParameters": [],
-      "descriptionHTML": "<p>Returns a task by ID scoped to an owner/repo path</p>",
+      "descriptionHTML": "<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nThis endpoint is in public preview and is subject to change.</p>\n</div>\n<p>Returns a task by ID scoped to an owner/repo path</p>",
       "codeExamples": [
         {
           "request": {
@@ -1325,9 +1311,10 @@
           "name": "is_archived",
           "in": "query",
           "schema": {
-            "type": "boolean"
+            "type": "boolean",
+            "default": false
           },
-          "description": "<p>Filter by archived status. When <code>true</code>, returns only archived tasks. When <code>false</code>, returns only non-archived tasks.</p>"
+          "description": "<p>Filter by archived status. When <code>true</code>, returns only archived tasks. When <code>false</code> or omitted, returns only non-archived tasks. Defaults to <code>false</code>.</p>"
         },
         {
           "name": "since",
@@ -1340,7 +1327,7 @@
         }
       ],
       "bodyParameters": [],
-      "descriptionHTML": "<p>Returns a list of tasks for the authenticated user</p>",
+      "descriptionHTML": "<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nThis endpoint is in public preview and is subject to change.</p>\n</div>\n<p>Returns a list of tasks for the authenticated user</p>",
       "codeExamples": [
         {
           "request": {
@@ -1645,7 +1632,7 @@
         }
       ],
       "bodyParameters": [],
-      "descriptionHTML": "<p>Returns a task by ID with its associated sessions</p>",
+      "descriptionHTML": "<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nThis endpoint is in public preview and is subject to change.</p>\n</div>\n<p>Returns a task by ID with its associated sessions</p>",
       "codeExamples": [
         {
           "request": {

src/rest/data/fpt-2022-11-28/dependabot.json

@@ -17,6 +17,14 @@
             "type": "string"
           }
         },
+        {
+          "name": "classification",
+          "in": "query",
+          "description": "<p>A comma-separated list of vulnerability classifications. If specified, only alerts for vulnerabilities with these classifications will be returned.</p>\n<p>Can be: <code>malware</code>, <code>general</code></p>",
+          "schema": {
+            "type": "string"
+          }
+        },
         {
           "name": "state",
           "in": "query",
@@ -782,6 +790,15 @@
                           "critical"
                         ]
                       },
+                      "classification": {
+                        "type": "string",
+                        "description": "The classification of the advisory.",
+                        "readOnly": true,
+                        "enum": [
+                          "general",
+                          "malware"
+                        ]
+                      },
                       "cvss": {
                         "type": "object",
                         "description": "Details for the advisory pertaining to the Common Vulnerability Scoring System.",
@@ -1877,6 +1894,14 @@
             "type": "string"
           }
         },
+        {
+          "name": "classification",
+          "in": "query",
+          "description": "<p>A comma-separated list of vulnerability classifications. If specified, only alerts for vulnerabilities with these classifications will be returned.</p>\n<p>Can be: <code>malware</code>, <code>general</code></p>",
+          "schema": {
+            "type": "string"
+          }
+        },
         {
           "name": "state",
           "in": "query",
@@ -2667,6 +2692,15 @@
                           "critical"
                         ]
                       },
+                      "classification": {
+                        "type": "string",
+                        "description": "The classification of the advisory.",
+                        "readOnly": true,
+                        "enum": [
+                          "general",
+                          "malware"
+                        ]
+                      },
                       "cvss": {
                         "type": "object",
                         "description": "Details for the advisory pertaining to the Common Vulnerability Scoring System.",
@@ -3779,6 +3813,14 @@
             "type": "string"
           }
         },
+        {
+          "name": "classification",
+          "in": "query",
+          "description": "<p>A comma-separated list of vulnerability classifications. If specified, only alerts for vulnerabilities with these classifications will be returned.</p>\n<p>Can be: <code>malware</code>, <code>general</code></p>",
+          "schema": {
+            "type": "string"
+          }
+        },
         {
           "name": "state",
           "in": "query",
@@ -4419,6 +4461,15 @@
                           "critical"
                         ]
                       },
+                      "classification": {
+                        "type": "string",
+                        "description": "The classification of the advisory.",
+                        "readOnly": true,
+                        "enum": [
+                          "general",
+                          "malware"
+                        ]
+                      },
                       "cvss": {
                         "type": "object",
                         "description": "Details for the advisory pertaining to the Common Vulnerability Scoring System.",
@@ -5536,6 +5587,15 @@
                         "critical"
                       ]
                     },
+                    "classification": {
+                      "type": "string",
+                      "description": "The classification of the advisory.",
+                      "readOnly": true,
+                      "enum": [
+                        "general",
+                        "malware"
+                      ]
+                    },
                     "cvss": {
                       "type": "object",
                       "description": "Details for the advisory pertaining to the Common Vulnerability Scoring System.",
@@ -6671,6 +6731,15 @@
                         "critical"
                       ]
                     },
+                    "classification": {
+                      "type": "string",
+                      "description": "The classification of the advisory.",
+                      "readOnly": true,
+                      "enum": [
+                        "general",
+                        "malware"
+                      ]
+                    },
                     "cvss": {
                       "type": "object",
                       "description": "Details for the advisory pertaining to the Common Vulnerability Scoring System.",

src/rest/data/fpt-2022-11-28/search.json

@@ -63,7 +63,7 @@
         }
       ],
       "bodyParameters": [],
-      "descriptionHTML": "<p>Searches for query terms inside of a file. This method returns up to 100 results <a href=\"https://docs.github.com/rest/guides/using-pagination-in-the-rest-api\">per page</a>.</p>\n<p>When searching for code, you can get text match metadata for the file <strong>content</strong> and file <strong>path</strong> fields when you pass the <code>text-match</code> media type. For more details about how to receive highlighted search results, see <a href=\"https://docs.github.com/rest/search/search#text-match-metadata\">Text match metadata</a>.</p>\n<p>For example, if you want to find the definition of the <code>addClass</code> function inside <a href=\"https://github.com/jquery/jquery\">jQuery</a> repository, your query would look something like this:</p>\n<p><code>q=addClass+in:file+language:js+repo:jquery/jquery</code></p>\n<p>This query searches for the keyword <code>addClass</code> within a file's contents. The query limits the search to files where the language is JavaScript in the <code>jquery/jquery</code> repository.</p>\n<p>Considerations for code search:</p>\n<p>Due to the complexity of searching code, there are a few restrictions on how searches are performed:</p>\n<ul>\n<li>Only the <em>default branch</em> is considered. In most cases, this will be the <code>master</code> branch.</li>\n<li>Only files smaller than 384 KB are searchable.</li>\n<li>You must always include at least one search term when searching source code. For example, searching for <a href=\"https://github.com/search?utf8=%E2%9C%93&#x26;q=language%3Ago&#x26;type=Code\"><code>language:go</code></a> is not valid, while <a href=\"https://github.com/search?utf8=%E2%9C%93&#x26;q=amazing+language%3Ago&#x26;type=Code\"><code>amazing language:go</code></a> is.</li>\n</ul>\n<p>This endpoint requires you to authenticate and limits you to 10 requests per minute.</p>",
+      "descriptionHTML": "<p>Searches for query terms inside of a file. This method returns up to 100 results <a href=\"https://docs.github.com/rest/guides/using-pagination-in-the-rest-api\">per page</a>.</p>\n<p>When searching for code, you can get text match metadata for the file <strong>content</strong> and file <strong>path</strong> fields when you pass the <code>text-match</code> media type. For more details about how to receive highlighted search results, see <a href=\"https://docs.github.com/rest/search/search#text-match-metadata\">Text match metadata</a>.</p>\n<p>For example, if you want to find the definition of the <code>addClass</code> function inside <a href=\"https://github.com/jquery/jquery\">jQuery</a> repository, your query would look something like this:</p>\n<p><code>q=addClass+in:file+language:js+repo:jquery/jquery</code></p>\n<p>This query searches for the keyword <code>addClass</code> within a file's contents. The query limits the search to files where the language is JavaScript in the <code>jquery/jquery</code> repository.</p>\n<p>Considerations for code search:</p>\n<p>Due to the complexity of searching code, there are a few restrictions on how searches are performed:</p>\n<ul>\n<li>Only the <em>default branch</em> is considered. In most cases, this will be the <code>master</code> branch.</li>\n<li>Only files smaller than 384 KB are searchable.</li>\n<li>You must always include at least one search term when searching source code. For example, searching for <a href=\"https://github.com/search?utf8=%E2%9C%93&#x26;q=language%3Ago&#x26;type=Code\"><code>language:go</code></a> is not valid, while <a href=\"https://github.com/search?utf8=%E2%9C%93&#x26;q=amazing+language%3Ago&#x26;type=Code\"><code>amazing language:go</code></a> is.</li>\n</ul>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\n<code>repository.description</code>, <code>repository.owner.type</code>, and <code>repository.owner.node_id</code> are closing down on this endpoint and will return <code>null</code> in a future API version. Use the <a href=\"https://docs.github.com/rest/repos/repos#get-a-repository\">Get a repository</a> endpoint (<code>GET /repos/{owner}/{repo}</code>) to retrieve full repository metadata.</p>\n</div>\n<p>This endpoint requires you to authenticate and limits you to 10 requests per minute.</p>",
       "codeExamples": [
         {
           "request": {