Skip to content

Commit cafccde

Browse files
[DOCS] Adds descriptions to ingest APIs (#2236)
Co-authored-by: Abdon Pijpelink <[email protected]>
1 parent 94a3330 commit cafccde

File tree

12 files changed

+1595
-370
lines changed

12 files changed

+1595
-370
lines changed

output/schema/schema.json

Lines changed: 408 additions & 69 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

output/typescript/types.ts

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

specification/_doc_ids/table.csv

Lines changed: 331 additions & 297 deletions
Large diffs are not rendered by default.

specification/ingest/_types/Pipeline.ts

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,22 @@ import { VersionNumber } from '@_types/common'
2121
import { ProcessorContainer } from './Processors'
2222

2323
export class Pipeline {
24+
/**
25+
* Description of the ingest pipeline.
26+
*/
2427
description?: string
28+
/**
29+
* Processors to run immediately after a processor failure.
30+
*/
2531
on_failure?: ProcessorContainer[]
32+
/**
33+
* Processors used to perform transformations on documents before indexing.
34+
* Processors run sequentially in the order specified.
35+
*/
2636
processors?: ProcessorContainer[]
37+
/**
38+
* Version number used by external systems to track ingest pipelines.
39+
*/
2740
version?: VersionNumber
2841
}
2942

@@ -42,7 +55,17 @@ export enum PipelineFailure {
4255
}
4356

4457
export class PipelineConfig {
58+
/**
59+
* Description of the ingest pipeline.
60+
*/
4561
description?: string
62+
/**
63+
* Version number used by external systems to track ingest pipelines.
64+
*/
4665
version?: VersionNumber
66+
/**
67+
* Processors used to perform transformations on documents before indexing.
68+
* Processors run sequentially in the order specified.
69+
*/
4770
processors: ProcessorContainer[]
4871
}

0 commit comments

Comments
 (0)