Update OpenAPI Description (#48848)

2026-01-16 18:01:39 -05:00 · 2024-01-24 19:29:04 -06:00
parent 4e2658cdfa
commit 3156a89719
47 changed files with 2244 additions and 682 deletions
--- 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
@@ -5683,7 +5683,25 @@
        "slug": "create-a-github-pages-deployment",
        "subcategory": "pages",
        "verb": "post",
-        "requestPath": "/repos/{owner}/{repo}/pages/deployment",
+        "requestPath": "/repos/{owner}/{repo}/pages/deployments",
+        "additional-permissions": [],
+        "access": "write"
+      },
+      {
+        "category": "pages",
+        "slug": "get-the-status-of-a-github-pages-deployment",
+        "subcategory": "pages",
+        "verb": "get",
+        "requestPath": "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}",
+        "additional-permissions": [],
+        "access": "read"
+      },
+      {
+        "category": "pages",
+        "slug": "cancel-a-github-pages-deployment",
+        "subcategory": "pages",
+        "verb": "post",
+        "requestPath": "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}/cancel",
        "additional-permissions": [],
        "access": "write"
      },
--- 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
@@ -3448,7 +3448,19 @@
      "slug": "create-a-github-pages-deployment",
      "subcategory": "pages",
      "verb": "post",
-      "requestPath": "/repos/{owner}/{repo}/pages/deployment"
+      "requestPath": "/repos/{owner}/{repo}/pages/deployments"
+    },
+    {
+      "slug": "get-the-status-of-a-github-pages-deployment",
+      "subcategory": "pages",
+      "verb": "get",
+      "requestPath": "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}"
+    },
+    {
+      "slug": "cancel-a-github-pages-deployment",
+      "subcategory": "pages",
+      "verb": "post",
+      "requestPath": "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}/cancel"
    },
    {
      "slug": "get-a-dns-health-check-for-github-pages",
--- 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
@@ -7013,7 +7013,29 @@
        "slug": "create-a-github-pages-deployment",
        "subcategory": "pages",
        "verb": "post",
-        "requestPath": "/repos/{owner}/{repo}/pages/deployment",
+        "requestPath": "/repos/{owner}/{repo}/pages/deployments",
+        "access": "write",
+        "user-to-server": true,
+        "server-to-server": true,
+        "additional-permissions": []
+      },
+      {
+        "category": "pages",
+        "slug": "get-the-status-of-a-github-pages-deployment",
+        "subcategory": "pages",
+        "verb": "get",
+        "requestPath": "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}",
+        "access": "read",
+        "user-to-server": true,
+        "server-to-server": true,
+        "additional-permissions": []
+      },
+      {
+        "category": "pages",
+        "slug": "cancel-a-github-pages-deployment",
+        "subcategory": "pages",
+        "verb": "post",
+        "requestPath": "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}/cancel",
        "access": "write",
        "user-to-server": true,
        "server-to-server": true,
--- 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
@@ -3052,7 +3052,19 @@
      "slug": "create-a-github-pages-deployment",
      "subcategory": "pages",
      "verb": "post",
-      "requestPath": "/repos/{owner}/{repo}/pages/deployment"
+      "requestPath": "/repos/{owner}/{repo}/pages/deployments"
+    },
+    {
+      "slug": "get-the-status-of-a-github-pages-deployment",
+      "subcategory": "pages",
+      "verb": "get",
+      "requestPath": "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}"
+    },
+    {
+      "slug": "cancel-a-github-pages-deployment",
+      "subcategory": "pages",
+      "verb": "post",
+      "requestPath": "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}/cancel"
    },
    {
      "slug": "get-a-dns-health-check-for-github-pages",
--- 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
@@ -3520,7 +3520,19 @@
      "slug": "create-a-github-pages-deployment",
      "subcategory": "pages",
      "verb": "post",
-      "requestPath": "/repos/{owner}/{repo}/pages/deployment"
+      "requestPath": "/repos/{owner}/{repo}/pages/deployments"
+    },
+    {
+      "slug": "get-the-status-of-a-github-pages-deployment",
+      "subcategory": "pages",
+      "verb": "get",
+      "requestPath": "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}"
+    },
+    {
+      "slug": "cancel-a-github-pages-deployment",
+      "subcategory": "pages",
+      "verb": "post",
+      "requestPath": "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}/cancel"
    },
    {
      "slug": "get-a-dns-health-check-for-github-pages",
--- 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
@@ -6375,7 +6375,25 @@
        "slug": "create-a-github-pages-deployment",
        "subcategory": "pages",
        "verb": "post",
-        "requestPath": "/repos/{owner}/{repo}/pages/deployment",
+        "requestPath": "/repos/{owner}/{repo}/pages/deployments",
+        "additional-permissions": [],
+        "access": "write"
+      },
+      {
+        "category": "pages",
+        "slug": "get-the-status-of-a-github-pages-deployment",
+        "subcategory": "pages",
+        "verb": "get",
+        "requestPath": "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}",
+        "additional-permissions": [],
+        "access": "read"
+      },
+      {
+        "category": "pages",
+        "slug": "cancel-a-github-pages-deployment",
+        "subcategory": "pages",
+        "verb": "post",
+        "requestPath": "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}/cancel",
        "additional-permissions": [],
        "access": "write"
      },
--- 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
@@ -3776,7 +3776,19 @@
      "slug": "create-a-github-pages-deployment",
      "subcategory": "pages",
      "verb": "post",
-      "requestPath": "/repos/{owner}/{repo}/pages/deployment"
+      "requestPath": "/repos/{owner}/{repo}/pages/deployments"
+    },
+    {
+      "slug": "get-the-status-of-a-github-pages-deployment",
+      "subcategory": "pages",
+      "verb": "get",
+      "requestPath": "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}"
+    },
+    {
+      "slug": "cancel-a-github-pages-deployment",
+      "subcategory": "pages",
+      "verb": "post",
+      "requestPath": "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}/cancel"
    },
    {
      "slug": "get-a-dns-health-check-for-github-pages",
--- 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
@@ -7853,7 +7853,29 @@
        "slug": "create-a-github-pages-deployment",
        "subcategory": "pages",
        "verb": "post",
-        "requestPath": "/repos/{owner}/{repo}/pages/deployment",
+        "requestPath": "/repos/{owner}/{repo}/pages/deployments",
+        "access": "write",
+        "user-to-server": true,
+        "server-to-server": true,
+        "additional-permissions": []
+      },
+      {
+        "category": "pages",
+        "slug": "get-the-status-of-a-github-pages-deployment",
+        "subcategory": "pages",
+        "verb": "get",
+        "requestPath": "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}",
+        "access": "read",
+        "user-to-server": true,
+        "server-to-server": true,
+        "additional-permissions": []
+      },
+      {
+        "category": "pages",
+        "slug": "cancel-a-github-pages-deployment",
+        "subcategory": "pages",
+        "verb": "post",
+        "requestPath": "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}/cancel",
        "access": "write",
        "user-to-server": true,
        "server-to-server": true,
--- 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
@@ -3380,7 +3380,19 @@
      "slug": "create-a-github-pages-deployment",
      "subcategory": "pages",
      "verb": "post",
-      "requestPath": "/repos/{owner}/{repo}/pages/deployment"
+      "requestPath": "/repos/{owner}/{repo}/pages/deployments"
+    },
+    {
+      "slug": "get-the-status-of-a-github-pages-deployment",
+      "subcategory": "pages",
+      "verb": "get",
+      "requestPath": "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}"
+    },
+    {
+      "slug": "cancel-a-github-pages-deployment",
+      "subcategory": "pages",
+      "verb": "post",
+      "requestPath": "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}/cancel"
    },
    {
      "slug": "get-a-dns-health-check-for-github-pages",
--- 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
@@ -3848,7 +3848,19 @@
      "slug": "create-a-github-pages-deployment",
      "subcategory": "pages",
      "verb": "post",
-      "requestPath": "/repos/{owner}/{repo}/pages/deployment"
+      "requestPath": "/repos/{owner}/{repo}/pages/deployments"
+    },
+    {
+      "slug": "get-the-status-of-a-github-pages-deployment",
+      "subcategory": "pages",
+      "verb": "get",
+      "requestPath": "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}"
+    },
+    {
+      "slug": "cancel-a-github-pages-deployment",
+      "subcategory": "pages",
+      "verb": "post",
+      "requestPath": "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}/cancel"
    },
    {
      "slug": "get-a-dns-health-check-for-github-pages",
--- a/src/github-apps/data/ghes-3.10-2022-11-28/fine-grained-pat-permissions.json
+++ b/src/github-apps/data/ghes-3.10-2022-11-28/fine-grained-pat-permissions.json
@@ -4883,7 +4883,7 @@
        "slug": "create-a-github-pages-deployment",
        "subcategory": "pages",
        "verb": "post",
-        "requestPath": "/repos/{owner}/{repo}/pages/deployment",
+        "requestPath": "/repos/{owner}/{repo}/pages/deployments",
        "additional-permissions": [],
        "access": "write"
      }
--- a/src/github-apps/data/ghes-3.10-2022-11-28/fine-grained-pat.json
+++ b/src/github-apps/data/ghes-3.10-2022-11-28/fine-grained-pat.json
@@ -2932,7 +2932,7 @@
      "slug": "create-a-github-pages-deployment",
      "subcategory": "pages",
      "verb": "post",
-      "requestPath": "/repos/{owner}/{repo}/pages/deployment"
+      "requestPath": "/repos/{owner}/{repo}/pages/deployments"
    }
  ],
  "projects": [
--- a/src/github-apps/data/ghes-3.10-2022-11-28/server-to-server-permissions.json
+++ b/src/github-apps/data/ghes-3.10-2022-11-28/server-to-server-permissions.json
@@ -6053,7 +6053,7 @@
        "slug": "create-a-github-pages-deployment",
        "subcategory": "pages",
        "verb": "post",
-        "requestPath": "/repos/{owner}/{repo}/pages/deployment",
+        "requestPath": "/repos/{owner}/{repo}/pages/deployments",
        "access": "write",
        "user-to-server": true,
        "server-to-server": true,
--- a/src/github-apps/data/ghes-3.10-2022-11-28/server-to-server-rest.json
+++ b/src/github-apps/data/ghes-3.10-2022-11-28/server-to-server-rest.json
@@ -2822,7 +2822,7 @@
      "slug": "create-a-github-pages-deployment",
      "subcategory": "pages",
      "verb": "post",
-      "requestPath": "/repos/{owner}/{repo}/pages/deployment"
+      "requestPath": "/repos/{owner}/{repo}/pages/deployments"
    }
  ],
  "projects": [
--- a/src/github-apps/data/ghes-3.10-2022-11-28/user-to-server-rest.json
+++ b/src/github-apps/data/ghes-3.10-2022-11-28/user-to-server-rest.json
@@ -3004,7 +3004,7 @@
      "slug": "create-a-github-pages-deployment",
      "subcategory": "pages",
      "verb": "post",
-      "requestPath": "/repos/{owner}/{repo}/pages/deployment"
+      "requestPath": "/repos/{owner}/{repo}/pages/deployments"
    }
  ],
  "projects": [
--- a/src/github-apps/data/ghes-3.11-2022-11-28/fine-grained-pat-permissions.json
+++ b/src/github-apps/data/ghes-3.11-2022-11-28/fine-grained-pat-permissions.json
@@ -4991,7 +4991,7 @@
        "slug": "create-a-github-pages-deployment",
        "subcategory": "pages",
        "verb": "post",
-        "requestPath": "/repos/{owner}/{repo}/pages/deployment",
+        "requestPath": "/repos/{owner}/{repo}/pages/deployments",
        "additional-permissions": [],
        "access": "write"
      }
--- a/src/github-apps/data/ghes-3.11-2022-11-28/fine-grained-pat.json
+++ b/src/github-apps/data/ghes-3.11-2022-11-28/fine-grained-pat.json
@@ -2962,7 +2962,7 @@
      "slug": "create-a-github-pages-deployment",
      "subcategory": "pages",
      "verb": "post",
-      "requestPath": "/repos/{owner}/{repo}/pages/deployment"
+      "requestPath": "/repos/{owner}/{repo}/pages/deployments"
    }
  ],
  "projects": [
--- a/src/github-apps/data/ghes-3.11-2022-11-28/server-to-server-permissions.json
+++ b/src/github-apps/data/ghes-3.11-2022-11-28/server-to-server-permissions.json
@@ -6185,7 +6185,7 @@
        "slug": "create-a-github-pages-deployment",
        "subcategory": "pages",
        "verb": "post",
-        "requestPath": "/repos/{owner}/{repo}/pages/deployment",
+        "requestPath": "/repos/{owner}/{repo}/pages/deployments",
        "access": "write",
        "user-to-server": true,
        "server-to-server": true,
--- a/src/github-apps/data/ghes-3.11-2022-11-28/server-to-server-rest.json
+++ b/src/github-apps/data/ghes-3.11-2022-11-28/server-to-server-rest.json
@@ -2852,7 +2852,7 @@
      "slug": "create-a-github-pages-deployment",
      "subcategory": "pages",
      "verb": "post",
-      "requestPath": "/repos/{owner}/{repo}/pages/deployment"
+      "requestPath": "/repos/{owner}/{repo}/pages/deployments"
    }
  ],
  "projects": [
--- a/src/github-apps/data/ghes-3.11-2022-11-28/user-to-server-rest.json
+++ b/src/github-apps/data/ghes-3.11-2022-11-28/user-to-server-rest.json
@@ -3034,7 +3034,7 @@
      "slug": "create-a-github-pages-deployment",
      "subcategory": "pages",
      "verb": "post",
-      "requestPath": "/repos/{owner}/{repo}/pages/deployment"
+      "requestPath": "/repos/{owner}/{repo}/pages/deployments"
    }
  ],
  "projects": [
--- a/src/github-apps/data/ghes-3.8/fine-grained-pat-permissions.json
+++ b/src/github-apps/data/ghes-3.8/fine-grained-pat-permissions.json
@@ -4667,7 +4667,7 @@
        "slug": "create-a-github-pages-deployment",
        "subcategory": "pages",
        "verb": "post",
-        "requestPath": "/repos/{owner}/{repo}/pages/deployment",
+        "requestPath": "/repos/{owner}/{repo}/pages/deployments",
        "additional-permissions": [],
        "access": "write"
      }
--- a/src/github-apps/data/ghes-3.8/fine-grained-pat.json
+++ b/src/github-apps/data/ghes-3.8/fine-grained-pat.json
@@ -2708,7 +2708,7 @@
      "slug": "create-a-github-pages-deployment",
      "subcategory": "pages",
      "verb": "post",
-      "requestPath": "/repos/{owner}/{repo}/pages/deployment"
+      "requestPath": "/repos/{owner}/{repo}/pages/deployments"
    }
  ],
  "projects": [
--- a/src/github-apps/data/ghes-3.8/server-to-server-permissions.json
+++ b/src/github-apps/data/ghes-3.8/server-to-server-permissions.json
@@ -5678,7 +5678,7 @@
        "slug": "create-a-github-pages-deployment",
        "subcategory": "pages",
        "verb": "post",
-        "requestPath": "/repos/{owner}/{repo}/pages/deployment",
+        "requestPath": "/repos/{owner}/{repo}/pages/deployments",
        "access": "write",
        "user-to-server": true,
        "server-to-server": true,
--- a/src/github-apps/data/ghes-3.8/server-to-server-rest.json
+++ b/src/github-apps/data/ghes-3.8/server-to-server-rest.json
@@ -2496,7 +2496,7 @@
      "slug": "create-a-github-pages-deployment",
      "subcategory": "pages",
      "verb": "post",
-      "requestPath": "/repos/{owner}/{repo}/pages/deployment"
+      "requestPath": "/repos/{owner}/{repo}/pages/deployments"
    }
  ],
  "projects": [
--- a/src/github-apps/data/ghes-3.8/user-to-server-rest.json
+++ b/src/github-apps/data/ghes-3.8/user-to-server-rest.json
@@ -2732,7 +2732,7 @@
      "slug": "create-a-github-pages-deployment",
      "subcategory": "pages",
      "verb": "post",
-      "requestPath": "/repos/{owner}/{repo}/pages/deployment"
+      "requestPath": "/repos/{owner}/{repo}/pages/deployments"
    }
  ],
  "projects": [
--- a/src/github-apps/data/ghes-3.9-2022-11-28/fine-grained-pat-permissions.json
+++ b/src/github-apps/data/ghes-3.9-2022-11-28/fine-grained-pat-permissions.json
@@ -4811,7 +4811,7 @@
        "slug": "create-a-github-pages-deployment",
        "subcategory": "pages",
        "verb": "post",
-        "requestPath": "/repos/{owner}/{repo}/pages/deployment",
+        "requestPath": "/repos/{owner}/{repo}/pages/deployments",
        "additional-permissions": [],
        "access": "write"
      }
--- a/src/github-apps/data/ghes-3.9-2022-11-28/fine-grained-pat.json
+++ b/src/github-apps/data/ghes-3.9-2022-11-28/fine-grained-pat.json
@@ -2890,7 +2890,7 @@
      "slug": "create-a-github-pages-deployment",
      "subcategory": "pages",
      "verb": "post",
-      "requestPath": "/repos/{owner}/{repo}/pages/deployment"
+      "requestPath": "/repos/{owner}/{repo}/pages/deployments"
    }
  ],
  "projects": [
--- a/src/github-apps/data/ghes-3.9-2022-11-28/server-to-server-permissions.json
+++ b/src/github-apps/data/ghes-3.9-2022-11-28/server-to-server-permissions.json
@@ -5854,7 +5854,7 @@
        "slug": "create-a-github-pages-deployment",
        "subcategory": "pages",
        "verb": "post",
-        "requestPath": "/repos/{owner}/{repo}/pages/deployment",
+        "requestPath": "/repos/{owner}/{repo}/pages/deployments",
        "access": "write",
        "user-to-server": true,
        "server-to-server": true,
--- a/src/github-apps/data/ghes-3.9-2022-11-28/server-to-server-rest.json
+++ b/src/github-apps/data/ghes-3.9-2022-11-28/server-to-server-rest.json
@@ -2726,7 +2726,7 @@
      "slug": "create-a-github-pages-deployment",
      "subcategory": "pages",
      "verb": "post",
-      "requestPath": "/repos/{owner}/{repo}/pages/deployment"
+      "requestPath": "/repos/{owner}/{repo}/pages/deployments"
    }
  ],
  "projects": [
--- a/src/github-apps/data/ghes-3.9-2022-11-28/user-to-server-rest.json
+++ b/src/github-apps/data/ghes-3.9-2022-11-28/user-to-server-rest.json
@@ -2914,7 +2914,7 @@
      "slug": "create-a-github-pages-deployment",
      "subcategory": "pages",
      "verb": "post",
-      "requestPath": "/repos/{owner}/{repo}/pages/deployment"
+      "requestPath": "/repos/{owner}/{repo}/pages/deployments"
    }
  ],
  "projects": [