CLOUDP-313088: Doc feedback for preview API

Author: andreaangiolillo

tools/cli/internal/openapi/filter/bump.go

@@ -31,6 +31,8 @@ const (
 	stateFieldValueUpcoming = "Upcoming"
 	stateFieldValuePreview  = "Preview"
 	betaFieldName           = "x-beta"
+	description             = "\nThis API is in preview. Breaking changes might be introduced before it is released. " +
+		"Don't use preview APIs in production."
 )
 
 func (f *BumpFilter) ValidateMetadata() error {
@@ -70,6 +72,7 @@ func (f *BumpFilter) includeBumpFieldForPreview() error {
 			}
 			op.Extensions[stateFieldName] = stateFieldValuePreview
 			op.Extensions[betaFieldName] = true
+			op.Description += description
 		}
 	}
 	return nil

tools/cli/internal/openapi/filter/bump_test.go

@@ -70,6 +70,7 @@ func TestBumpFilter_Apply_Preview(t *testing.T) {
 	assert.Equal(t, "Preview", op.Extensions["x-state"])
 	assert.Contains(t, op.Extensions, "x-beta")
 	assert.Equal(t, true, op.Extensions["x-beta"])
+	assert.Contains(t, description, op.Description)
 }
 
 func TestBumpFilter_Apply_Upcoming(t *testing.T) {
@@ -115,6 +116,7 @@ func TestBumpFilter_Apply_Upcoming(t *testing.T) {
 	assert.Contains(t, op.Extensions, "x-state")
 	assert.Equal(t, "Upcoming", op.Extensions["x-state"])
 	assert.NotContains(t, op.Extensions, "x-beta")
+	assert.NotContains(t, op.Description, description)
 }
 
 func TestBumpFilter_Apply_Stable(t *testing.T) {