Add JQ required to Action Resource (#96)

Author: Tankilevitch

docs/resources/port_action.md

@@ -34,6 +34,7 @@ Action resource
 - `kafka_method` (Object) The invocation method of the action (see [below for nested schema](#nestedatt--kafka_method))
 - `order_properties` (List of String) Order properties
 - `required_approval` (Boolean) Require approval before invoking the action
+- `required_jq_query` (String) The required jq query of the property
 - `user_properties` (Attributes) User properties (see [below for nested schema](#nestedatt--user_properties))
 - `webhook_method` (Attributes) The invocation method of the action (see [below for nested schema](#nestedatt--webhook_method))
 
@@ -130,7 +131,7 @@ Optional:
 - `min_items` (Number) The min items of the array property
 - `number_items` (Attributes) The items of the array property (see [below for nested schema](#nestedatt--user_properties--array_props--number_items))
 - `object_items` (Attributes) The items of the array property (see [below for nested schema](#nestedatt--user_properties--array_props--object_items))
-- `required` (Boolean) Whether the property is required
+- `required` (Boolean) Whether the property is required, by default not required, this property can't be set at the same time if `required_jq_query` is set, and only supports true as value
 - `string_items` (Attributes) The items of the array property (see [below for nested schema](#nestedatt--user_properties--array_props--string_items))
 - `title` (String) The title of the property
 - `visible` (Boolean) The visibility of the array property
@@ -217,7 +218,7 @@ Optional:
 - `depends_on` (List of String) The properties that this property depends on
 - `description` (String) The description of the property
 - `icon` (String) The icon of the property
-- `required` (Boolean) Whether the property is required
+- `required` (Boolean) Whether the property is required, by default not required, this property can't be set at the same time if `required_jq_query` is set, and only supports true as value
 - `title` (String) The title of the property
 - `visible` (Boolean) The visibility of the boolean property
 - `visible_jq_query` (String) The visibility condition jq query of the boolean property
@@ -269,7 +270,7 @@ Optional:
 - `icon` (String) The icon of the property
 - `maximum` (Number) The min of the number property
 - `minimum` (Number) The max of the number property
-- `required` (Boolean) Whether the property is required
+- `required` (Boolean) Whether the property is required, by default not required, this property can't be set at the same time if `required_jq_query` is set, and only supports true as value
 - `title` (String) The title of the property
 - `visible` (Boolean) The visibility of the number property
 - `visible_jq_query` (String) The visibility condition jq query of the number property
@@ -318,7 +319,7 @@ Optional:
 - `description` (String) The description of the property
 - `encryption` (String) The algorithm to encrypt the property with
 - `icon` (String) The icon of the property
-- `required` (Boolean) Whether the property is required
+- `required` (Boolean) Whether the property is required, by default not required, this property can't be set at the same time if `required_jq_query` is set, and only supports true as value
 - `title` (String) The title of the property
 - `visible` (Boolean) The visibility of the object property
 - `visible_jq_query` (String) The visibility condition jq query of the object property
@@ -374,7 +375,7 @@ Optional:
 - `max_length` (Number) The max length of the string property
 - `min_length` (Number) The min length of the string property
 - `pattern` (String) The pattern of the string property
-- `required` (Boolean) Whether the property is required
+- `required` (Boolean) Whether the property is required, by default not required, this property can't be set at the same time if `required_jq_query` is set, and only supports true as value
 - `title` (String) The title of the property
 - `visible` (Boolean) The visibility of the string property
 - `visible_jq_query` (String) The visibility condition jq query of the string property

internal/cli/models.go

@@ -161,7 +161,7 @@ type (
 
 	ActionUserInputs = struct {
 		Properties map[string]ActionProperty `json:"properties"`
-		Required   []string                  `json:"required,omitempty"`
+		Required   any                       `json:"required,omitempty"`
 		Order      []string                  `json:"order,omitempty"`
 	}
 

port/action/actionStateToPortBody.go

@@ -124,7 +124,16 @@ func actionPropertiesToBody(ctx context.Context, action *cli.Action, data *Actio
 	}
 
 	action.UserInputs.Properties = props
-	action.UserInputs.Required = required
+
+	// if requiredJqQuery is set, required shouldn't be set and vice versa
+	if !data.RequiredJqQuery.IsNull() {
+		RequiredJqQueryMap := map[string]string{
+			"jqQuery": data.RequiredJqQuery.ValueString(),
+		}
+		action.UserInputs.Required = RequiredJqQueryMap
+	} else {
+		action.UserInputs.Required = required
+	}
 
 	return nil
 }

port/action/model.go

@@ -189,4 +189,5 @@ type ActionModel struct {
 	ApprovalWebhookNotification *ApprovalWebhookNotificationModel `tfsdk:"approval_webhook_notification"`
 	ApprovalEmailNotification   types.Object                      `tfsdk:"approval_email_notification"`
 	OrderProperties             types.List                        `tfsdk:"order_properties"`
+	RequiredJqQuery             types.String                      `tfsdk:"required_jq_query"`
 }

port/action/refreshActionState.go

@@ -3,14 +3,14 @@ package action
 import (
 	"context"
 	"fmt"
+	"github.com/samber/lo"
 	"reflect"
 
 	"github.com/hashicorp/terraform-plugin-framework/types"
 	"github.com/port-labs/terraform-provider-port-labs/internal/cli"
 	"github.com/port-labs/terraform-provider-port-labs/internal/consts"
 	"github.com/port-labs/terraform-provider-port-labs/internal/flex"
 	"github.com/port-labs/terraform-provider-port-labs/internal/utils"
-	"github.com/samber/lo"
 )
 
 func writeInvocationMethodToResource(a *cli.Action, state *ActionModel) {
@@ -103,9 +103,37 @@ func writeVisibleToResource(v cli.ActionProperty) (types.Bool, types.String) {
 	return types.BoolNull(), types.StringNull()
 }
 
+func writeRequiredToResource(v cli.ActionUserInputs) (types.String, []string) {
+	// If required is nil, return an empty string and nil
+	if v.Required == nil {
+		return types.StringNull(), nil
+	}
+
+	required := reflect.ValueOf(v.Required)
+	switch required.Kind() {
+	// if required is a slice of strings that means that the user has specified which properties are required
+	case reflect.Slice:
+		slice := required.Interface().([]interface{})
+		attrs := make([]string, 0, required.Len())
+		for _, value := range slice {
+			attrs = append(attrs, value.(string))
+		}
+		return types.StringNull(), attrs
+	// if required is a map, that means that the user has specified a jq query to determine which properties are required
+	case reflect.Map:
+		jq := required.Interface().(map[string]any)
+		jqQueryValue := jq["jqQuery"].(string)
+		return types.StringValue(jqQueryValue), nil
+	}
+
+	// if required is not a slice or a map, return an empty string and nil
+	return types.StringNull(), nil
+}
+
 func writeInputsToResource(ctx context.Context, a *cli.Action, state *ActionModel) error {
 	if len(a.UserInputs.Properties) > 0 {
 		properties := &UserPropertiesModel{}
+		requiredJq, required := writeRequiredToResource(a.UserInputs)
 		for k, v := range a.UserInputs.Properties {
 			switch v.Type {
 			case "string":
@@ -114,10 +142,8 @@ func writeInputsToResource(ctx context.Context, a *cli.Action, state *ActionMode
 				}
 				stringProp := addStringPropertiesToResource(ctx, &v)
 
-				if lo.Contains(a.UserInputs.Required, k) {
+				if requiredJq.IsNull() && lo.Contains(required, k) {
 					stringProp.Required = types.BoolValue(true)
-				} else {
-					stringProp.Required = types.BoolValue(false)
 				}
 
 				err := setCommonProperties(ctx, v, stringProp)
@@ -134,10 +160,8 @@ func writeInputsToResource(ctx context.Context, a *cli.Action, state *ActionMode
 
 				numberProp := addNumberPropertiesToResource(ctx, &v)
 
-				if lo.Contains(a.UserInputs.Required, k) {
+				if requiredJq.IsNull() && lo.Contains(required, k) {
 					numberProp.Required = types.BoolValue(true)
-				} else {
-					numberProp.Required = types.BoolValue(false)
 				}
 
 				err := setCommonProperties(ctx, v, numberProp)
@@ -157,10 +181,8 @@ func writeInputsToResource(ctx context.Context, a *cli.Action, state *ActionMode
 					return err
 				}
 
-				if lo.Contains(a.UserInputs.Required, k) {
+				if requiredJq.IsNull() && lo.Contains(required, k) {
 					arrayProp.Required = types.BoolValue(true)
-				} else {
-					arrayProp.Required = types.BoolValue(false)
 				}
 
 				err = setCommonProperties(ctx, v, arrayProp)
@@ -182,10 +204,8 @@ func writeInputsToResource(ctx context.Context, a *cli.Action, state *ActionMode
 					return err
 				}
 
-				if lo.Contains(a.UserInputs.Required, k) {
+				if requiredJq.IsNull() && lo.Contains(required, k) {
 					booleanProp.Required = types.BoolValue(true)
-				} else {
-					booleanProp.Required = types.BoolValue(false)
 				}
 
 				properties.BooleanProps[k] = *booleanProp
@@ -197,10 +217,8 @@ func writeInputsToResource(ctx context.Context, a *cli.Action, state *ActionMode
 
 				objectProp := addObjectPropertiesToResource(&v)
 
-				if lo.Contains(a.UserInputs.Required, k) {
+				if requiredJq.IsNull() && lo.Contains(required, k) {
 					objectProp.Required = types.BoolValue(true)
-				} else {
-					objectProp.Required = types.BoolValue(false)
 				}
 
 				err := setCommonProperties(ctx, v, objectProp)
@@ -246,6 +264,10 @@ func refreshActionState(ctx context.Context, state *ActionModel, a *cli.Action,
 		}
 	}
 
+	requiredJq, _ := writeRequiredToResource(a.UserInputs)
+
+	state.RequiredJqQuery = requiredJq
+
 	writeInvocationMethodToResource(a, state)
 
 	err := writeInputsToResource(ctx, a, state)