feat(pipelines): add new interface for get single pipeline (#818)

* feat(pipelines): add new interface for get single pipeline * feat(pipelines): add new interface for get single pipeline * feat(pipelines): fix dep review * feat(pipelines): fix dep review * feat(pipelines): fix dep review * feat(pipelines): fix dep review
coveo · May 8, 2024 · cbe1084 · cbe1084
1 parent 6a1af6f
commit cbe1084
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 1 deletion.
diff --git a/.github/workflows/dependency-review.yml b/.github/workflows/dependency-review.yml
@@ -14,3 +14,5 @@ jobs:
         with:
             public: true
             distributed: true
+            base-ref: ${{ github.event.pull_request.base.sha || 'master' }}
+            head-ref: ${{ github.event.pull_request.head.sha || github.ref_name }}
diff --git a/src/resources/Pipelines/Pipelines.ts b/src/resources/Pipelines/Pipelines.ts
@@ -8,6 +8,7 @@ import {
     ListPipelinesOptions,
     ListPipelinesReturnVariant,
     NewPipelineModel,
+    PipelineDetailedModel,
     PipelineModel,
     UpdatePipelineModel,
 } from './PipelinesInterfaces.js';
@@ -47,7 +48,7 @@ export default class Pipelines extends Resource {
     }
 
     get(pipelineId: string) {
-        return this.api.get<PipelineModel>(
+        return this.api.get<PipelineDetailedModel>(
             this.buildPath(`${Pipelines.searchUrlVersion1}/${pipelineId}`, {
                 organizationId: this.api.organizationId,
             }),

diff --git a/src/resources/Pipelines/PipelinesInterfaces.ts b/src/resources/Pipelines/PipelinesInterfaces.ts
@@ -171,6 +171,17 @@ export interface PipelineModel extends PipelineShared {
     };
 }
 
+export interface PipelineDetailedModel extends PipelineModel {
+    /**
+     * The unique identifier of query pipeline A in the A/B test.
+     *
+     * See also the splitTestName, splitTestRatio, and splitTestEnabled properties
+     *
+     * @example: '22a3860e-fa6f-4e64-a9f1-ef738af0786e'
+     */
+    splitTestOriginalPipeline?: string;
+}
+
 export interface NewPipelineModel extends PipelineShared, GranularResource {}
 export interface UpdatePipelineModel extends PipelineModel, GranularResource {}