Skip to content

Commit aeaffd5

Browse files
YulNaumenkoYulNaumenko
committed
Merge remote-tracking branch upstream/master
2 parents 8670ea3 + 0c3514c commit aeaffd5

436 files changed

Lines changed: 15560 additions & 8689 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎api_docs/actions.json‎

Lines changed: 52 additions & 52 deletions
Large diffs are not rendered by default.

‎api_docs/case.mdx‎

Lines changed: 0 additions & 18 deletions
This file was deleted.

‎api_docs/cases.json‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"id": "case",
2+
"id": "cases",
33
"client": {
44
"classes": [],
55
"functions": [],
@@ -34,7 +34,7 @@
3434
{
3535
"pluginId": "cases",
3636
"scope": "server",
37-
"docId": "kibCasePluginApi",
37+
"docId": "kibCasesPluginApi",
3838
"section": "def-server.CasesClient",
3939
"text": "CasesClient"
4040
}
@@ -60,4 +60,4 @@
6060
"misc": [],
6161
"objects": []
6262
}
63-
}
63+
}

‎api_docs/cases.mdx‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
id: kibCasesPluginApi
3+
slug: /kibana-dev-docs/casesPluginApi
4+
title: cases
5+
image: https://source.unsplash.com/400x175/?github
6+
summary: API docs for the cases plugin
7+
date: 2020-11-16
8+
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cases']
9+
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.
10+
---
11+
12+
import casesObj from './cases.json';
13+
14+
## Server
15+
16+
### Interfaces
17+
<DocDefinitionList data={casesObj.server.interfaces}/>
18+

‎api_docs/core.json‎

Lines changed: 40 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -6622,14 +6622,6 @@
66226622
"label": "asScoped",
66236623
"signature": [
66246624
"(request?: ",
6625-
{
6626-
"pluginId": "core",
6627-
"scope": "server",
6628-
"docId": "kibCorePluginApi",
6629-
"section": "def-server.FakeRequest",
6630-
"text": "FakeRequest"
6631-
},
6632-
" | ",
66336625
{
66346626
"pluginId": "core",
66356627
"scope": "server",
@@ -6645,6 +6637,14 @@
66456637
"section": "def-server.LegacyRequest",
66466638
"text": "LegacyRequest"
66476639
},
6640+
" | ",
6641+
{
6642+
"pluginId": "core",
6643+
"scope": "server",
6644+
"docId": "kibCorePluginApi",
6645+
"section": "def-server.FakeRequest",
6646+
"text": "FakeRequest"
6647+
},
66486648
" | undefined) => Pick<",
66496649
{
66506650
"pluginId": "core",
@@ -6664,14 +6664,6 @@
66646664
"label": "request",
66656665
"isRequired": false,
66666666
"signature": [
6667-
{
6668-
"pluginId": "core",
6669-
"scope": "server",
6670-
"docId": "kibCorePluginApi",
6671-
"section": "def-server.FakeRequest",
6672-
"text": "FakeRequest"
6673-
},
6674-
" | ",
66756667
{
66766668
"pluginId": "core",
66776669
"scope": "server",
@@ -6687,6 +6679,14 @@
66876679
"section": "def-server.LegacyRequest",
66886680
"text": "LegacyRequest"
66896681
},
6682+
" | ",
6683+
{
6684+
"pluginId": "core",
6685+
"scope": "server",
6686+
"docId": "kibCorePluginApi",
6687+
"section": "def-server.FakeRequest",
6688+
"text": "FakeRequest"
6689+
},
66906690
" | undefined"
66916691
],
66926692
"description": [
@@ -16174,14 +16174,6 @@
1617416174
},
1617516175
"signature": [
1617616176
"{ callAsInternalUser: LegacyAPICaller; asScoped: (request?: ",
16177-
{
16178-
"pluginId": "core",
16179-
"scope": "server",
16180-
"docId": "kibCorePluginApi",
16181-
"section": "def-server.FakeRequest",
16182-
"text": "FakeRequest"
16183-
},
16184-
" | ",
1618516177
{
1618616178
"pluginId": "core",
1618716179
"scope": "server",
@@ -16197,6 +16189,14 @@
1619716189
"section": "def-server.LegacyRequest",
1619816190
"text": "LegacyRequest"
1619916191
},
16192+
" | ",
16193+
{
16194+
"pluginId": "core",
16195+
"scope": "server",
16196+
"docId": "kibCorePluginApi",
16197+
"section": "def-server.FakeRequest",
16198+
"text": "FakeRequest"
16199+
},
1620016200
" | undefined) => Pick<LegacyScopedClusterClient, \"callAsCurrentUser\" | \"callAsInternalUser\">; }"
1620116201
],
1620216202
"initialIsOpen": false
@@ -16218,14 +16218,6 @@
1621816218
},
1621916219
"signature": [
1622016220
"{ close: () => void; callAsInternalUser: LegacyAPICaller; asScoped: (request?: ",
16221-
{
16222-
"pluginId": "core",
16223-
"scope": "server",
16224-
"docId": "kibCorePluginApi",
16225-
"section": "def-server.FakeRequest",
16226-
"text": "FakeRequest"
16227-
},
16228-
" | ",
1622916221
{
1623016222
"pluginId": "core",
1623116223
"scope": "server",
@@ -16241,6 +16233,14 @@
1624116233
"section": "def-server.LegacyRequest",
1624216234
"text": "LegacyRequest"
1624316235
},
16236+
" | ",
16237+
{
16238+
"pluginId": "core",
16239+
"scope": "server",
16240+
"docId": "kibCorePluginApi",
16241+
"section": "def-server.FakeRequest",
16242+
"text": "FakeRequest"
16243+
},
1624416244
" | undefined) => Pick<LegacyScopedClusterClient, \"callAsCurrentUser\" | \"callAsInternalUser\">; }"
1624516245
],
1624616246
"initialIsOpen": false
@@ -16533,14 +16533,6 @@
1653316533
"lineNumber": 192
1653416534
},
1653516535
"signature": [
16536-
{
16537-
"pluginId": "core",
16538-
"scope": "server",
16539-
"docId": "kibCorePluginApi",
16540-
"section": "def-server.FakeRequest",
16541-
"text": "FakeRequest"
16542-
},
16543-
" | ",
1654416536
{
1654516537
"pluginId": "core",
1654616538
"scope": "server",
@@ -16555,6 +16547,14 @@
1655516547
"docId": "kibCoreHttpPluginApi",
1655616548
"section": "def-server.LegacyRequest",
1655716549
"text": "LegacyRequest"
16550+
},
16551+
" | ",
16552+
{
16553+
"pluginId": "core",
16554+
"scope": "server",
16555+
"docId": "kibCorePluginApi",
16556+
"section": "def-server.FakeRequest",
16557+
"text": "FakeRequest"
1655816558
}
1655916559
],
1656016560
"initialIsOpen": false

‎api_docs/core_http.json‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2887,7 +2887,7 @@
28872887
"type": "Function",
28882888
"label": "notHandled",
28892889
"description": [
2890-
"\nUser has no credentials.\nAllows user to access a resource when authRequired is 'optional' or 'try'\nRejects a request when authRequired: true"
2890+
"\nUser has no credentials.\nAllows user to access a resource when authRequired is 'optional'\nRejects a request when authRequired: true"
28912891
],
28922892
"source": {
28932893
"path": "src/core/server/http/lifecycle/auth.ts",
@@ -4648,7 +4648,7 @@
46484648
],
46494649
"source": {
46504650
"path": "src/core/server/http/router/route.ts",
4651-
"lineNumber": 173
4651+
"lineNumber": 171
46524652
}
46534653
},
46544654
{
@@ -4661,7 +4661,7 @@
46614661
],
46624662
"source": {
46634663
"path": "src/core/server/http/router/route.ts",
4664-
"lineNumber": 231
4664+
"lineNumber": 229
46654665
},
46664666
"signature": [
46674667
"false | ",
@@ -4685,7 +4685,7 @@
46854685
],
46864686
"source": {
46874687
"path": "src/core/server/http/router/route.ts",
4688-
"lineNumber": 236
4688+
"lineNumber": 234
46894689
},
46904690
"signature": [
46914691
{
@@ -4701,7 +4701,7 @@
47014701
],
47024702
"source": {
47034703
"path": "src/core/server/http/router/route.ts",
4704-
"lineNumber": 159
4704+
"lineNumber": 157
47054705
},
47064706
"initialIsOpen": false
47074707
},
@@ -4732,14 +4732,14 @@
47324732
"type": "CompoundType",
47334733
"label": "authRequired",
47344734
"description": [
4735-
"\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."
4735+
"\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."
47364736
],
47374737
"source": {
47384738
"path": "src/core/server/http/router/route.ts",
4739-
"lineNumber": 118
4739+
"lineNumber": 116
47404740
},
47414741
"signature": [
4742-
"boolean | \"optional\" | \"try\" | undefined"
4742+
"boolean | \"optional\" | undefined"
47434743
]
47444744
},
47454745
{
@@ -4752,7 +4752,7 @@
47524752
],
47534753
"source": {
47544754
"path": "src/core/server/http/router/route.ts",
4755-
"lineNumber": 127
4755+
"lineNumber": 125
47564756
},
47574757
"signature": [
47584758
"(Method extends \"get\" ? never : boolean) | undefined"
@@ -4768,7 +4768,7 @@
47684768
],
47694769
"source": {
47704770
"path": "src/core/server/http/router/route.ts",
4771-
"lineNumber": 132
4771+
"lineNumber": 130
47724772
},
47734773
"signature": [
47744774
"readonly string[] | undefined"
@@ -4784,7 +4784,7 @@
47844784
],
47854785
"source": {
47864786
"path": "src/core/server/http/router/route.ts",
4787-
"lineNumber": 137
4787+
"lineNumber": 135
47884788
},
47894789
"signature": [
47904790
"(Method extends ",
@@ -4816,7 +4816,7 @@
48164816
],
48174817
"source": {
48184818
"path": "src/core/server/http/router/route.ts",
4819-
"lineNumber": 142
4819+
"lineNumber": 140
48204820
},
48214821
"signature": [
48224822
"{ payload?: (Method extends ",

0 commit comments

Comments
 (0)