Add support for comments on DNS records (#157)

Closes #156

Author: dglsparsons

client/dns_record_create.go

@@ -22,6 +22,7 @@ type CreateDNSRecordRequest struct {
 	TTL        int64  `json:"ttl,omitempty"`
 	Type       string `json:"type"`
 	Value      string `json:"value,omitempty"`
+	Comment    string `json:"comment"`
 }
 
 // CreateDNSRecord creates a DNS record for a specified domain name within Vercel.

client/dns_record_get.go

@@ -16,6 +16,7 @@ type DNSRecord struct {
 	Value      string `json:"value"`
 	RecordType string `json:"recordType"`
 	Priority   int64  `json:"priority"`
+	Comment    string `json:"comment"`
 }
 
 // GetDNSRecord retrieves information about a DNS domain from Vercel.

client/dns_record_update.go

@@ -22,6 +22,7 @@ type UpdateDNSRecordRequest struct {
 	SRV        *SRVUpdate `json:"srv,omitempty"`
 	TTL        *int64     `json:"ttl,omitempty"`
 	Value      *string    `json:"value,omitempty"`
+	Comment    string     `json:"comment"`
 }
 
 // UpdateDNSRecord updates a DNS record for a specified domain name within Vercel.

docs/resources/dns_record.md

@@ -104,6 +104,7 @@ resource "vercel_dns_record" "txt" {
 
 ### Optional
 
+- `comment` (String) A comment explaining what the DNS record is for.
 - `mx_priority` (Number) The priority of the MX record. The priority specifies the sequence that an email server receives emails. A smaller value indicates a higher priority.
 - `srv` (Attributes) Settings for an SRV record. (see [below for nested schema](#nestedatt--srv))
 - `team_id` (String) The team ID that the domain and DNS records belong to. Required when configuring a team resource if a default team has not been set in the provider.

vercel/resource_dns_record.go

@@ -2,11 +2,13 @@ package vercel
 
 import (
 	"context"
+	"encoding/json"
 	"fmt"
 
 	"github.com/hashicorp/terraform-plugin-framework/resource"
 	"github.com/hashicorp/terraform-plugin-framework/resource/schema"
 	"github.com/hashicorp/terraform-plugin-framework/resource/schema/planmodifier"
+	"github.com/hashicorp/terraform-plugin-framework/resource/schema/stringdefault"
 	"github.com/hashicorp/terraform-plugin-framework/resource/schema/stringplanmodifier"
 	"github.com/hashicorp/terraform-plugin-framework/schema/validator"
 	"github.com/hashicorp/terraform-plugin-framework/types"
@@ -109,6 +111,15 @@ For more detailed information, please see the [Vercel documentation](https://ver
 					int64LessThan(65535),
 				},
 			},
+			"comment": schema.StringAttribute{
+				Description: "A comment explaining what the DNS record is for.",
+				Optional:    true,
+				Computed:    true,
+				Default:     stringdefault.StaticString(""),
+				Validators: []validator.String{
+					stringLengthBetween(0, 500),
+				},
+			},
 			"srv": schema.SingleNestedAttribute{
 				Description: "Settings for an SRV record.",
 				Optional:    true, // required for SRV records.
@@ -303,6 +314,8 @@ func (r *dnsRecordResource) Update(ctx context.Context, req resource.UpdateReque
 		return
 	}
 
+	thing, _ := json.Marshal(plan.toUpdateRequest())
+	tflog.Error(ctx, "UPDATE REQUEST", map[string]interface{}{"request": string(thing)})
 	out, err := r.client.UpdateDNSRecord(
 		ctx,
 		plan.TeamID.ValueString(),

vercel/resource_dns_record_model.go

@@ -28,6 +28,7 @@ type DNSRecord struct {
 	TeamID     types.String `tfsdk:"team_id"`
 	Type       types.String `tfsdk:"type"`
 	Value      types.String `tfsdk:"value"`
+	Comment    types.String `tfsdk:"comment"`
 }
 
 func (d DNSRecord) toCreateDNSRecordRequest() client.CreateDNSRecordRequest {
@@ -49,6 +50,7 @@ func (d DNSRecord) toCreateDNSRecordRequest() client.CreateDNSRecordRequest {
 		Type:       d.Type.ValueString(),
 		Value:      d.Value.ValueString(),
 		SRV:        srv,
+		Comment:    d.Comment.ValueString(),
 	}
 }
 
@@ -68,6 +70,7 @@ func (d DNSRecord) toUpdateRequest() client.UpdateDNSRecordRequest {
 		SRV:        srv,
 		TTL:        toInt64Pointer(d.TTL),
 		Value:      toStrPointer(d.Value),
+		Comment:    d.Comment.ValueString(),
 	}
 }
 
@@ -80,6 +83,7 @@ func convertResponseToDNSRecord(r client.DNSRecord, value types.String, srv *SRV
 		TTL:        types.Int64Value(r.TTL),
 		TeamID:     toTeamID(r.TeamID),
 		Type:       types.StringValue(r.RecordType),
+		Comment:    types.StringValue(r.Comment),
 	}
 
 	if r.RecordType == "SRV" {