adding doc comments

Author: eriktate

CHANGELOG.md

@@ -19,7 +19,7 @@ Teleport 18 removes support for:
 - `tls-ecdhe-ecdsa-with-aes-128-cbc-sha256`
 - `tls-ecdhe-rsa-with-aes-128-cbc-sha256`
 
-### Terraform provider role defaults
+#### Terraform provider role defaults
 
 The Terraform provider previously defaulted unset booleans to `false`, starting
 with v18 it will leave the fields empty and let Teleport pick the same default

e

@@ -192,6 +192,7 @@ computed_fields:
     - "AppV3.Kind"
 
     # Auth preference
+    - "AuthPreferenceV2.Spec"
     - "AuthPreferenceV2.Spec.AllowPasswordless"
     - "AuthPreferenceV2.Spec.AllowHeadless"
     - "AuthPreferenceV2.Spec.DisconnectExpiredCert"

integrations/terraform/protoc-gen-terraform-teleport.yaml

@@ -20,9 +20,10 @@ import (
 	"context"
 	"fmt"
 
-	apitypes "github.com/gravitational/teleport/api/types"
 	"github.com/hashicorp/terraform-plugin-framework/tfsdk"
 	tftypes "github.com/hashicorp/terraform-plugin-framework/types"
+
+	apitypes "github.com/gravitational/teleport/api/types"
 )
 
 const (
@@ -34,21 +35,27 @@ One way to deal with version change is to force-recreate, but this is too destru
 The workaround we found was to use this plan modifier.`
 )
 
+// DefaultRoleOptions returns the default implementation of the DefaultRoleOptionsModifier
 func DefaultRoleOptions() tfsdk.AttributePlanModifier {
 	return DefaultRoleOptionsModifier{}
 }
 
+// DefaultRoleOptionsModifier implements the tfsdk.AttributePlanModifier interface. It accounts
+// for default values applied by CheckAndSetDefaults that would otherwise create inconsistent states
 type DefaultRoleOptionsModifier struct {
 }
 
+// Description of the RoleOptions plan modifier
 func (d DefaultRoleOptionsModifier) Description(ctx context.Context) string {
 	return DefaultRoleOptionsModifierDescription
 }
 
+// MarkdownDescription of the RoleOptions plan modifier
 func (d DefaultRoleOptionsModifier) MarkdownDescription(ctx context.Context) string {
 	return DefaultRoleOptionsModifierDescription
 }
 
+// Modify the terraform plan to account for defaults applied to RoleOptions by CheckAndSetDefaults
 func (d DefaultRoleOptionsModifier) Modify(ctx context.Context, req tfsdk.ModifyAttributePlanRequest, resp *tfsdk.ModifyAttributePlanResponse) {
 	var config tftypes.Object
 	diags := req.Config.Get(ctx, &config)