From cee773ac6ae01e00ee18857174913836fe271a0c Mon Sep 17 00:00:00 2001
From: TP Honey <tp@harness.io>
Date: Tue, 11 Jan 2022 10:38:08 +0000
Subject: [PATCH] (maint) add warning around typo for stage_id in step struct

---
 core/step.go | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/core/step.go b/core/step.go
index 1d0d0ad1..1339b15c 100644
--- a/core/step.go
+++ b/core/step.go
@@ -20,7 +20,7 @@ type (
 	// Step represents an individual step in the stage.
 	Step struct {
 		ID        int64    `json:"id"`
-		StageID   int64    `json:"step_id"`
+		StageID   int64    `json:"step_id"` // this is a typo, fixing it has far reaching ramifications. It should only be attempted in a major version change
 		Number    int      `json:"number"`
 		Name      string   `json:"name"`
 		Status    string   `json:"status"`