kibana/api_docs/osquery.json
Stacey Gammon 2117e1324c
API DOCS Step 3/3 (#92929) (#93530)
* 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
2021-03-03 20:12:24 -05:00

152 lines
4.1 KiB
JSON

{
"id": "osquery",
"client": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": [],
"setup": {
"id": "def-public.OsqueryPluginSetup",
"type": "Interface",
"label": "OsqueryPluginSetup",
"description": [],
"tags": [],
"children": [],
"source": {
"path": "x-pack/plugins/osquery/public/types.ts",
"lineNumber": 14,
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/osquery/public/types.ts#L14"
},
"lifecycle": "setup",
"initialIsOpen": true
},
"start": {
"id": "def-public.OsqueryPluginStart",
"type": "Interface",
"label": "OsqueryPluginStart",
"description": [],
"tags": [],
"children": [],
"source": {
"path": "x-pack/plugins/osquery/public/types.ts",
"lineNumber": 16,
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/osquery/public/types.ts#L16"
},
"lifecycle": "start",
"initialIsOpen": true
}
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": [],
"setup": {
"id": "def-server.OsqueryPluginSetup",
"type": "Interface",
"label": "OsqueryPluginSetup",
"description": [],
"tags": [],
"children": [],
"source": {
"path": "x-pack/plugins/osquery/server/types.ts",
"lineNumber": 15,
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/osquery/server/types.ts#L15"
},
"lifecycle": "setup",
"initialIsOpen": true
},
"start": {
"id": "def-server.OsqueryPluginStart",
"type": "Interface",
"label": "OsqueryPluginStart",
"description": [],
"tags": [],
"children": [],
"source": {
"path": "x-pack/plugins/osquery/server/types.ts",
"lineNumber": 17,
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/osquery/server/types.ts#L17"
},
"lifecycle": "start",
"initialIsOpen": true
}
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [
{
"tags": [],
"id": "def-common.PLUGIN_ID",
"type": "string",
"label": "PLUGIN_ID",
"description": [],
"source": {
"path": "x-pack/plugins/osquery/common/index.ts",
"lineNumber": 10,
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/osquery/common/index.ts#L10"
},
"signature": [
"\"osquery\""
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.PLUGIN_NAME",
"type": "string",
"label": "PLUGIN_NAME",
"description": [],
"source": {
"path": "x-pack/plugins/osquery/common/index.ts",
"lineNumber": 11,
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/osquery/common/index.ts#L11"
},
"signature": [
"\"osquery\""
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.DEFAULT_MAX_TABLE_QUERY_SIZE",
"type": "number",
"label": "DEFAULT_MAX_TABLE_QUERY_SIZE",
"description": [],
"source": {
"path": "x-pack/plugins/osquery/common/constants.ts",
"lineNumber": 8,
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/osquery/common/constants.ts#L8"
},
"signature": [
"10000"
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.DEFAULT_DARK_MODE",
"type": "string",
"label": "DEFAULT_DARK_MODE",
"description": [],
"source": {
"path": "x-pack/plugins/osquery/common/constants.ts",
"lineNumber": 9,
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/osquery/common/constants.ts#L9"
},
"signature": [
"\"theme:darkMode\""
],
"initialIsOpen": false
}
],
"objects": []
}
}