✨ Include already running in get effective pipeline settings (#1267)

rigdev · Oct 7, 2024 · 3bd0e78 · 3bd0e78
1 parent 5b691b2
commit 3bd0e78
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 2 deletions.
diff --git a/docs/docs/api/platform-api.md b/docs/docs/api/platform-api.md
@@ -8705,6 +8705,7 @@ Response for getting custom metrics for a project and environment.
 | Field | Type | Label | Description |
 | ----- | ---- | ----- | ----------- |
 | project_id | [string](#string) |  |  |
+| capsule_id | [string](#string) |  | If set, the response will contain information as to whether the pipeline is already running for that capsule. |
 
 
 
@@ -8719,7 +8720,23 @@ Response for getting custom metrics for a project and environment.
 
 | Field | Type | Label | Description |
 | ----- | ---- | ----- | ----------- |
-| pipelines | [model.Pipeline](#model-Pipeline) | repeated |  |
+| pipelines | [GetEffectivePipelineSettingsResponse.Pipeline](#api-v1-project-GetEffectivePipelineSettingsResponse-Pipeline) | repeated |  |
+
+
+
+
+
+
+<a name="api-v1-project-GetEffectivePipelineSettingsResponse-Pipeline"></a>
+
+### GetEffectivePipelineSettingsResponse.Pipeline
+
+
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| pipeline | [model.Pipeline](#model-Pipeline) |  |  |
+| already_running | [bool](#bool) |  |  |
 
 
 

diff --git a/proto/rig/api/v1/project/service.proto b/proto/rig/api/v1/project/service.proto
@@ -166,10 +166,18 @@ message GetEffectiveGitSettingsResponse {
 
 message GetEffectivePipelineSettingsRequest {
   string project_id = 1;
+  // If set, the response will contain information as to whether the pipeline is
+  // already running for that capsule.
+  string capsule_id = 2;
 }
 
 message GetEffectivePipelineSettingsResponse {
-  repeated model.Pipeline pipelines = 1;
+  message Pipeline {
+    model.Pipeline pipeline = 1;
+    bool already_running = 2;
+  }
+
+  repeated Pipeline pipelines = 1;
 }
 
 message GetEffectiveNotificationSettingsRequest {