Skip to content

Commit

Permalink
update api docs after merge from master
Browse files Browse the repository at this point in the history
  • Loading branch information
@stacey-gammon
stacey-gammon committed May 14, 2021
1 parent 56f9069 commit 05af8a0
Show file tree
Hide file tree
Showing 23 changed files with 995 additions and 2,530 deletions.
141 changes: 68 additions & 73 deletions api_docs/apm.json
View file

Large diffs are not rendered by default.

81 changes: 59 additions & 22 deletions api_docs/cases.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -318,7 +318,7 @@
"{ authc: ",
"AuthenticationServiceSetup",
"; sessionTimeout: ",
"ISessionTimeout",
"SessionTimeout",
"; license: Readonly<{ isLicenseAvailable: () => boolean; isEnabled: () => boolean; getType: () => \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined; getFeatures: () => ",
"SecurityLicenseFeatures",
"; features$: ",
Expand Down Expand Up @@ -427,7 +427,7 @@
" & { security: { authc: ",
"AuthenticationServiceSetup",
"; sessionTimeout: ",
"ISessionTimeout",
"SessionTimeout",
"; license: Readonly<{ isLicenseAvailable: () => boolean; isEnabled: () => boolean; getType: () => \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined; getFeatures: () => ",
"SecurityLicenseFeatures",
"; features$: ",
Expand Down Expand Up @@ -929,7 +929,7 @@
],
"source": {
"path": "x-pack/plugins/cases/common/api/helpers.ts",
"lineNumber": 35
"lineNumber": 36
},
"deprecated": false,
"children": [
Expand All @@ -945,7 +945,7 @@
],
"source": {
"path": "x-pack/plugins/cases/common/api/helpers.ts",
"lineNumber": 35
"lineNumber": 36
},
"deprecated": false,
"isRequired": true
Expand All @@ -962,7 +962,7 @@
],
"source": {
"path": "x-pack/plugins/cases/common/api/helpers.ts",
"lineNumber": 35
"lineNumber": 36
},
"deprecated": false,
"isRequired": true
Expand All @@ -983,7 +983,7 @@
],
"source": {
"path": "x-pack/plugins/cases/common/api/helpers.ts",
"lineNumber": 31
"lineNumber": 32
},
"deprecated": false,
"children": [
Expand All @@ -999,7 +999,7 @@
],
"source": {
"path": "x-pack/plugins/cases/common/api/helpers.ts",
"lineNumber": 31
"lineNumber": 32
},
"deprecated": false,
"isRequired": true
Expand All @@ -1020,7 +1020,7 @@
],
"source": {
"path": "x-pack/plugins/cases/common/api/helpers.ts",
"lineNumber": 19
"lineNumber": 20
},
"deprecated": false,
"children": [
Expand All @@ -1036,7 +1036,7 @@
],
"source": {
"path": "x-pack/plugins/cases/common/api/helpers.ts",
"lineNumber": 19
"lineNumber": 20
},
"deprecated": false,
"isRequired": true
Expand All @@ -1057,7 +1057,7 @@
],
"source": {
"path": "x-pack/plugins/cases/common/api/helpers.ts",
"lineNumber": 47
"lineNumber": 48
},
"deprecated": false,
"children": [
Expand All @@ -1073,7 +1073,7 @@
],
"source": {
"path": "x-pack/plugins/cases/common/api/helpers.ts",
"lineNumber": 47
"lineNumber": 48
},
"deprecated": false,
"isRequired": true
Expand All @@ -1090,7 +1090,44 @@
],
"source": {
"path": "x-pack/plugins/cases/common/api/helpers.ts",
"lineNumber": 47
"lineNumber": 48
},
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.getCasesFromAlertsUrl",
"type": "Function",
"tags": [],
"label": "getCasesFromAlertsUrl",
"description": [],
"signature": [
"(alertId: string) => string"
],
"source": {
"path": "x-pack/plugins/cases/common/api/helpers.ts",
"lineNumber": 52
},
"deprecated": false,
"children": [
{
"parentPluginId": "cases",
"id": "def-common.getCasesFromAlertsUrl.$1",
"type": "string",
"tags": [],
"label": "alertId",
"description": [],
"signature": [
"string"
],
"source": {
"path": "x-pack/plugins/cases/common/api/helpers.ts",
"lineNumber": 52
},
"deprecated": false,
"isRequired": true
Expand All @@ -1111,7 +1148,7 @@
],
"source": {
"path": "x-pack/plugins/cases/common/api/helpers.ts",
"lineNumber": 39
"lineNumber": 40
},
"deprecated": false,
"children": [
Expand All @@ -1127,7 +1164,7 @@
],
"source": {
"path": "x-pack/plugins/cases/common/api/helpers.ts",
"lineNumber": 39
"lineNumber": 40
},
"deprecated": false,
"isRequired": true
Expand All @@ -1148,7 +1185,7 @@
],
"source": {
"path": "x-pack/plugins/cases/common/api/helpers.ts",
"lineNumber": 27
"lineNumber": 28
},
"deprecated": false,
"children": [
Expand All @@ -1164,7 +1201,7 @@
],
"source": {
"path": "x-pack/plugins/cases/common/api/helpers.ts",
"lineNumber": 27
"lineNumber": 28
},
"deprecated": false,
"isRequired": true
Expand All @@ -1181,7 +1218,7 @@
],
"source": {
"path": "x-pack/plugins/cases/common/api/helpers.ts",
"lineNumber": 27
"lineNumber": 28
},
"deprecated": false,
"isRequired": true
Expand All @@ -1202,7 +1239,7 @@
],
"source": {
"path": "x-pack/plugins/cases/common/api/helpers.ts",
"lineNumber": 23
"lineNumber": 24
},
"deprecated": false,
"children": [
Expand All @@ -1218,7 +1255,7 @@
],
"source": {
"path": "x-pack/plugins/cases/common/api/helpers.ts",
"lineNumber": 23
"lineNumber": 24
},
"deprecated": false,
"isRequired": true
Expand All @@ -1239,7 +1276,7 @@
],
"source": {
"path": "x-pack/plugins/cases/common/api/helpers.ts",
"lineNumber": 43
"lineNumber": 44
},
"deprecated": false,
"children": [
Expand All @@ -1255,7 +1292,7 @@
],
"source": {
"path": "x-pack/plugins/cases/common/api/helpers.ts",
"lineNumber": 43
"lineNumber": 44
},
"deprecated": false,
"isRequired": true
Expand All @@ -1272,7 +1309,7 @@
],
"source": {
"path": "x-pack/plugins/cases/common/api/helpers.ts",
"lineNumber": 43
"lineNumber": 44
},
"deprecated": false,
"isRequired": true
Expand Down
70 changes: 35 additions & 35 deletions api_docs/core.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9397,6 +9397,20 @@
"lineNumber": 67
}
},
{
"plugin": "lists",
"link": {
"path": "x-pack/plugins/lists/server/routes/read_privileges_route.ts",
"lineNumber": 31
}
},
{
"plugin": "lists",
"link": {
"path": "x-pack/plugins/lists/server/routes/read_privileges_route.ts",
"lineNumber": 35
}
},
{
"plugin": "securitySolution",
"link": {
Expand Down Expand Up @@ -9425,20 +9439,6 @@
"lineNumber": 39
}
},
{
"plugin": "lists",
"link": {
"path": "x-pack/plugins/lists/server/routes/read_privileges_route.ts",
"lineNumber": 31
}
},
{
"plugin": "lists",
"link": {
"path": "x-pack/plugins/lists/server/routes/read_privileges_route.ts",
"lineNumber": 35
}
},
{
"plugin": "beatsManagement",
"link": {
Expand Down Expand Up @@ -10314,7 +10314,7 @@
"plugin": "fleet",
"link": {
"path": "x-pack/plugins/fleet/server/plugin.ts",
"lineNumber": 15
"lineNumber": 14
}
},
{
Expand All @@ -10335,7 +10335,7 @@
"plugin": "fleet",
"link": {
"path": "x-pack/plugins/fleet/target/types/server/plugin.d.ts",
"lineNumber": 83
"lineNumber": 84
}
}
],
Expand Down Expand Up @@ -15951,45 +15951,45 @@
"removeBy": "7.16",
"references": [
{
"plugin": "securitySolution",
"plugin": "lists",
"link": {
"path": "x-pack/plugins/security_solution/server/lib/telemetry/sender.ts",
"lineNumber": 10
"path": "x-pack/plugins/lists/server/schemas/common/get_call_cluster.mock.ts",
"lineNumber": 9
}
},
{
"plugin": "securitySolution",
"plugin": "lists",
"link": {
"path": "x-pack/plugins/security_solution/server/lib/telemetry/sender.ts",
"lineNumber": 447
"path": "x-pack/plugins/lists/server/schemas/common/get_call_cluster.mock.ts",
"lineNumber": 27
}
},
{
"plugin": "securitySolution",
"plugin": "lists",
"link": {
"path": "x-pack/plugins/security_solution/server/lib/telemetry/sender.ts",
"lineNumber": 466
"path": "x-pack/plugins/lists/server/schemas/common/get_call_cluster.mock.ts",
"lineNumber": 31
}
},
{
"plugin": "lists",
"plugin": "securitySolution",
"link": {
"path": "x-pack/plugins/lists/server/schemas/common/get_call_cluster.mock.ts",
"lineNumber": 9
"path": "x-pack/plugins/security_solution/server/lib/telemetry/sender.ts",
"lineNumber": 10
}
},
{
"plugin": "lists",
"plugin": "securitySolution",
"link": {
"path": "x-pack/plugins/lists/server/schemas/common/get_call_cluster.mock.ts",
"lineNumber": 27
"path": "x-pack/plugins/security_solution/server/lib/telemetry/sender.ts",
"lineNumber": 447
}
},
{
"plugin": "lists",
"plugin": "securitySolution",
"link": {
"path": "x-pack/plugins/lists/server/schemas/common/get_call_cluster.mock.ts",
"lineNumber": 31
"path": "x-pack/plugins/security_solution/server/lib/telemetry/sender.ts",
"lineNumber": 466
}
},
{
Expand Down Expand Up @@ -22535,7 +22535,7 @@
"label": "EcsEventCategory",
"description": [],
"signature": [
"\"host\" | \"database\" | \"package\" | \"session\" | \"file\" | \"network\" | \"process\" | \"registry\" | \"web\" | \"authentication\" | \"configuration\" | \"driver\" | \"iam\" | \"intrusion_detection\" | \"malware\""
"\"host\" | \"database\" | \"package\" | \"session\" | \"registry\" | \"network\" | \"web\" | \"file\" | \"process\" | \"authentication\" | \"configuration\" | \"driver\" | \"iam\" | \"intrusion_detection\" | \"malware\""
],
"source": {
"path": "node_modules/@kbn/logging/target/ecs/event.d.ts",
Expand Down
6 changes: 3 additions & 3 deletions api_docs/core_application.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1750,7 +1750,7 @@
"plugin": "lens",
"link": {
"path": "x-pack/plugins/lens/public/app_plugin/types.ts",
"lineNumber": 75
"lineNumber": 71
}
},
{
Expand All @@ -1771,7 +1771,7 @@
"plugin": "maps",
"link": {
"path": "x-pack/plugins/maps/public/routes/map_page/map_app/map_app.tsx",
"lineNumber": 60
"lineNumber": 59
}
},
{
Expand Down Expand Up @@ -1855,7 +1855,7 @@
"plugin": "maps",
"link": {
"path": "x-pack/plugins/maps/target/types/public/routes/map_page/map_app/map_app.d.ts",
"lineNumber": 14
"lineNumber": 13
}
}
],
Expand Down
Loading

0 comments on commit 05af8a0

Please sign in to comment.