Port 16366 bug spec is not included in calculation properties for blueprints in tf provider (#293)

itamar-smirra-port · web-flow · commit b1f48f61f72e · 2025-10-23T16:13:05.000+03:00
* add dynamic unknown fields to the blueprint property types

* add support for spec in calculation properties

* add docs

* gen docs
diff --git a/Makefile b/Makefile
@@ -43,7 +43,13 @@ acctest:
 	TF_ACC=1 PORT_CLIENT_ID=$(PORT_CLIENT_ID) PORT_CLIENT_SECRET=$(PORT_CLIENT_SECRET) PORT_BASE_URL=$(PORT_BASE_URL) go test -timeout 40m -p 1 ./... -run "$(TEST_FILTER)"
 
 gen-docs:
+	@echo "Generating documentation..."
+	@if [ ! -f "./terraform-provider-port-labs" ]; then \
+		echo "Provider binary not found. Building..."; \
+		go build -o terraform-provider-port-labs; \
+	fi
 	tfplugindocs
+	@echo "Documentation generated successfully!"
 
 lint: build
 	# https://golangci-lint.run/welcome/install/#local-installation
diff --git a/docs/resources/port_blueprint.md b/docs/resources/port_blueprint.md
@@ -313,8 +313,20 @@ Optional:
 - `description` (String) The description of the calculation property
 - `format` (String) The format of the calculation property
 - `icon` (String) The icon of the calculation property
+- `spec` (String) The spec of the calculation property
+- `spec_authentication` (Attributes) The spec authentication of the calculation property (see [below for nested schema](#nestedatt--calculation_properties--spec_authentication))
 - `title` (String) The title of the calculation property
 
+<a id="nestedatt--calculation_properties--spec_authentication"></a>
+### Nested Schema for `calculation_properties.spec_authentication`
+
+Required:
+
+- `authorization_url` (String) The authorizationUrl of the spec authentication
+- `client_id` (String) The clientId of the spec authentication
+- `token_url` (String) The tokenUrl of the spec authentication
+
+
 
 <a id="nestedatt--kafka_changelog_destination"></a>
 ### Nested Schema for `kafka_changelog_destination`
diff --git a/docs/resources/port_system_blueprint.md b/docs/resources/port_system_blueprint.md
@@ -45,8 +45,20 @@ Optional:
 - `description` (String) The description of the calculation property
 - `format` (String) The format of the calculation property
 - `icon` (String) The icon of the calculation property
+- `spec` (String) The spec of the calculation property
+- `spec_authentication` (Attributes) The spec authentication of the calculation property (see [below for nested schema](#nestedatt--calculation_properties--spec_authentication))
 - `title` (String) The title of the calculation property
 
+<a id="nestedatt--calculation_properties--spec_authentication"></a>
+### Nested Schema for `calculation_properties.spec_authentication`
+
+Required:
+
+- `authorization_url` (String) The authorizationUrl of the spec authentication
+- `client_id` (String) The clientId of the spec authentication
+- `token_url` (String) The tokenUrl of the spec authentication
+
+
 
 <a id="nestedatt--mirror_properties"></a>
 ### Nested Schema for `mirror_properties`
diff --git a/examples/resources/port_blueprint/main.tf b/examples/resources/port_blueprint/main.tf
@@ -97,6 +97,26 @@ resource "port_blueprint" "microservice" {
     }
   }
 
+  calculation_properties = {
+    "spec-calculation" = {
+      title       = "Spec Calculation"
+      calculation = "@blueprint/environment.properties.name"
+      type        = "string"
+      spec        = "embedded-url"
+      spec_authentication = {
+        client_id         = "my-client-id"
+        token_url         = "https://example.com/token"
+        authorization_url = "https://example.com/auth"
+      }
+    }
+    "simple-calculation" = {
+      title       = "Simple Calculation"
+      calculation = "1 + 1"
+      type        = "number"
+      description = "A simple calculation without spec"
+    }
+  }
+
   relations = {
     "environment" = {
       title    = "Test Relation"
diff --git a/internal/cli/models.go b/internal/cli/models.go
@@ -133,16 +133,18 @@ type (
 	}
 
 	BlueprintCalculationProperty struct {
-		Type        string            `json:"type,omitempty"`
-		Title       *string           `json:"title,omitempty"`
-		Identifier  string            `json:"identifier,omitempty"`
-		Calculation string            `json:"calculation,omitempty"`
-		Default     any               `json:"default,omitempty"`
-		Icon        *string           `json:"icon,omitempty"`
-		Format      *string           `json:"format,omitempty"`
-		Description *string           `json:"description,omitempty"`
-		Colorized   *bool             `json:"colorized,omitempty"`
-		Colors      map[string]string `json:"colors,omitempty"`
+		Type               string             `json:"type,omitempty"`
+		Title              *string            `json:"title,omitempty"`
+		Identifier         string             `json:"identifier,omitempty"`
+		Calculation        string             `json:"calculation,omitempty"`
+		Default            any                `json:"default,omitempty"`
+		Icon               *string            `json:"icon,omitempty"`
+		Format             *string            `json:"format,omitempty"`
+		Description        *string            `json:"description,omitempty"`
+		Colorized          *bool              `json:"colorized,omitempty"`
+		Colors             map[string]string  `json:"colors,omitempty"`
+		Spec               *string            `json:"spec,omitempty"`
+		SpecAuthentication *SpecAuthentication `json:"specAuthentication,omitempty"`
 	}
 
 	BlueprintAggregationProperty struct {
diff --git a/port/aggregation-properties/resource.go b/port/aggregation-properties/resource.go
@@ -2,6 +2,7 @@ package aggregation_properties
 
 import (
 	"context"
+
 	"github.com/hashicorp/terraform-plugin-framework/path"
 	"github.com/hashicorp/terraform-plugin-framework/resource"
 	"github.com/port-labs/terraform-provider-port-labs/v2/internal/cli"
diff --git a/port/blueprint/model.go b/port/blueprint/model.go
@@ -124,14 +124,16 @@ type MirrorPropertyModel struct {
 }
 
 type CalculationPropertyModel struct {
-	Calculation types.String `tfsdk:"calculation"`
-	Title       types.String `tfsdk:"title"`
-	Format      types.String `tfsdk:"format"`
-	Icon        types.String `tfsdk:"icon"`
-	Description types.String `tfsdk:"description"`
-	Type        types.String `tfsdk:"type"`
-	Colorized   types.Bool   `tfsdk:"colorized"`
-	Colors      types.Map    `tfsdk:"colors"`
+	Calculation        types.String             `tfsdk:"calculation"`
+	Title              types.String             `tfsdk:"title"`
+	Format             types.String             `tfsdk:"format"`
+	Icon               types.String             `tfsdk:"icon"`
+	Description        types.String             `tfsdk:"description"`
+	Type               types.String             `tfsdk:"type"`
+	Colorized          types.Bool               `tfsdk:"colorized"`
+	Colors             types.Map                `tfsdk:"colors"`
+	Spec               types.String             `tfsdk:"spec"`
+	SpecAuthentication *SpecAuthenticationModel `tfsdk:"spec_authentication"`
 }
 
 type AverageEntitiesModel struct {
diff --git a/port/blueprint/readStateToPortBody.go b/port/blueprint/readStateToPortBody.go
@@ -139,6 +139,20 @@ func CalculationPropertiesToBody(ctx context.Context, state map[string]Calculati
 			calculationProp.Colors = colors
 		}
 
+		if !prop.Spec.IsNull() {
+			spec := prop.Spec.ValueString()
+			calculationProp.Spec = &spec
+		}
+
+		if prop.SpecAuthentication != nil {
+			specAuth := &cli.SpecAuthentication{
+				AuthorizationUrl: prop.SpecAuthentication.AuthorizationUrl.ValueString(),
+				TokenUrl:         prop.SpecAuthentication.TokenUrl.ValueString(),
+				ClientId:         prop.SpecAuthentication.ClientId.ValueString(),
+			}
+			calculationProp.SpecAuthentication = specAuth
+		}
+
 		calculationProperties[identifier] = calculationProp
 	}
 
diff --git a/port/blueprint/schema.go b/port/blueprint/schema.go
@@ -498,6 +498,29 @@ func BlueprintSchema() map[string]schema.Attribute {
 						Optional:            true,
 						ElementType:         types.StringType,
 					},
+					"spec": schema.StringAttribute{
+						MarkdownDescription: "The spec of the calculation property",
+						Optional:            true,
+						Validators:          []validator.String{stringvalidator.OneOf("open-api", "async-api", "embedded-url")},
+					},
+					"spec_authentication": schema.SingleNestedAttribute{
+						MarkdownDescription: "The spec authentication of the calculation property",
+						Optional:            true,
+						Attributes: map[string]schema.Attribute{
+							"client_id": schema.StringAttribute{
+								MarkdownDescription: "The clientId of the spec authentication",
+								Required:            true,
+							},
+							"token_url": schema.StringAttribute{
+								MarkdownDescription: "The tokenUrl of the spec authentication",
+								Required:            true,
+							},
+							"authorization_url": schema.StringAttribute{
+								MarkdownDescription: "The authorizationUrl of the spec authentication",
+								Required:            true,
+							},
+						},
+					},
 				},
 			},
 		},
diff --git a/port/blueprint/updatePropertiesToState.go b/port/blueprint/updatePropertiesToState.go
@@ -219,6 +219,7 @@ func addCalculationPropertiesToState(ctx context.Context, b *cli.Blueprint, bm *
 			Description: flex.GoStringToFramework(v.Description),
 			Format:      flex.GoStringToFramework(v.Format),
 			Colorized:   flex.GoBoolToFramework(v.Colorized),
+			Spec:        flex.GoStringToFramework(v.Spec),
 		}
 
 		if v.Colors != nil {
@@ -227,6 +228,14 @@ func addCalculationPropertiesToState(ctx context.Context, b *cli.Blueprint, bm *
 			calculationPropertyModel.Colors = types.MapNull(types.StringType)
 		}
 
+		if v.SpecAuthentication != nil {
+			calculationPropertyModel.SpecAuthentication = &SpecAuthenticationModel{
+				AuthorizationUrl: types.StringValue(v.SpecAuthentication.AuthorizationUrl),
+				TokenUrl:         types.StringValue(v.SpecAuthentication.TokenUrl),
+				ClientId:         types.StringValue(v.SpecAuthentication.ClientId),
+			}
+		}
+
 		bm.CalculationProperties[k] = *calculationPropertyModel
 
 	}

Original file line number	Diff line number	Diff line change
`@@ -219,6 +219,7 @@ func addCalculationPropertiesToState(ctx context.Context, b cli.Blueprint, bm `
`219`	`219`	`Description: flex.GoStringToFramework(v.Description),`
`220`	`220`	`Format: flex.GoStringToFramework(v.Format),`
`221`	`221`	`Colorized: flex.GoBoolToFramework(v.Colorized),`
	`222`	`+ Spec: flex.GoStringToFramework(v.Spec),`
`222`	`223`	`}`
`223`	`224`
`224`	`225`	`if v.Colors != nil {`
`@@ -227,6 +228,14 @@ func addCalculationPropertiesToState(ctx context.Context, b cli.Blueprint, bm `
`227`	`228`	`calculationPropertyModel.Colors = types.MapNull(types.StringType)`
`228`	`229`	`}`
`229`	`230`
	`231`	`+ if v.SpecAuthentication != nil {`
	`232`	`+ calculationPropertyModel.SpecAuthentication = &SpecAuthenticationModel{`
	`233`	`+ AuthorizationUrl: types.StringValue(v.SpecAuthentication.AuthorizationUrl),`
	`234`	`+ TokenUrl: types.StringValue(v.SpecAuthentication.TokenUrl),`
	`235`	`+ ClientId: types.StringValue(v.SpecAuthentication.ClientId),`
	`236`	`+ }`
	`237`	`+ }`
	`238`	`+`
`230`	`239`	`bm.CalculationProperties[k] = *calculationPropertyModel`
`231`	`240`
`232`	`241`	`}`