Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 12 additions & 15 deletions docs/reference/api-reference.md

Large diffs are not rendered by default.

8 changes: 4 additions & 4 deletions src/api/api/connector.ts
Original file line number Diff line number Diff line change
Expand Up @@ -715,7 +715,7 @@ export default class Connector {
}

/**
* Deletes a connector secret.
* Deletes a connector secret
*/
async secretDelete (this: That, params?: T.TODO, options?: TransportRequestOptionsWithOutMeta): Promise<T.TODO>
async secretDelete (this: That, params?: T.TODO, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.TODO, unknown>>
Expand Down Expand Up @@ -759,7 +759,7 @@ export default class Connector {
}

/**
* Retrieves a secret stored by Connectors.
* Retrieves a secret stored by Connectors
*/
async secretGet (this: That, params?: T.TODO, options?: TransportRequestOptionsWithOutMeta): Promise<T.TODO>
async secretGet (this: That, params?: T.TODO, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.TODO, unknown>>
Expand Down Expand Up @@ -803,7 +803,7 @@ export default class Connector {
}

/**
* Creates a secret for a Connector.
* Creates a secret for a Connector
*/
async secretPost (this: That, params?: T.TODO, options?: TransportRequestOptionsWithOutMeta): Promise<T.TODO>
async secretPost (this: That, params?: T.TODO, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.TODO, unknown>>
Expand Down Expand Up @@ -844,7 +844,7 @@ export default class Connector {
}

/**
* Creates or updates a secret for a Connector.
* Creates or updates a secret for a Connector
*/
async secretPut (this: That, params?: T.TODO, options?: TransportRequestOptionsWithOutMeta): Promise<T.TODO>
async secretPut (this: That, params?: T.TODO, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.TODO, unknown>>
Expand Down
6 changes: 3 additions & 3 deletions src/api/api/fleet.ts
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,7 @@ export default class Fleet {
}

/**
* Deletes a secret stored by Fleet.
* Deletes a secret stored by Fleet
*/
async deleteSecret (this: That, params?: T.TODO, options?: TransportRequestOptionsWithOutMeta): Promise<T.TODO>
async deleteSecret (this: That, params?: T.TODO, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.TODO, unknown>>
Expand Down Expand Up @@ -221,7 +221,7 @@ export default class Fleet {
}

/**
* Retrieves a secret stored by Fleet.
* Retrieves a secret stored by Fleet
*/
async getSecret (this: That, params?: T.TODO, options?: TransportRequestOptionsWithOutMeta): Promise<T.TODO>
async getSecret (this: That, params?: T.TODO, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.TODO, unknown>>
Expand Down Expand Up @@ -364,7 +364,7 @@ export default class Fleet {
}

/**
* Creates a secret stored by Fleet.
* Creates a secret stored by Fleet
*/
async postSecret (this: That, params?: T.TODO, options?: TransportRequestOptionsWithOutMeta): Promise<T.TODO>
async postSecret (this: That, params?: T.TODO, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.TODO, unknown>>
Expand Down
2 changes: 1 addition & 1 deletion src/api/api/inference.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1090,7 +1090,7 @@ export default class Inference {
}

/**
* Configure a custom inference endpoint
* Create a custom inference endpoint
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-custom | Elasticsearch API documentation}
*/
async putCustom (this: That, params?: T.TODO, options?: TransportRequestOptionsWithOutMeta): Promise<T.TODO>
Expand Down
3 changes: 1 addition & 2 deletions src/api/api/knn_search.ts
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,7 @@ const acceptedParams: Record<string, { path: string[], body: string[], query: st
}

/**
* Performs a kNN search.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/9.0/search-search.html | Elasticsearch API documentation}
* Performs a kNN search
*/
export default async function KnnSearchApi (this: That, params?: T.TODO, options?: TransportRequestOptionsWithOutMeta): Promise<T.TODO>
export default async function KnnSearchApi (this: That, params?: T.TODO, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.TODO, unknown>>
Expand Down
8 changes: 4 additions & 4 deletions src/api/api/profiling.ts
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ export default class Profiling {
}

/**
* Extracts a UI-optimized structure to render flamegraphs from Universal Profiling.
* Extracts a UI-optimized structure to render flamegraphs from Universal Profiling
* @see {@link https://www.elastic.co/guide/en/observability/9.0/universal-profiling.html | Elasticsearch API documentation}
*/
async flamegraph (this: That, params?: T.TODO, options?: TransportRequestOptionsWithOutMeta): Promise<T.TODO>
Expand Down Expand Up @@ -99,7 +99,7 @@ export default class Profiling {
}

/**
* Extracts raw stacktrace information from Universal Profiling.
* Extracts raw stacktrace information from Universal Profiling
* @see {@link https://www.elastic.co/guide/en/observability/9.0/universal-profiling.html | Elasticsearch API documentation}
*/
async stacktraces (this: That, params?: T.TODO, options?: TransportRequestOptionsWithOutMeta): Promise<T.TODO>
Expand Down Expand Up @@ -141,7 +141,7 @@ export default class Profiling {
}

/**
* Returns basic information about the status of Universal Profiling.
* Returns basic information about the status of Universal Profiling
* @see {@link https://www.elastic.co/guide/en/observability/9.0/universal-profiling.html | Elasticsearch API documentation}
*/
async status (this: That, params?: T.TODO, options?: TransportRequestOptionsWithOutMeta): Promise<T.TODO>
Expand Down Expand Up @@ -183,7 +183,7 @@ export default class Profiling {
}

/**
* Extracts a list of topN functions from Universal Profiling.
* Extracts a list of topN functions from Universal Profiling
* @see {@link https://www.elastic.co/guide/en/observability/9.0/universal-profiling.html | Elasticsearch API documentation}
*/
async topnFunctions (this: That, params?: T.TODO, options?: TransportRequestOptionsWithOutMeta): Promise<T.TODO>
Expand Down
2 changes: 1 addition & 1 deletion src/api/api/transform.ts
Original file line number Diff line number Diff line change
Expand Up @@ -241,7 +241,7 @@ export default class Transform {
}

/**
* Retrieves transform usage information for transform nodes.
* Retrieves transform usage information for transform nodes
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/9.0/get-transform-node-stats.html | Elasticsearch API documentation}
*/
async getNodeStats (this: That, params?: T.TODO, options?: TransportRequestOptionsWithOutMeta): Promise<T.TODO>
Expand Down
Loading
Loading