diff --git a/api_docs/fleet.json b/api_docs/fleet.json index 39aae52d445f0..fc5c2211fbd85 100644 --- a/api_docs/fleet.json +++ b/api_docs/fleet.json @@ -1678,7 +1678,32 @@ } }, "server": { - "classes": [], + "classes": [ + { + "id": "def-server.AgentNotFoundError", + "type": "Class", + "tags": [], + "label": "AgentNotFoundError", + "description": [], + "signature": [ + { + "pluginId": "fleet", + "scope": "server", + "docId": "kibFleetPluginApi", + "section": "def-server.AgentNotFoundError", + "text": "AgentNotFoundError" + }, + " extends ", + "IngestManagerError" + ], + "children": [], + "source": { + "path": "x-pack/plugins/fleet/server/errors/index.ts", + "lineNumber": 34 + }, + "initialIsOpen": false + } + ], "functions": [ { "id": "def-server.getRegistryUrl", @@ -1714,7 +1739,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/server/services/index.ts", - "lineNumber": 73 + "lineNumber": 68 }, "signature": [ "(soClient: Pick<", @@ -1744,7 +1769,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/server/services/index.ts", - "lineNumber": 74 + "lineNumber": 69 }, "signature": [ "(soClient: Pick<", @@ -1774,7 +1799,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/server/services/index.ts", - "lineNumber": 75 + "lineNumber": 70 }, "signature": [ "(soClient: Pick<", @@ -1796,7 +1821,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/server/services/index.ts", - "lineNumber": 76 + "lineNumber": 71 }, "signature": [ "(soClient: Pick<", @@ -1821,7 +1846,7 @@ ], "source": { "path": "x-pack/plugins/fleet/server/services/index.ts", - "lineNumber": 72 + "lineNumber": 67 }, "initialIsOpen": false }, @@ -1862,15 +1887,7 @@ "type": "Function", "label": "authenticateAgentWithAccessToken", "signature": [ - "(soClient: Pick<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClient", - "text": "SavedObjectsClient" - }, - ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\">, esClient: ", + "(esClient: ", { "pluginId": "core", "scope": "server", @@ -1900,27 +1917,6 @@ "\nAuthenticate an agent with access toekn" ], "children": [ - { - "type": "Object", - "label": "soClient", - "isRequired": true, - "signature": [ - "Pick<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClient", - "text": "SavedObjectsClient" - }, - ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\">" - ], - "description": [], - "source": { - "path": "x-pack/plugins/fleet/server/services/index.ts", - "lineNumber": 54 - } - }, { "type": "CompoundType", "label": "esClient", @@ -1937,7 +1933,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/server/services/index.ts", - "lineNumber": 55 + "lineNumber": 54 } }, { @@ -1957,7 +1953,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/server/services/index.ts", - "lineNumber": 56 + "lineNumber": 55 } } ], @@ -1973,15 +1969,7 @@ "type": "Function", "label": "getAgentStatusById", "signature": [ - "(soClient: Pick<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClient", - "text": "SavedObjectsClient" - }, - ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\">, esClient: ", + "(esClient: ", { "pluginId": "core", "scope": "server", @@ -2003,27 +1991,6 @@ "\nReturn the status by the Agent's id" ], "children": [ - { - "type": "Object", - "label": "soClient", - "isRequired": true, - "signature": [ - "Pick<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClient", - "text": "SavedObjectsClient" - }, - ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\">" - ], - "description": [], - "source": { - "path": "x-pack/plugins/fleet/server/services/index.ts", - "lineNumber": 62 - } - }, { "type": "CompoundType", "label": "esClient", @@ -2040,7 +2007,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/server/services/index.ts", - "lineNumber": 63 + "lineNumber": 60 } }, { @@ -2053,7 +2020,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/server/services/index.ts", - "lineNumber": 64 + "lineNumber": 60 } } ], @@ -2061,7 +2028,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/fleet/server/services/index.ts", - "lineNumber": 61 + "lineNumber": 60 } }, { @@ -2074,7 +2041,7 @@ ], "source": { "path": "x-pack/plugins/fleet/server/services/index.ts", - "lineNumber": 69 + "lineNumber": 64 }, "signature": [ "typeof ", @@ -2471,7 +2438,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/server/index.ts", - "lineNumber": 75 + "lineNumber": 76 }, "signature": [ "any" @@ -2933,7 +2900,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/index.ts", - "lineNumber": 39 + "lineNumber": 38 }, "signature": [ "(o: T) => [keyof T, T[keyof T]][]" @@ -5188,7 +5155,7 @@ "lineNumber": 15 }, "signature": [ - "{ fleetServerEnabled: boolean; enabled: boolean; tlsCheckDisabled: boolean; pollingRequestTimeout: number; maxConcurrentConnections: number; kibana: { host?: string | string[] | undefined; ca_sha256?: string | undefined; }; elasticsearch: { host?: string | undefined; ca_sha256?: string | undefined; }; agentPolicyRolloutRateLimitIntervalMs: number; agentPolicyRolloutRateLimitRequestPerInterval: number; }" + "{ enabled: boolean; tlsCheckDisabled: boolean; pollingRequestTimeout: number; maxConcurrentConnections: number; kibana: { host?: string | string[] | undefined; ca_sha256?: string | undefined; }; elasticsearch: { host?: string | undefined; ca_sha256?: string | undefined; }; agentPolicyRolloutRateLimitIntervalMs: number; agentPolicyRolloutRateLimitRequestPerInterval: number; }" ] } ], @@ -13693,7 +13660,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/index.ts", - "lineNumber": 44 + "lineNumber": 43 }, "signature": [ "T[keyof T]" diff --git a/api_docs/fleet.mdx b/api_docs/fleet.mdx index d64864ca5c800..1388184f7a948 100644 --- a/api_docs/fleet.mdx +++ b/api_docs/fleet.mdx @@ -45,6 +45,9 @@ import fleetObj from './fleet.json'; ### Functions +### Classes + + ### Interfaces