* update api_docs from gitignore * api doc files * Update api_welcome.mdx * Pretty print json * Add new lines and extra frontmatter to warn github viewers * update api_docs with new lines and frontmatter * Remove all apis tagged @internal and add tests * Update docs with all internal APIs removed * fix typescript error in test fixtures * Update core.json Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com> # Conflicts: # api_docs/core.json # api_docs/core_application.json # api_docs/core_http.json # api_docs/core_saved_objects.json
207 lines
6.8 KiB
JSON
207 lines
6.8 KiB
JSON
{
|
|
"id": "ingestPipelines",
|
|
"client": {
|
|
"classes": [
|
|
{
|
|
"id": "def-public.IngestPipelinesUrlGenerator",
|
|
"type": "Class",
|
|
"tags": [],
|
|
"label": "IngestPipelinesUrlGenerator",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "ingestPipelines",
|
|
"scope": "public",
|
|
"docId": "kibIngestPipelinesPluginApi",
|
|
"section": "def-public.IngestPipelinesUrlGenerator",
|
|
"text": "IngestPipelinesUrlGenerator"
|
|
},
|
|
" implements ",
|
|
{
|
|
"pluginId": "share",
|
|
"scope": "public",
|
|
"docId": "kibSharePluginApi",
|
|
"section": "def-public.UrlGeneratorsDefinition",
|
|
"text": "UrlGeneratorsDefinition"
|
|
},
|
|
"<\"INGEST_PIPELINES_APP_URL_GENERATOR\">"
|
|
],
|
|
"children": [
|
|
{
|
|
"id": "def-public.IngestPipelinesUrlGenerator.Unnamed",
|
|
"type": "Function",
|
|
"label": "Constructor",
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"type": "Function",
|
|
"label": "getAppBasePath",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"(absolute: boolean) => Promise<string>"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/ingest_pipelines/public/url_generator.ts",
|
|
"lineNumber": 57,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/ingest_pipelines/public/url_generator.ts#L57"
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/ingest_pipelines/public/url_generator.ts",
|
|
"lineNumber": 57,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/ingest_pipelines/public/url_generator.ts#L57"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.IngestPipelinesUrlGenerator.id",
|
|
"type": "string",
|
|
"label": "id",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/ingest_pipelines/public/url_generator.ts",
|
|
"lineNumber": 59,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/ingest_pipelines/public/url_generator.ts#L59"
|
|
},
|
|
"signature": [
|
|
"\"INGEST_PIPELINES_APP_URL_GENERATOR\""
|
|
]
|
|
},
|
|
{
|
|
"id": "def-public.IngestPipelinesUrlGenerator.createUrl",
|
|
"type": "Function",
|
|
"children": [
|
|
{
|
|
"type": "CompoundType",
|
|
"label": "state",
|
|
"isRequired": true,
|
|
"signature": [
|
|
{
|
|
"pluginId": "ingestPipelines",
|
|
"scope": "public",
|
|
"docId": "kibIngestPipelinesPluginApi",
|
|
"section": "def-public.IngestPipelinesUrlGeneratorState",
|
|
"text": "IngestPipelinesUrlGeneratorState"
|
|
}
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/ingest_pipelines/public/url_generator.ts",
|
|
"lineNumber": 61,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/ingest_pipelines/public/url_generator.ts#L61"
|
|
}
|
|
}
|
|
],
|
|
"signature": [
|
|
"(state: ",
|
|
{
|
|
"pluginId": "ingestPipelines",
|
|
"scope": "public",
|
|
"docId": "kibIngestPipelinesPluginApi",
|
|
"section": "def-public.IngestPipelinesUrlGeneratorState",
|
|
"text": "IngestPipelinesUrlGeneratorState"
|
|
},
|
|
") => Promise<string>"
|
|
],
|
|
"description": [],
|
|
"label": "createUrl",
|
|
"source": {
|
|
"path": "x-pack/plugins/ingest_pipelines/public/url_generator.ts",
|
|
"lineNumber": 61,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/ingest_pipelines/public/url_generator.ts#L61"
|
|
},
|
|
"tags": [],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/ingest_pipelines/public/url_generator.ts",
|
|
"lineNumber": 55,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/ingest_pipelines/public/url_generator.ts#L55"
|
|
},
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [
|
|
{
|
|
"id": "def-public.INGEST_PIPELINES_PAGES",
|
|
"type": "Enum",
|
|
"label": "INGEST_PIPELINES_PAGES",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/ingest_pipelines/public/url_generator.ts",
|
|
"lineNumber": 22,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/ingest_pipelines/public/url_generator.ts#L22"
|
|
},
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"misc": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.INGEST_PIPELINES_APP_ULR_GENERATOR",
|
|
"type": "string",
|
|
"label": "INGEST_PIPELINES_APP_ULR_GENERATOR",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/ingest_pipelines/public/url_generator.ts",
|
|
"lineNumber": 20,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/ingest_pipelines/public/url_generator.ts#L20"
|
|
},
|
|
"signature": [
|
|
"\"INGEST_PIPELINES_APP_URL_GENERATOR\""
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-public.IngestPipelinesUrlGeneratorState",
|
|
"type": "Type",
|
|
"label": "IngestPipelinesUrlGeneratorState",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/ingest_pipelines/public/url_generator.ts",
|
|
"lineNumber": 49,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/ingest_pipelines/public/url_generator.ts#L49"
|
|
},
|
|
"signature": [
|
|
"PipelinesListUrlGeneratorState",
|
|
" | ",
|
|
"PipelineEditUrlGeneratorState",
|
|
" | ",
|
|
"PipelineCloneUrlGeneratorState",
|
|
" | ",
|
|
"PipelineCreateUrlGeneratorState"
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"objects": []
|
|
},
|
|
"server": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
},
|
|
"common": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
}
|
|
} |