docs(instance): add deprecation notice for PolicyRespected in `Plac…

…ementGroup` (#2394)
scaleway · Jan 28, 2025 · ad2f1fb · ad2f1fb
1 parent 57427ee
commit ad2f1fb
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/api/instance/v1/instance_sdk.go b/api/instance/v1/instance_sdk.go
@@ -1367,7 +1367,8 @@ type PlacementGroup struct {
 	// Default value: max_availability
 	PolicyType PlacementGroupPolicyType `json:"policy_type"`
 
-	// PolicyRespected: returns true if the policy is respected, false otherwise.
+	// PolicyRespected: in the server endpoints the value is always false as it is deprecated.
+	// In the placement group endpoints the value is correct.
 	PolicyRespected bool `json:"policy_respected"`
 
 	// Zone: zone in which the placement group is located.