OpenAPI: Fix ValidationError message attribute (grafana#90846)

julienduchesne · web-flow · commit 3ac8760321fe · 2024-08-26T10:05:37.000-04:00
It's `message`, not `msg`. It's been fixed for a while here: https://github.com/grafana/grafana-openapi-client-go/blob/9ef69836127d783a63b2d0c61b2f8bf3de0c8e86/scripts/pull-schema.sh#L46-L49 I've also reflected the change in the tests
diff --git a/pkg/services/ngalert/api/api_provisioning_test.go b/pkg/services/ngalert/api/api_provisioning_test.go
@@ -99,8 +99,10 @@ func TestProvisioningApi(t *testing.T) {
 				response := sut.RoutePutPolicyTree(&rc, tree)
 
 				require.Equal(t, 400, response.Status())
-				expBody := `{"message":"invalid object specification: invalid policy tree"}`
-				require.Equal(t, expBody, string(response.Body()))
+				expBody := definitions.ValidationError{Message: "invalid object specification: invalid policy tree"}
+				expBodyJSON, marshalErr := json.Marshal(expBody)
+				require.NoError(t, marshalErr)
+				require.Equal(t, string(expBodyJSON), string(response.Body()))
 			})
 		})
 
diff --git a/pkg/services/ngalert/api/tooling/api.json b/pkg/services/ngalert/api/tooling/api.json
@@ -4380,7 +4380,7 @@
   },
   "ValidationError": {
    "properties": {
-    "msg": {
+    "message": {
      "example": "error message",
      "type": "string"
     }
diff --git a/pkg/services/ngalert/api/tooling/definitions/shared.go b/pkg/services/ngalert/api/tooling/definitions/shared.go
@@ -11,7 +11,7 @@ type Ack struct{}
 // swagger:model
 type ValidationError struct {
 	// example: error message
-	Msg string `json:"msg"`
+	Message string `json:"message"`
 }
 
 // swagger:model
diff --git a/pkg/services/ngalert/api/tooling/post.json b/pkg/services/ngalert/api/tooling/post.json
@@ -4379,7 +4379,7 @@
   },
   "ValidationError": {
    "properties": {
-    "msg": {
+    "message": {
      "example": "error message",
      "type": "string"
     }
diff --git a/pkg/services/ngalert/api/tooling/spec.json b/pkg/services/ngalert/api/tooling/spec.json
@@ -8013,7 +8013,7 @@
     "ValidationError": {
       "type": "object",
       "properties": {
-        "msg": {
+        "message": {
           "type": "string",
           "example": "error message"
         }
diff --git a/public/api-merged.json b/public/api-merged.json
@@ -21969,7 +21969,7 @@
     "ValidationError": {
       "type": "object",
       "properties": {
-        "msg": {
+        "message": {
           "type": "string",
           "example": "error message"
         }
diff --git a/public/openapi3.json b/public/openapi3.json
@@ -12027,7 +12027,7 @@
       },
       "ValidationError": {
         "properties": {
-          "msg": {
+          "message": {
             "example": "error message",
             "type": "string"
           }

Original file line number	Diff line number	Diff line change
`@@ -4380,7 +4380,7 @@`
`4380`	`4380`	`},`
`4381`	`4381`	`"ValidationError": {`
`4382`	`4382`	`"properties": {`
`4383`		`- "msg": {`
	`4383`	`+ "message": {`
`4384`	`4384`	`"example": "error message",`
`4385`	`4385`	`"type": "string"`
`4386`	`4386`	`}`
Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@ type Ack struct{}`
`11`	`11`	`// swagger:model`
`12`	`12`	`type ValidationError struct {`
`13`	`13`	`// example: error message`
`14`		- Msg string `json:"msg"`
	`14`	+ Message string `json:"message"`
`15`	`15`	`}`
`16`	`16`
`17`	`17`	`// swagger:model`
Original file line number	Diff line number	Diff line change
`@@ -4379,7 +4379,7 @@`
`4379`	`4379`	`},`
`4380`	`4380`	`"ValidationError": {`
`4381`	`4381`	`"properties": {`
`4382`		`- "msg": {`
	`4382`	`+ "message": {`
`4383`	`4383`	`"example": "error message",`
`4384`	`4384`	`"type": "string"`
`4385`	`4385`	`}`
Original file line number	Diff line number	Diff line change
`@@ -8013,7 +8013,7 @@`
`8013`	`8013`	`"ValidationError": {`
`8014`	`8014`	`"type": "object",`
`8015`	`8015`	`"properties": {`
`8016`		`- "msg": {`
	`8016`	`+ "message": {`
`8017`	`8017`	`"type": "string",`
`8018`	`8018`	`"example": "error message"`
`8019`	`8019`	`}`
Original file line number	Diff line number	Diff line change
`@@ -21969,7 +21969,7 @@`
`21969`	`21969`	`"ValidationError": {`
`21970`	`21970`	`"type": "object",`
`21971`	`21971`	`"properties": {`
`21972`		`- "msg": {`
	`21972`	`+ "message": {`
`21973`	`21973`	`"type": "string",`
`21974`	`21974`	`"example": "error message"`
`21975`	`21975`	`}`
Original file line number	Diff line number	Diff line change
`@@ -12027,7 +12027,7 @@`
`12027`	`12027`	`},`
`12028`	`12028`	`"ValidationError": {`
`12029`	`12029`	`"properties": {`
`12030`		`- "msg": {`
	`12030`	`+ "message": {`
`12031`	`12031`	`"example": "error message",`
`12032`	`12032`	`"type": "string"`
`12033`	`12033`	`}`