Remove "locked" flag of DNS records (#1618)

This flag hasn't been used in quite a while and we're preparing to remove it from the API.
cloudflare · Mar 27, 2024 · 7a9a8ef · 7a9a8ef
1 parent 228b052
commit 7a9a8ef
Show file tree

Hide file tree

Showing 7 changed files with 8 additions and 23 deletions.
diff --git a/.changelog/1618.txt b/.changelog/1618.txt
@@ -0,0 +1,3 @@
+```release-note:breaking-change
+dns: Remove "locked" flag which is always false
+```
diff --git a/cmd/flarectl/README.md b/cmd/flarectl/README.md
@@ -98,9 +98,9 @@ a23b50de3c064a5a860e8b84cd2b382c Challenge Chrome v61 challenge Mozilla/5.0 (Mac
 ```sh
 ~ flarectl dns create --zone="example.com" --name="app" --type="CNAME" --content="myapp.herokuapp.com" --proxy
 
-ID                               Name                      Type  Content             TTL Proxiable Proxy Locked
--------------------------------- ------------------------- ----- ------------------- --- --------- ----- ------
-5c5d051f7944cf4715127270dd4d05f4 app.questionable.services CNAME myapp.herokuapp.com 1   true      true  false
+ID                               Name                      Type  Content             TTL Proxiable Proxy
+-------------------------------- ------------------------- ----- ------------------- --- --------- -----
+5c5d051f7944cf4715127270dd4d05f4 app.questionable.services CNAME myapp.herokuapp.com 1   true      true
 ```
 
 ## License

diff --git a/cmd/flarectl/dns.go b/cmd/flarectl/dns.go
@@ -20,7 +20,6 @@ func formatDNSRecord(record cloudflare.DNSRecord) []string {
 		strconv.FormatInt(int64(record.TTL), 10),
 		strconv.FormatBool(record.Proxiable),
 		strconv.FormatBool(*record.Proxied),
-		strconv.FormatBool(record.Locked),
 	}
 }
 
@@ -60,7 +59,7 @@ func dnsCreate(c *cli.Context) error {
 		formatDNSRecord(result),
 	}
 
-	writeTable(c, output, "ID", "Name", "Type", "Content", "TTL", "Proxiable", "Proxy", "Locked")
+	writeTable(c, output, "ID", "Name", "Type", "Content", "TTL", "Proxiable", "Proxy")
 
 	return nil
 }
@@ -135,7 +134,7 @@ func dnsCreateOrUpdate(c *cli.Context) error {
 		formatDNSRecord(result),
 	}
 
-	writeTable(c, output, "ID", "Name", "Type", "Content", "TTL", "Proxiable", "Proxy", "Locked")
+	writeTable(c, output, "ID", "Name", "Type", "Content", "TTL", "Proxiable", "Proxy")
 
 	return nil
 }

diff --git a/dns.go b/dns.go
@@ -33,7 +33,6 @@ type DNSRecord struct {
 	TTL        int         `json:"ttl,omitempty"`
 	Proxied    *bool       `json:"proxied,omitempty"`
 	Proxiable  bool        `json:"proxiable,omitempty"`
-	Locked     bool        `json:"locked,omitempty"`
 	Comment    string      `json:"comment,omitempty"` // the server will omit the comment field when the comment is empty
 	Tags       []string    `json:"tags,omitempty"`
 }
@@ -192,7 +191,6 @@ type CreateDNSRecordParams struct {
 	TTL        int         `json:"ttl,omitempty"`
 	Proxied    *bool       `json:"proxied,omitempty" url:"proxied,omitempty"`
 	Proxiable  bool        `json:"proxiable,omitempty"`
-	Locked     bool        `json:"locked,omitempty"`
 	Comment    string      `json:"comment,omitempty" url:"comment,omitempty"` // to the server, there's no difference between "no comment" and "empty comment"
 	Tags       []string    `json:"tags,omitempty"`
 }

diff --git a/dns_test.go b/dns_test.go
@@ -98,7 +98,6 @@ func TestCreateDNSRecord(t *testing.T) {
 				"proxiable": true,
 				"proxied": false,
 				"ttl": 120,
-				"locked": false,
 				"zone_id": "d56084adb405e0b7e32c52321bf07be6",
 				"zone_name": "example.com",
 				"created_on": "2014-01-01T05:20:00Z",
@@ -180,7 +179,6 @@ func TestListDNSRecords(t *testing.T) {
 					"proxiable": true,
 					"proxied": false,
 					"ttl": 120,
-					"locked": false,
 					"zone_id": "d56084adb405e0b7e32c52321bf07be6",
 					"zone_name": "example.com",
 					"created_on": "2014-01-01T05:20:00Z",
@@ -214,7 +212,6 @@ func TestListDNSRecords(t *testing.T) {
 		Proxiable:  true,
 		Proxied:    &proxied,
 		TTL:        120,
-		Locked:     false,
 		ZoneID:     testZoneID,
 		ZoneName:   "example.com",
 		CreatedOn:  createdOn,
@@ -275,7 +272,6 @@ func TestListDNSRecordsSearch(t *testing.T) {
 					"proxiable": true,
 					"proxied": true,
 					"ttl": 120,
-					"locked": false,
 					"zone_id": "d56084adb405e0b7e32c52321bf07be6",
 					"zone_name": "example.com",
 					"created_on": "2014-01-01T05:20:00Z",
@@ -310,7 +306,6 @@ func TestListDNSRecordsSearch(t *testing.T) {
 		Proxiable:  true,
 		Proxied:    &proxied,
 		TTL:        120,
-		Locked:     false,
 		ZoneID:     testZoneID,
 		ZoneName:   "example.com",
 		CreatedOn:  createdOn,
@@ -408,7 +403,6 @@ func TestListDNSRecordsPagination(t *testing.T) {
 		assert.Equal(t, expected["proxiable"].(bool), actualRecord.Proxiable)
 		assert.Equal(t, expected["proxied"].(bool), *actualRecord.Proxied)
 		assert.Equal(t, int(expected["ttl"].(float64)), actualRecord.TTL)
-		assert.Equal(t, expected["locked"].(bool), actualRecord.Locked)
 		assert.Equal(t, expected["zone_id"].(string), actualRecord.ZoneID)
 		assert.Equal(t, expected["zone_name"].(string), actualRecord.ZoneName)
 		assert.Equal(t, expected["data"], actualRecord.Data)
@@ -436,7 +430,6 @@ func TestGetDNSRecord(t *testing.T) {
 				"proxiable": true,
 				"proxied": false,
 				"ttl": 120,
-				"locked": false,
 				"zone_id": "d56084adb405e0b7e32c52321bf07be6",
 				"zone_name": "example.com",
 				"created_on": "2014-01-01T05:20:00Z",
@@ -528,7 +521,6 @@ func TestUpdateDNSRecord(t *testing.T) {
 				"proxiable": true,
 				"proxied": false,
 				"ttl": 120,
-				"locked": false,
 				"zone_id": "d56084adb405e0b7e32c52321bf07be6",
 				"zone_name": "example.com",
 				"created_on": "2014-01-01T05:20:00Z",
@@ -594,7 +586,6 @@ func TestUpdateDNSRecord_ClearComment(t *testing.T) {
 				"proxiable": true,
 				"proxied": false,
 				"ttl": 120,
-				"locked": false,
 				"zone_id": "d56084adb405e0b7e32c52321bf07be6",
 				"zone_name": "example.com",
 				"created_on": "2014-01-01T05:20:00Z",
@@ -651,7 +642,6 @@ func TestUpdateDNSRecord_KeepComment(t *testing.T) {
 				"proxiable": true,
 				"proxied": false,
 				"ttl": 120,
-				"locked": false,
 				"zone_id": "d56084adb405e0b7e32c52321bf07be6",
 				"zone_name": "example.com",
 				"created_on": "2014-01-01T05:20:00Z",

diff --git a/testdata/fixtures/dns/list_page_1.json b/testdata/fixtures/dns/list_page_1.json
@@ -11,7 +11,6 @@
             "proxiable": true,
             "proxied": true,
             "ttl": 120,
-            "locked": false,
             "zone_id": "d56084adb405e0b7e32c52321bf07be6",
             "zone_name": "example.com",
             "created_on": "2014-01-01T05:20:00Z",
@@ -34,7 +33,6 @@
             "proxiable": true,
             "proxied": false,
             "ttl": 120,
-            "locked": false,
             "zone_id": "d56084adb405e0b7e32c52321bf07be6",
             "zone_name": "example.com",
             "created_on": "2014-01-01T05:20:00Z",
@@ -57,7 +55,6 @@
             "proxiable": true,
             "proxied": true,
             "ttl": 120,
-            "locked": false,
             "zone_id": "d56084adb405e0b7e32c52321bf07be6",
             "zone_name": "example.com",
             "created_on": "2014-01-01T05:20:00Z",

diff --git a/testdata/fixtures/dns/list_page_2.json b/testdata/fixtures/dns/list_page_2.json
@@ -11,7 +11,6 @@
             "proxiable": true,
             "proxied": false,
             "ttl": 120,
-            "locked": false,
             "zone_id": "d56084adb405e0b7e32c52321bf07be6",
             "zone_name": "example.com",
             "created_on": "2014-01-01T05:20:00Z",
@@ -34,7 +33,6 @@
             "proxiable": true,
             "proxied": false,
             "ttl": 120,
-            "locked": false,
             "zone_id": "d56084adb405e0b7e32c52321bf07be6",
             "zone_name": "example.com",
             "created_on": "2014-01-01T05:20:00Z",