Skip to content

Commit

Permalink
[DOCS] Prettifying code.
Browse files Browse the repository at this point in the history
  • Loading branch information
szabosteve committed Aug 2, 2023
1 parent c3f7b87 commit 061a8b9
Show file tree
Hide file tree
Showing 5 changed files with 18 additions and 18 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -22,16 +22,16 @@ import { Name } from '@_types/common'

/**
* Creates the enrich index for an existing enrich policy.
* The enrich index contains documents from the policy’s source indices. Enrich
* The enrich index contains documents from the policy’s source indices. Enrich
* indices always begin with `.enrich-*`, are read-only, and are force merged.
* Enrich indices should be used by the enrich processor only. Avoid using
* Enrich indices should be used by the enrich processor only. Avoid using
* enrich indices for other purposes.
* Once created, you cannot update or index documents to an enrich index.
* Instead, update your source indices and execute the enrich policy again. This
* creates a new enrich index from your updated source indices. The previous
* enrich index will deleted with a delayed maintenance job. By default this is
* done every 15 minutes.
* Because this API request performs several operations, it may take a while to
* Once created, you cannot update or index documents to an enrich index.
* Instead, update your source indices and execute the enrich policy again. This
* creates a new enrich index from your updated source indices. The previous
* enrich index will deleted with a delayed maintenance job. By default this is
* done every 15 minutes.
* Because this API request performs several operations, it may take a while to
* return a response.
* @rest_spec_name enrich.execute_policy
* @availability stack since=7.5.0 stability=stable
Expand All @@ -46,7 +46,7 @@ export interface Request extends RequestBase {
}
query_parameters: {
/**
* If `true`, the request blocks other enrich policy execution requests
* If `true`, the request blocks other enrich policy execution requests
* until complete. Defaults to `true`.
*/
wait_for_completion?: boolean
Expand Down
2 changes: 1 addition & 1 deletion specification/enrich/get_policy/GetEnrichPolicyRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ import { Names } from '@_types/common'
export interface Request extends RequestBase {
path_parts: {
/**
* Comma-separated list of enrich policy names used to limit the request. To
* Comma-separated list of enrich policy names used to limit the request. To
* return information for all enrich policies, omit this parameter.
*/
name?: Names
Expand Down
8 changes: 4 additions & 4 deletions specification/enrich/put_policy/PutEnrichPolicyRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,11 @@ import { Name } from '@_types/common'

/**
* Creates an enrich policy.
* Once created, you can’t update or change an enrich policy.
* Once created, you can’t update or change an enrich policy.
* Instead, you can:
*
*
* 1. Create and execute a new enrich policy.
* 2. Replace the previous enrich policy with the new enrich policy in any
* 2. Replace the previous enrich policy with the new enrich policy in any
* in-use enrich processors.
* 3. Use the delete enrich policy API to delete the previous enrich policy.
* @rest_spec_name enrich.put_policy
Expand All @@ -51,7 +51,7 @@ export interface Request extends RequestBase {
*/
match?: Policy
/**
* Matches a number, date, or IP address in incoming documents to a range in
* Matches a number, date, or IP address in incoming documents to a range in
* the enrich index based on a `term` query.
*/
range?: Policy
Expand Down
2 changes: 1 addition & 1 deletion specification/enrich/stats/EnrichStatsRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
import { RequestBase } from '@_types/Base'

/**
* Returns enrich coordinator statistics and information about enrich policies
* Returns enrich coordinator statistics and information about enrich policies
* that are currently executing.
* @rest_spec_name enrich.stats
* @availability stack since=7.5.0 stability=stable
Expand Down
6 changes: 3 additions & 3 deletions specification/enrich/stats/EnrichStatsResponse.ts
Original file line number Diff line number Diff line change
Expand Up @@ -22,17 +22,17 @@ import { ExecutingPolicy, CoordinatorStats, CacheStats } from './types'
export class Response {
body: {
/**
* Objects containing information about each coordinating ingest node for
* Objects containing information about each coordinating ingest node for
* configured enrich processors.
*/
coordinator_stats: CoordinatorStats[]
/**
* Objects containing information about each enrich policy that is currently
* Objects containing information about each enrich policy that is currently
* executing.
*/
executing_policies: ExecutingPolicy[]
/**
* Objects containing information about the enrich cache stats on each
* Objects containing information about the enrich cache stats on each
* ingest node.
* @availability stack since=7.16.0
* @availability serverless
Expand Down

0 comments on commit 061a8b9

Please sign in to comment.