fix: update schema descriptions for added, removed and modified…

… files in `commits` (#695) * fix: update schema descriptions for `added`, `removed` and `modified` files in `commits` This PR applies the changes detected in #691 to the schemas. They were automatically applied to the examples, but I forgot to make the manual schema changes. * fix: update type descriptions for `added`, `removed` and `modified` files in `commits`
octokit · Aug 11, 2022 · aed7be2 · aed7be2
1 parent 5d5bb3c
commit aed7be2
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 6 deletions.
diff --git a/payload-schemas/api.github.com/common/commit.schema.json b/payload-schemas/api.github.com/common/commit.schema.json
@@ -38,17 +38,17 @@
     "added": {
       "type": "array",
       "items": { "type": "string" },
-      "description": "An array of files added in the commit."
+      "description": "An array of files added in the commit. For extremely large commits where GitHub is unable to calculate this list in a timely manner, this may be empty even if files were added."
     },
     "modified": {
       "type": "array",
       "items": { "type": "string" },
-      "description": "An array of files modified by the commit."
+      "description": "An array of files modified by the commit. For extremely large commits where GitHub is unable to calculate this list in a timely manner, this may be empty even if files were modified."
     },
     "removed": {
       "type": "array",
       "items": { "type": "string" },
-      "description": "An array of files removed in the commit."
+      "description": "An array of files removed in the commit. For extremely large commits where GitHub is unable to calculate this list in a timely manner, this may be empty even if files were removed."
     }
   },
   "additionalProperties": false,

diff --git a/payload-types/schema.d.ts b/payload-types/schema.d.ts
@@ -5780,15 +5780,15 @@ export interface Commit {
   author: Committer;
   committer: Committer;
   /**
-   * An array of files added in the commit.
+   * An array of files added in the commit. For extremely large commits where GitHub is unable to calculate this list in a timely manner, this may be empty even if files were added.
    */
   added: string[];
   /**
-   * An array of files modified by the commit.
+   * An array of files modified by the commit. For extremely large commits where GitHub is unable to calculate this list in a timely manner, this may be empty even if files were modified.
    */
   modified: string[];
   /**
-   * An array of files removed in the commit.
+   * An array of files removed in the commit. For extremely large commits where GitHub is unable to calculate this list in a timely manner, this may be empty even if files were removed.
    */
   removed: string[];
 }