github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-06-27 18:51:07 -04:00
Code Issues Projects Releases Packages Wiki Activity
kibana/api_docs/kbn_search_index_documents.devdocs.json

624 lines
No EOL
22 KiB
JSON
Raw Blame History

{
"id": "@kbn/search-index-documents",
"client": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [
{
"parentPluginId": "@kbn/search-index-documents",
"id": "def-common.DocumentList",
"type": "Function",
"tags": [],
"label": "DocumentList",
"description": [],
"signature": [
"({ executionTime, dataTelemetryIdPrefix, docs, docsPerPage, isLoading, mappings, meta, onPaginate, setDocsPerPage, onDocumentClick, resultProps, }: DocumentListProps) => React.JSX.Element"
],
"path": "x-pack/platform/packages/shared/kbn-search-index-documents/components/document_list.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/search-index-documents",
"id": "def-common.DocumentList.$1",
"type": "Object",
"tags": [],
"label": "{\n executionTime,\n dataTelemetryIdPrefix,\n docs,\n docsPerPage,\n isLoading,\n mappings,\n meta,\n onPaginate,\n setDocsPerPage,\n onDocumentClick,\n resultProps = {},\n}",
"description": [],
"signature": [
"DocumentListProps"
],
"path": "x-pack/platform/packages/shared/kbn-search-index-documents/components/document_list.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/search-index-documents",
"id": "def-common.DocumentsOverview",
"type": "Function",
"tags": [],
"label": "DocumentsOverview",
"description": [],
"signature": [
"({ accessControlSwitch, dataTelemetryIdPrefix, documentComponent, searchQueryCallback, }: DocumentsProps) => React.JSX.Element"
],
"path": "x-pack/platform/packages/shared/kbn-search-index-documents/components/documents_overview.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/search-index-documents",
"id": "def-common.DocumentsOverview.$1",
"type": "Object",
"tags": [],
"label": "{\n accessControlSwitch,\n dataTelemetryIdPrefix,\n documentComponent,\n searchQueryCallback,\n}",
"description": [],
"signature": [
"DocumentsProps"
],
"path": "x-pack/platform/packages/shared/kbn-search-index-documents/components/documents_overview.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/search-index-documents",
"id": "def-common.fetchSearchResults",
"type": "Function",
"tags": [],
"label": "fetchSearchResults",
"description": [],
"signature": [
"(client: ",
"ElasticsearchClient",
", indexName: string, query?: string | undefined, from?: number, size?: number, trackTotalHits?: boolean | undefined) => Promise<",
{
"pluginId": "@kbn/search-index-documents",
"scope": "common",
"docId": "kibKbnSearchIndexDocumentsPluginApi",
"section": "def-common.Paginate",
"text": "Paginate"
},
"<",
"SearchHit",
"<unknown>>>"
],
"path": "x-pack/platform/packages/shared/kbn-search-index-documents/lib/fetch_search_results.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/search-index-documents",
"id": "def-common.fetchSearchResults.$1",
"type": "Object",
"tags": [],
"label": "client",
"description": [],
"signature": [
"ElasticsearchClient"
],
"path": "x-pack/platform/packages/shared/kbn-search-index-documents/lib/fetch_search_results.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/search-index-documents",
"id": "def-common.fetchSearchResults.$2",
"type": "string",
"tags": [],
"label": "indexName",
"description": [],
"signature": [
"string"
],
"path": "x-pack/platform/packages/shared/kbn-search-index-documents/lib/fetch_search_results.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/search-index-documents",
"id": "def-common.fetchSearchResults.$3",
"type": "string",
"tags": [],
"label": "query",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/packages/shared/kbn-search-index-documents/lib/fetch_search_results.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
},
{
"parentPluginId": "@kbn/search-index-documents",
"id": "def-common.fetchSearchResults.$4",
"type": "number",
"tags": [],
"label": "from",
"description": [],
"signature": [
"number"
],
"path": "x-pack/platform/packages/shared/kbn-search-index-documents/lib/fetch_search_results.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/search-index-documents",
"id": "def-common.fetchSearchResults.$5",
"type": "number",
"tags": [],
"label": "size",
"description": [],
"signature": [
"number"
],
"path": "x-pack/platform/packages/shared/kbn-search-index-documents/lib/fetch_search_results.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/search-index-documents",
"id": "def-common.fetchSearchResults.$6",
"type": "CompoundType",
"tags": [],
"label": "trackTotalHits",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/platform/packages/shared/kbn-search-index-documents/lib/fetch_search_results.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/search-index-documents",
"id": "def-common.pageToPagination",
"type": "Function",
"tags": [],
"label": "pageToPagination",
"description": [],
"signature": [
"(page: { from: number; size: number; total: number; }) => { pageIndex: number; pageSize: number; totalItemCount: number; }"
],
"path": "x-pack/platform/packages/shared/kbn-search-index-documents/types/pagination.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/search-index-documents",
"id": "def-common.pageToPagination.$1",
"type": "Object",
"tags": [],
"label": "page",
"description": [],
"path": "x-pack/platform/packages/shared/kbn-search-index-documents/types/pagination.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/search-index-documents",
"id": "def-common.pageToPagination.$1.from",
"type": "number",
"tags": [],
"label": "from",
"description": [],
"path": "x-pack/platform/packages/shared/kbn-search-index-documents/types/pagination.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/search-index-documents",
"id": "def-common.pageToPagination.$1.size",
"type": "number",
"tags": [],
"label": "size",
"description": [],
"path": "x-pack/platform/packages/shared/kbn-search-index-documents/types/pagination.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/search-index-documents",
"id": "def-common.pageToPagination.$1.total",
"type": "number",
"tags": [],
"label": "total",
"description": [],
"path": "x-pack/platform/packages/shared/kbn-search-index-documents/types/pagination.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/search-index-documents",
"id": "def-common.reorderFieldsInImportance",
"type": "Function",
"tags": [],
"label": "reorderFieldsInImportance",
"description": [
"\nReorders an array of fields based on their importance.\n\nThe function sorts the fields by checking if their names are in the `SPECIAL_NAME_FIELDS` array first and then by\ntheir mapping type (semantic_text, dense_vector, sparse_vector) if they are not in the `SPECIAL_NAME_FIELDS` array.\n"
],
"signature": [
"(fields: ",
"FieldProps",
"[]) => ",
"FieldProps",
"[]"
],
"path": "x-pack/platform/packages/shared/kbn-search-index-documents/components/result/result_metadata.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/search-index-documents",
"id": "def-common.reorderFieldsInImportance.$1",
"type": "Array",
"tags": [],
"label": "fields",
"description": [
"- An array of field properties to be reordered."
],
"signature": [
"FieldProps",
"[]"
],
"path": "x-pack/platform/packages/shared/kbn-search-index-documents/components/result/result_metadata.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [
"The reordered array of field properties."
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/search-index-documents",
"id": "def-common.Result",
"type": "Function",
"tags": [],
"label": "Result",
"description": [],
"signature": [
"({ metaData, fields, defaultVisibleFields, compactCard, showScore, onDocumentClick, onDocumentDelete, hasDeleteDocumentsPrivilege, }: ",
"ResultProps",
") => React.JSX.Element"
],
"path": "x-pack/platform/packages/shared/kbn-search-index-documents/components/result/result.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/search-index-documents",
"id": "def-common.Result.$1",
"type": "Object",
"tags": [],
"label": "{\n metaData,\n fields,\n defaultVisibleFields = DEFAULT_VISIBLE_FIELDS,\n compactCard = true,\n showScore = false,\n onDocumentClick,\n onDocumentDelete,\n hasDeleteDocumentsPrivilege,\n}",
"description": [],
"signature": [
"ResultProps"
],
"path": "x-pack/platform/packages/shared/kbn-search-index-documents/components/result/result.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/search-index-documents",
"id": "def-common.resultMetaData",
"type": "Function",
"tags": [],
"label": "resultMetaData",
"description": [],
"signature": [
"(result: ",
"SearchHit",
"<unknown>) => ",
"MetaDataProps"
],
"path": "x-pack/platform/packages/shared/kbn-search-index-documents/components/result/result_metadata.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/search-index-documents",
"id": "def-common.resultMetaData.$1",
"type": "Object",
"tags": [],
"label": "result",
"description": [],
"signature": [
"SearchHit",
"<unknown>"
],
"path": "x-pack/platform/packages/shared/kbn-search-index-documents/components/result/result_metadata.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/search-index-documents",
"id": "def-common.resultToFieldFromMappingResponse",
"type": "Function",
"tags": [],
"label": "resultToFieldFromMappingResponse",
"description": [],
"signature": [
"(result: ",
"SearchHit",
"<unknown>, mappings?: ",
"IndicesGetMappingResponse",
" | undefined) => ",
"FieldProps",
"[]"
],
"path": "x-pack/platform/packages/shared/kbn-search-index-documents/components/result/result_metadata.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/search-index-documents",
"id": "def-common.resultToFieldFromMappingResponse.$1",
"type": "Object",
"tags": [],
"label": "result",
"description": [],
"signature": [
"SearchHit",
"<unknown>"
],
"path": "x-pack/platform/packages/shared/kbn-search-index-documents/components/result/result_metadata.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/search-index-documents",
"id": "def-common.resultToFieldFromMappingResponse.$2",
"type": "Object",
"tags": [],
"label": "mappings",
"description": [],
"signature": [
"IndicesGetMappingResponse",
" | undefined"
],
"path": "x-pack/platform/packages/shared/kbn-search-index-documents/components/result/result_metadata.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/search-index-documents",
"id": "def-common.resultToFieldFromMappings",
"type": "Function",
"tags": [],
"label": "resultToFieldFromMappings",
"description": [],
"signature": [
"(result: ",
"SearchHit",
"<unknown>, mappings?: Record<string, ",
"MappingProperty",
"> | undefined) => ",
"FieldProps",
"[]"
],
"path": "x-pack/platform/packages/shared/kbn-search-index-documents/components/result/result_metadata.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/search-index-documents",
"id": "def-common.resultToFieldFromMappings.$1",
"type": "Object",
"tags": [],
"label": "result",
"description": [],
"signature": [
"SearchHit",
"<unknown>"
],
"path": "x-pack/platform/packages/shared/kbn-search-index-documents/components/result/result_metadata.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/search-index-documents",
"id": "def-common.resultToFieldFromMappings.$2",
"type": "Object",
"tags": [],
"label": "mappings",
"description": [],
"signature": [
"Record<string, ",
"MappingProperty",
"> | undefined"
],
"path": "x-pack/platform/packages/shared/kbn-search-index-documents/components/result/result_metadata.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
{
"parentPluginId": "@kbn/search-index-documents",
"id": "def-common.Paginate",
"type": "Interface",
"tags": [],
"label": "Paginate",
"description": [],
"signature": [
{
"pluginId": "@kbn/search-index-documents",
"scope": "common",
"docId": "kibKbnSearchIndexDocumentsPluginApi",
"section": "def-common.Paginate",
"text": "Paginate"
},
"<T>"
],
"path": "x-pack/platform/packages/shared/kbn-search-index-documents/types/pagination.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/search-index-documents",
"id": "def-common.Paginate._meta",
"type": "Object",
"tags": [],
"label": "_meta",
"description": [],
"signature": [
"Meta"
],
"path": "x-pack/platform/packages/shared/kbn-search-index-documents/types/pagination.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/search-index-documents",
"id": "def-common.Paginate.data",
"type": "Array",
"tags": [],
"label": "data",
"description": [],
"signature": [
"T[]"
],
"path": "x-pack/platform/packages/shared/kbn-search-index-documents/types/pagination.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"parentPluginId": "@kbn/search-index-documents",
"id": "def-common.DEFAULT_DOCS_PER_PAGE",
"type": "number",
"tags": [],
"label": "DEFAULT_DOCS_PER_PAGE",
"description": [],
"signature": [
"25"
],
"path": "x-pack/platform/packages/shared/kbn-search-index-documents/types/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": [
{
"parentPluginId": "@kbn/search-index-documents",
"id": "def-common.INDEX_DOCUMENTS_META_DEFAULT",
"type": "Object",
"tags": [],
"label": "INDEX_DOCUMENTS_META_DEFAULT",
"description": [],
"path": "x-pack/platform/packages/shared/kbn-search-index-documents/types/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/search-index-documents",
"id": "def-common.INDEX_DOCUMENTS_META_DEFAULT.pageIndex",
"type": "number",
"tags": [],
"label": "pageIndex",
"description": [],
"path": "x-pack/platform/packages/shared/kbn-search-index-documents/types/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/search-index-documents",
"id": "def-common.INDEX_DOCUMENTS_META_DEFAULT.pageSize",
"type": "number",
"tags": [],
"label": "pageSize",
"description": [],
"path": "x-pack/platform/packages/shared/kbn-search-index-documents/types/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/search-index-documents",
"id": "def-common.INDEX_DOCUMENTS_META_DEFAULT.totalItemCount",
"type": "number",
"tags": [],
"label": "totalItemCount",
"description": [],
"path": "x-pack/platform/packages/shared/kbn-search-index-documents/types/index.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
]
}
}
Reference in a new issue View git blame Copy permalink