[DOCS] Adds descriptions to ingest APIs (#2236)

Co-authored-by: Abdon Pijpelink <[email protected]>
elastic · Aug 14, 2023 · cafccde · cafccde
1 parent 94a3330
commit cafccde
Show file tree

Hide file tree

Showing 12 changed files with 1,595 additions and 370 deletions.
diff --git a/output/schema/schema.json b/output/schema/schema.json
diff --git a/output/typescript/types.ts b/output/typescript/types.ts
diff --git a/specification/_doc_ids/table.csv b/specification/_doc_ids/table.csv
diff --git a/specification/ingest/_types/Pipeline.ts b/specification/ingest/_types/Pipeline.ts
@@ -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
 }
 
@@ -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[]
 }