Skip to content

[DOCS] Adds descriptions to ingest APIs #2236

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Aug 14, 2023
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
477 changes: 408 additions & 69 deletions output/schema/schema.json

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion output/typescript/types.ts

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

628 changes: 331 additions & 297 deletions specification/_doc_ids/table.csv

Large diffs are not rendered by default.

23 changes: 23 additions & 0 deletions specification/ingest/_types/Pipeline.ts
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,22 @@ import { VersionNumber } from '@_types/common'
import { ProcessorContainer } from './Processors'

export class Pipeline {
/**
* Description of the ingest pipeline.
*/
description?: string
/**
* Processors to run immediately after a processor failure.
*/
on_failure?: ProcessorContainer[]
/**
* Processors used to perform transformations on documents before indexing.
* Processors run sequentially in the order specified.
*/
processors?: ProcessorContainer[]
/**
* Version number used by external systems to track ingest pipelines.
*/
version?: VersionNumber
}

Expand All @@ -42,7 +55,17 @@ export enum PipelineFailure {
}

export class PipelineConfig {
/**
* Description of the ingest pipeline.
*/
description?: string
/**
* Version number used by external systems to track ingest pipelines.
*/
version?: VersionNumber
/**
* Processors used to perform transformations on documents before indexing.
* Processors run sequentially in the order specified.
*/
processors: ProcessorContainer[]
}
Loading