Merge branch 'master' into reporting/searchsource-exporttype

elastic · Mar 11, 2021 · 482fa41 · 482fa41
2 parents a5c3115 + d089ed9
commit 482fa41
Show file tree

Hide file tree

Showing 332 changed files with 12,074 additions and 6,077 deletions.
diff --git a/api_docs/actions.json b/api_docs/actions.json
diff --git a/api_docs/case.mdx b/api_docs/case.mdx
diff --git a/api_docs/cases.json b/api_docs/cases.json
@@ -1,5 +1,5 @@
 {
-  "id": "case",
+  "id": "cases",
   "client": {
     "classes": [],
     "functions": [],
@@ -34,7 +34,7 @@
               {
                 "pluginId": "cases",
                 "scope": "server",
-                "docId": "kibCasePluginApi",
+                "docId": "kibCasesPluginApi",
                 "section": "def-server.CasesClient",
                 "text": "CasesClient"
               }
@@ -60,4 +60,4 @@
     "misc": [],
     "objects": []
   }
-}
+}
diff --git a/api_docs/cases.mdx b/api_docs/cases.mdx
@@ -0,0 +1,18 @@
+---
+id: kibCasesPluginApi
+slug: /kibana-dev-docs/casesPluginApi
+title: cases
+image: https://source.unsplash.com/400x175/?github
+summary: API docs for the cases plugin
+date: 2020-11-16
+tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cases']
+warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info.
+---
+
+import casesObj from './cases.json';
+
+## Server
+
+### Interfaces
+<DocDefinitionList data={casesObj.server.interfaces}/>
+
diff --git a/api_docs/core.json b/api_docs/core.json
@@ -6622,14 +6622,6 @@
             "label": "asScoped",
             "signature": [
               "(request?: ",
-              {
-                "pluginId": "core",
-                "scope": "server",
-                "docId": "kibCorePluginApi",
-                "section": "def-server.FakeRequest",
-                "text": "FakeRequest"
-              },
-              " | ",
               {
                 "pluginId": "core",
                 "scope": "server",
@@ -6645,6 +6637,14 @@
                 "section": "def-server.LegacyRequest",
                 "text": "LegacyRequest"
               },
+              " | ",
+              {
+                "pluginId": "core",
+                "scope": "server",
+                "docId": "kibCorePluginApi",
+                "section": "def-server.FakeRequest",
+                "text": "FakeRequest"
+              },
               " | undefined) => Pick<",
               {
                 "pluginId": "core",
@@ -6664,14 +6664,6 @@
                 "label": "request",
                 "isRequired": false,
                 "signature": [
-                  {
-                    "pluginId": "core",
-                    "scope": "server",
-                    "docId": "kibCorePluginApi",
-                    "section": "def-server.FakeRequest",
-                    "text": "FakeRequest"
-                  },
-                  " | ",
                   {
                     "pluginId": "core",
                     "scope": "server",
@@ -6687,6 +6679,14 @@
                     "section": "def-server.LegacyRequest",
                     "text": "LegacyRequest"
                   },
+                  " | ",
+                  {
+                    "pluginId": "core",
+                    "scope": "server",
+                    "docId": "kibCorePluginApi",
+                    "section": "def-server.FakeRequest",
+                    "text": "FakeRequest"
+                  },
                   " | undefined"
                 ],
                 "description": [
@@ -16174,14 +16174,6 @@
         },
         "signature": [
           "{ callAsInternalUser: LegacyAPICaller; asScoped: (request?: ",
-          {
-            "pluginId": "core",
-            "scope": "server",
-            "docId": "kibCorePluginApi",
-            "section": "def-server.FakeRequest",
-            "text": "FakeRequest"
-          },
-          " | ",
           {
             "pluginId": "core",
             "scope": "server",
@@ -16197,6 +16189,14 @@
             "section": "def-server.LegacyRequest",
             "text": "LegacyRequest"
           },
+          " | ",
+          {
+            "pluginId": "core",
+            "scope": "server",
+            "docId": "kibCorePluginApi",
+            "section": "def-server.FakeRequest",
+            "text": "FakeRequest"
+          },
           " | undefined) => Pick<LegacyScopedClusterClient, \"callAsCurrentUser\" | \"callAsInternalUser\">; }"
         ],
         "initialIsOpen": false
@@ -16218,14 +16218,6 @@
         },
         "signature": [
           "{ close: () => void; callAsInternalUser: LegacyAPICaller; asScoped: (request?: ",
-          {
-            "pluginId": "core",
-            "scope": "server",
-            "docId": "kibCorePluginApi",
-            "section": "def-server.FakeRequest",
-            "text": "FakeRequest"
-          },
-          " | ",
           {
             "pluginId": "core",
             "scope": "server",
@@ -16241,6 +16233,14 @@
             "section": "def-server.LegacyRequest",
             "text": "LegacyRequest"
           },
+          " | ",
+          {
+            "pluginId": "core",
+            "scope": "server",
+            "docId": "kibCorePluginApi",
+            "section": "def-server.FakeRequest",
+            "text": "FakeRequest"
+          },
           " | undefined) => Pick<LegacyScopedClusterClient, \"callAsCurrentUser\" | \"callAsInternalUser\">; }"
         ],
         "initialIsOpen": false
@@ -16533,14 +16533,6 @@
           "lineNumber": 192
         },
         "signature": [
-          {
-            "pluginId": "core",
-            "scope": "server",
-            "docId": "kibCorePluginApi",
-            "section": "def-server.FakeRequest",
-            "text": "FakeRequest"
-          },
-          " | ",
           {
             "pluginId": "core",
             "scope": "server",
@@ -16555,6 +16547,14 @@
             "docId": "kibCoreHttpPluginApi",
             "section": "def-server.LegacyRequest",
             "text": "LegacyRequest"
+          },
+          " | ",
+          {
+            "pluginId": "core",
+            "scope": "server",
+            "docId": "kibCorePluginApi",
+            "section": "def-server.FakeRequest",
+            "text": "FakeRequest"
           }
         ],
         "initialIsOpen": false

diff --git a/api_docs/core_http.json b/api_docs/core_http.json
@@ -2887,7 +2887,7 @@
             "type": "Function",
             "label": "notHandled",
             "description": [
-              "\nUser has no credentials.\nAllows user to access a resource when authRequired is 'optional' or 'try'\nRejects a request when authRequired: true"
+              "\nUser has no credentials.\nAllows user to access a resource when authRequired is 'optional'\nRejects a request when authRequired: true"
             ],
             "source": {
               "path": "src/core/server/http/lifecycle/auth.ts",
@@ -4648,7 +4648,7 @@
             ],
             "source": {
               "path": "src/core/server/http/router/route.ts",
-              "lineNumber": 173
+              "lineNumber": 171
             }
           },
           {
@@ -4661,7 +4661,7 @@
             ],
             "source": {
               "path": "src/core/server/http/router/route.ts",
-              "lineNumber": 231
+              "lineNumber": 229
             },
             "signature": [
               "false | ",
@@ -4685,7 +4685,7 @@
             ],
             "source": {
               "path": "src/core/server/http/router/route.ts",
-              "lineNumber": 236
+              "lineNumber": 234
             },
             "signature": [
               {
@@ -4701,7 +4701,7 @@
         ],
         "source": {
           "path": "src/core/server/http/router/route.ts",
-          "lineNumber": 159
+          "lineNumber": 157
         },
         "initialIsOpen": false
       },
@@ -4732,14 +4732,14 @@
             "type": "CompoundType",
             "label": "authRequired",
             "description": [
-              "\nDefines authentication mode for a route:\n- true. A user has to have valid credentials to access a resource\n- false. A user can access a resource without any credentials.\n- 'optional'. A user can access a resource if has valid credentials or no credentials at all.\n              Can be useful when we grant access to a resource but want to identify a user if possible.\n- 'try'. A user can access a resource with valid, invalid or without any credentials.\n         Users with valid credentials will be authenticated\n\nDefaults to `true` if an auth mechanism is registered."
+              "\nDefines authentication mode for a route:\n- true. A user has to have valid credentials to access a resource\n- false. A user can access a resource without any credentials.\n- 'optional'. A user can access a resource, and will be authenticated if provided credentials are valid.\n              Can be useful when we grant access to a resource but want to identify a user if possible.\n\nDefaults to `true` if an auth mechanism is registered."
             ],
             "source": {
               "path": "src/core/server/http/router/route.ts",
-              "lineNumber": 118
+              "lineNumber": 116
             },
             "signature": [
-              "boolean | \"optional\" | \"try\" | undefined"
+              "boolean | \"optional\" | undefined"
             ]
           },
           {
@@ -4752,7 +4752,7 @@
             ],
             "source": {
               "path": "src/core/server/http/router/route.ts",
-              "lineNumber": 127
+              "lineNumber": 125
             },
             "signature": [
               "(Method extends \"get\" ? never : boolean) | undefined"
@@ -4768,7 +4768,7 @@
             ],
             "source": {
               "path": "src/core/server/http/router/route.ts",
-              "lineNumber": 132
+              "lineNumber": 130
             },
             "signature": [
               "readonly string[] | undefined"
@@ -4784,7 +4784,7 @@
             ],
             "source": {
               "path": "src/core/server/http/router/route.ts",
-              "lineNumber": 137
+              "lineNumber": 135
             },
             "signature": [
               "(Method extends ",
@@ -4816,7 +4816,7 @@
             ],
             "source": {
               "path": "src/core/server/http/router/route.ts",
-              "lineNumber": 142
+              "lineNumber": 140
             },
             "signature": [
               "{ payload?: (Method extends ",

diff --git a/api_docs/data_search.json b/api_docs/data_search.json
@@ -1435,7 +1435,15 @@
             "section": "def-server.SearchUsage",
             "text": "SearchUsage"
           },
-          " | undefined) => { next(response: ",
+          " | undefined, { isRestore }: ",
+          {
+            "pluginId": "data",
+            "scope": "common",
+            "docId": "kibDataSearchPluginApi",
+            "section": "def-common.ISearchOptions",
+            "text": "ISearchOptions"
+          },
+          ") => { next(response: ",
           {
             "pluginId": "data",
             "scope": "common",
@@ -1459,7 +1467,7 @@
             "description": [],
             "source": {
               "path": "src/plugins/data/server/search/collectors/usage.ts",
-              "lineNumber": 64
+              "lineNumber": 83
             }
           },
           {
@@ -1479,15 +1487,34 @@
             "description": [],
             "source": {
               "path": "src/plugins/data/server/search/collectors/usage.ts",
-              "lineNumber": 64
+              "lineNumber": 84
+            }
+          },
+          {
+            "type": "Object",
+            "label": "{ isRestore }",
+            "isRequired": true,
+            "signature": [
+              {
+                "pluginId": "data",
+                "scope": "common",
+                "docId": "kibDataSearchPluginApi",
+                "section": "def-common.ISearchOptions",
+                "text": "ISearchOptions"
+              }
+            ],
+            "description": [],
+            "source": {
+              "path": "src/plugins/data/server/search/collectors/usage.ts",
+              "lineNumber": 85
             }
           }
         ],
         "tags": [],
         "returnComment": [],
         "source": {
           "path": "src/plugins/data/server/search/collectors/usage.ts",
-          "lineNumber": 64
+          "lineNumber": 82
         },
         "initialIsOpen": false
       },