maxmustermann/kibana
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
kibana/api_docs/runtime_fields.json
Stacey Gammon 503cfcf8c9
Track API stats as part of ci (#95733) 
* Track stats and add extra output information

* Update api docs output

* Clean up id names

* update api docs

* Consolidate error messages and fix a bug

* Update docs

* Update get_declaration_nodes_for_plugin.ts

* Fix bug with removeBrokenLinks not being recursive

* Update docs

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2021-04-15 11:36:10 -04:00

415 lines
13 KiB
JSON
Raw Blame History

{
"id": "runtimeFields",
"client": {
"classes": [],
"functions": [
{
"id": "def-public.RuntimeFieldEditor",
"type": "Function",
"children": [
{
"id": "def-public.RuntimeFieldEditor.$1",
"type": "Object",
"label": "{ defaultValue, onChange, docLinks, ctx }",
"isRequired": true,
"signature": [
{
"pluginId": "runtimeFields",
"scope": "public",
"docId": "kibRuntimeFieldsPluginApi",
"section": "def-public.Props",
"text": "Props"
}
],
"description": [],
"source": {
"path": "x-pack/plugins/runtime_fields/public/components/runtime_field_editor/runtime_field_editor.tsx",
"lineNumber": 22
}
}
],
"signature": [
"({ defaultValue, onChange, docLinks, ctx }: ",
{
"pluginId": "runtimeFields",
"scope": "public",
"docId": "kibRuntimeFieldsPluginApi",
"section": "def-public.Props",
"text": "Props"
},
") => JSX.Element"
],
"description": [],
"label": "RuntimeFieldEditor",
"source": {
"path": "x-pack/plugins/runtime_fields/public/components/runtime_field_editor/runtime_field_editor.tsx",
"lineNumber": 22
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
},
{
"id": "def-public.RuntimeFieldEditorFlyoutContent",
"type": "Function",
"children": [
{
"id": "def-public.RuntimeFieldEditorFlyoutContent.$1",
"type": "Object",
"label": "{\n onSave,\n onCancel,\n docLinks,\n defaultValue: field,\n ctx,\n}",
"isRequired": true,
"signature": [
{
"pluginId": "runtimeFields",
"scope": "public",
"docId": "kibRuntimeFieldsPluginApi",
"section": "def-public.Props",
"text": "Props"
}
],
"description": [],
"source": {
"path": "x-pack/plugins/runtime_fields/public/components/runtime_field_editor_flyout_content/runtime_field_editor_flyout_content.tsx",
"lineNumber": 78
}
}
],
"signature": [
"({ onSave, onCancel, docLinks, defaultValue: field, ctx, }: ",
{
"pluginId": "runtimeFields",
"scope": "public",
"docId": "kibRuntimeFieldsPluginApi",
"section": "def-public.Props",
"text": "Props"
},
") => JSX.Element"
],
"description": [],
"label": "RuntimeFieldEditorFlyoutContent",
"source": {
"path": "x-pack/plugins/runtime_fields/public/components/runtime_field_editor_flyout_content/runtime_field_editor_flyout_content.tsx",
"lineNumber": 78
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
{
"id": "def-public.FormState",
"type": "Interface",
"label": "FormState",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.FormState.isValid",
"type": "CompoundType",
"label": "isValid",
"description": [],
"source": {
"path": "x-pack/plugins/runtime_fields/public/components/runtime_field_form/runtime_field_form.tsx",
"lineNumber": 40
},
"signature": [
"boolean | undefined"
]
},
{
"tags": [],
"id": "def-public.FormState.isSubmitted",
"type": "boolean",
"label": "isSubmitted",
"description": [],
"source": {
"path": "x-pack/plugins/runtime_fields/public/components/runtime_field_form/runtime_field_form.tsx",
"lineNumber": 41
}
},
{
"tags": [],
"id": "def-public.FormState.submit",
"type": "Function",
"label": "submit",
"description": [],
"source": {
"path": "x-pack/plugins/runtime_fields/public/components/runtime_field_form/runtime_field_form.tsx",
"lineNumber": 42
},
"signature": [
"(e?: React.FormEvent<HTMLFormElement> | React.MouseEvent<Element, MouseEvent> | undefined) => Promise<{ data: ",
{
"pluginId": "runtimeFields",
"scope": "public",
"docId": "kibRuntimeFieldsPluginApi",
"section": "def-public.RuntimeField",
"text": "RuntimeField"
},
"; isValid: boolean; }>"
]
}
],
"source": {
"path": "x-pack/plugins/runtime_fields/public/components/runtime_field_form/runtime_field_form.tsx",
"lineNumber": 39
},
"initialIsOpen": false
},
{
"id": "def-public.Props",
"type": "Interface",
"label": "Props",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.Props.onSave",
"type": "Function",
"label": "onSave",
"description": [
"\nHandler for the \"save\" footer button"
],
"source": {
"path": "x-pack/plugins/runtime_fields/public/components/runtime_field_editor_flyout_content/runtime_field_editor_flyout_content.tsx",
"lineNumber": 59
},
"signature": [
"(field: ",
{
"pluginId": "runtimeFields",
"scope": "public",
"docId": "kibRuntimeFieldsPluginApi",
"section": "def-public.RuntimeField",
"text": "RuntimeField"
},
") => void"
]
},
{
"tags": [],
"id": "def-public.Props.onCancel",
"type": "Function",
"label": "onCancel",
"description": [
"\nHandler for the \"cancel\" footer button"
],
"source": {
"path": "x-pack/plugins/runtime_fields/public/components/runtime_field_editor_flyout_content/runtime_field_editor_flyout_content.tsx",
"lineNumber": 63
},
"signature": [
"() => void"
]
},
{
"tags": [],
"id": "def-public.Props.docLinks",
"type": "Object",
"label": "docLinks",
"description": [
"\nThe docLinks start service from core"
],
"source": {
"path": "x-pack/plugins/runtime_fields/public/components/runtime_field_editor_flyout_content/runtime_field_editor_flyout_content.tsx",
"lineNumber": 67
},
"signature": [
{
"pluginId": "core",
"scope": "public",
"docId": "kibCorePluginApi",
"section": "def-public.DocLinksStart",
"text": "DocLinksStart"
}
]
},
{
"tags": [],
"id": "def-public.Props.defaultValue",
"type": "Object",
"label": "defaultValue",
"description": [
"\nAn optional runtime field to edit"
],
"source": {
"path": "x-pack/plugins/runtime_fields/public/components/runtime_field_editor_flyout_content/runtime_field_editor_flyout_content.tsx",
"lineNumber": 71
},
"signature": [
{
"pluginId": "runtimeFields",
"scope": "public",
"docId": "kibRuntimeFieldsPluginApi",
"section": "def-public.RuntimeField",
"text": "RuntimeField"
},
" | undefined"
]
},
{
"tags": [],
"id": "def-public.Props.ctx",
"type": "Object",
"label": "ctx",
"description": [
"\nOptional context object"
],
"source": {
"path": "x-pack/plugins/runtime_fields/public/components/runtime_field_editor_flyout_content/runtime_field_editor_flyout_content.tsx",
"lineNumber": 75
},
"signature": [
"{ namesNotAllowed?: string[] | undefined; existingConcreteFields?: Field[] | undefined; } | undefined"
]
}
],
"source": {
"path": "x-pack/plugins/runtime_fields/public/components/runtime_field_editor_flyout_content/runtime_field_editor_flyout_content.tsx",
"lineNumber": 55
},
"initialIsOpen": false
},
{
"id": "def-public.RuntimeField",
"type": "Interface",
"label": "RuntimeField",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.RuntimeField.name",
"type": "string",
"label": "name",
"description": [],
"source": {
"path": "x-pack/plugins/runtime_fields/public/types.ts",
"lineNumber": 34
}
},
{
"tags": [],
"id": "def-public.RuntimeField.type",
"type": "CompoundType",
"label": "type",
"description": [],
"source": {
"path": "x-pack/plugins/runtime_fields/public/types.ts",
"lineNumber": 35
},
"signature": [
"\"boolean\" | \"date\" | \"keyword\" | \"ip\" | \"long\" | \"double\""
]
},
{
"tags": [],
"id": "def-public.RuntimeField.script",
"type": "Object",
"label": "script",
"description": [],
"source": {
"path": "x-pack/plugins/runtime_fields/public/types.ts",
"lineNumber": 36
},
"signature": [
"{ source: string; }"
]
}
],
"source": {
"path": "x-pack/plugins/runtime_fields/public/types.ts",
"lineNumber": 33
},
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"tags": [],
"id": "def-public.RUNTIME_FIELD_OPTIONS",
"type": "Array",
"label": "RUNTIME_FIELD_OPTIONS",
"description": [],
"source": {
"path": "x-pack/plugins/runtime_fields/public/constants.ts",
"lineNumber": 14
},
"signature": [
"ComboBoxOption",
"<\"boolean\" | \"date\" | \"keyword\" | \"ip\" | \"long\" | \"double\">[]"
],
"initialIsOpen": false
},
{
"id": "def-public.RuntimeType",
"type": "Type",
"label": "RuntimeType",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/runtime_fields/public/types.ts",
"lineNumber": 31
},
"signature": [
"\"boolean\" | \"date\" | \"keyword\" | \"ip\" | \"long\" | \"double\""
],
"initialIsOpen": false
}
],
"objects": [],
"setup": {
"id": "def-public.PluginSetup",
"type": "Interface",
"label": "PluginSetup",
"description": [],
"tags": [],
"children": [
{
"id": "def-public.PluginSetup.loadEditor",
"type": "Function",
"label": "loadEditor",
"signature": [
"() => Promise<",
"LoadEditorResponse",
">"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/runtime_fields/public/types.ts",
"lineNumber": 18
}
}
],
"source": {
"path": "x-pack/plugins/runtime_fields/public/types.ts",
"lineNumber": 17
},
"lifecycle": "setup",
"initialIsOpen": true
}
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
}
}
Reference in a new issue View git blame Copy permalink