Merge pull request #795 from fastly/fgsch/more_renaming

Rename object store 'keys' to 'entry' for consistency

pkg/app/commands.go

@@ -42,7 +42,7 @@ import (
 	"github.com/fastly/cli/pkg/commands/logging/syslog"
 	"github.com/fastly/cli/pkg/commands/logtail"
 	"github.com/fastly/cli/pkg/commands/objectstore"
-	"github.com/fastly/cli/pkg/commands/objectstorekeys"
+	"github.com/fastly/cli/pkg/commands/objectstoreentry"
 	"github.com/fastly/cli/pkg/commands/pop"
 	"github.com/fastly/cli/pkg/commands/profile"
 	"github.com/fastly/cli/pkg/commands/purge"
@@ -303,11 +303,11 @@ func defineCommands(
 	objectstoreDelete := objectstore.NewDeleteCommand(objectstoreCmdRoot.CmdClause, globals, data)
 	objectstoreDescribe := objectstore.NewDescribeCommand(objectstoreCmdRoot.CmdClause, globals, data)
 	objectstoreList := objectstore.NewListCommand(objectstoreCmdRoot.CmdClause, globals, data)
-	objectstoreKeysCmdRoot := objectstorekeys.NewRootCommand(app, globals)
-	objectstoreCreateKey := objectstorekeys.NewCreateCommand(objectstoreKeysCmdRoot.CmdClause, globals, data)
-	objectstoreDeleteKey := objectstorekeys.NewDeleteCommand(objectstoreKeysCmdRoot.CmdClause, globals, data)
-	objectstoreGetKey := objectstorekeys.NewGetCommand(objectstoreKeysCmdRoot.CmdClause, globals, data)
-	objectstoreListKeys := objectstorekeys.NewListCommand(objectstoreKeysCmdRoot.CmdClause, globals, data)
+	objectstoreentryCmdRoot := objectstoreentry.NewRootCommand(app, globals)
+	objectstoreentryCreate := objectstoreentry.NewCreateCommand(objectstoreentryCmdRoot.CmdClause, globals, data)
+	objectstoreentryDelete := objectstoreentry.NewDeleteCommand(objectstoreentryCmdRoot.CmdClause, globals, data)
+	objectstoreentryDescribe := objectstoreentry.NewDescribeCommand(objectstoreentryCmdRoot.CmdClause, globals, data)
+	objectstoreentryList := objectstoreentry.NewListCommand(objectstoreentryCmdRoot.CmdClause, globals, data)
 	popCmdRoot := pop.NewRootCommand(app, globals)
 	profileCmdRoot := profile.NewRootCommand(app, globals)
 	profileCreate := profile.NewCreateCommand(profileCmdRoot.CmdClause, profile.APIClientFactory(opts.APIClient), globals)
@@ -631,13 +631,13 @@ func defineCommands(
 		loggingSyslogList,
 		loggingSyslogUpdate,
 		objectstoreCreate,
-		objectstoreList,
 		objectstoreDelete,
 		objectstoreDescribe,
-		objectstoreListKeys,
-		objectstoreCreateKey,
-		objectstoreGetKey,
-		objectstoreDeleteKey,
+		objectstoreList,
+		objectstoreentryCreate,
+		objectstoreentryDelete,
+		objectstoreentryDescribe,
+		objectstoreentryList,
 		popCmdRoot,
 		profileCmdRoot,
 		profileCreate,

pkg/app/run_test.go

@@ -71,7 +71,7 @@ ip-list
 log-tail
 logging
 object-store
-object-store-keys
+object-store-entry
 pops
 profile
 purge

pkg/commands/objectstorekeys/create.go → pkg/commands/objectstoreentry/create.go

@@ -1,4 +1,4 @@
-package objectstorekeys
+package objectstoreentry
 
 import (
 	"io"

pkg/commands/objectstorekeys/delete.go → pkg/commands/objectstoreentry/delete.go

@@ -1,4 +1,4 @@
-package objectstorekeys
+package objectstoreentry
 
 import (
 	"io"

pkg/commands/objectstorekeys/get.go → pkg/commands/objectstoreentry/describe.go

@@ -1,4 +1,4 @@
-package objectstorekeys
+package objectstoreentry
 
 import (
 	"io"
@@ -11,23 +11,23 @@ import (
 	"github.com/fastly/go-fastly/v7/fastly"
 )
 
-// GetCommand calls the Fastly API to fetch the value of a key from an object store.
-type GetCommand struct {
+// DescribeCommand calls the Fastly API to fetch the value of a key from an object store.
+type DescribeCommand struct {
 	cmd.Base
 	json     bool
 	manifest manifest.Data
 	Input    fastly.GetObjectStoreKeyInput
 }
 
-// NewGetCommand returns a usable command registered under the parent.
-func NewGetCommand(parent cmd.Registerer, globals *config.Data, data manifest.Data) *GetCommand {
-	c := GetCommand{
+// NewDescribeCommand returns a usable command registered under the parent.
+func NewDescribeCommand(parent cmd.Registerer, globals *config.Data, data manifest.Data) *DescribeCommand {
+	c := DescribeCommand{
 		Base: cmd.Base{
 			Globals: globals,
 		},
 		manifest: data,
 	}
-	c.CmdClause = parent.Command("get", "Get the value associated with a key")
+	c.CmdClause = parent.Command("describe", "Get the value associated with a key").Alias("get")
 	c.CmdClause.Flag("store-id", "Store ID").Short('s').Required().StringVar(&c.Input.ID)
 	c.CmdClause.Flag("key-name", "Key name").Short('k').Required().StringVar(&c.Input.Key)
 
@@ -43,7 +43,7 @@ func NewGetCommand(parent cmd.Registerer, globals *config.Data, data manifest.Da
 }
 
 // Exec invokes the application logic for the command.
-func (c *GetCommand) Exec(_ io.Reader, out io.Writer) error {
+func (c *DescribeCommand) Exec(_ io.Reader, out io.Writer) error {
 	if c.Globals.Verbose() && c.json {
 		return fsterr.ErrInvalidVerboseJSONCombo
 	}

pkg/commands/objectstoreentry/doc.go

@@ -0,0 +1,3 @@
+// Package objectstoreentry contains commands to inspect and manipulate Fastly edge
+// object stores keys.
+package objectstoreentry

pkg/commands/objectstorekeys/list.go → pkg/commands/objectstoreentry/list.go

@@ -1,4 +1,4 @@
-package objectstorekeys
+package objectstoreentry
 
 import (
 	"encoding/json"

pkg/commands/objectstorekeys/root.go → pkg/commands/objectstoreentry/root.go

@@ -1,4 +1,4 @@
-package objectstorekeys
+package objectstoreentry
 
 import (
 	"io"
@@ -18,7 +18,7 @@ type RootCommand struct {
 func NewRootCommand(parent cmd.Registerer, globals *config.Data) *RootCommand {
 	var c RootCommand
 	c.Globals = globals
-	c.CmdClause = parent.Command("object-store-keys", "Manipulate Fastly Object Store keys")
+	c.CmdClause = parent.Command("object-store-entry", "Manipulate Fastly Object Store keys")
 	return &c
 }