Rename v1 APIs in prep for introducing v2 (CLIP)

Author: dansimau

TODO.md

@@ -1,20 +1,12 @@
 package cmd
 
 func init() {
-	_, err := parser.AddCommand("api", "Interact directly with the Hue Bridge JSON API", "", &apiCmd{})
+	_, err := parser.AddCommand("api", "Interact with Hue Bridge APIs", "", &apiCmd{})
 	if err != nil {
 		panic(err)
 	}
 }
 
 type apiCmd struct {
-	APICapabilities  *apiCapabilitiesCmd  `command:"capabilities" description:"Show capabilities and resource usage"`
-	APIConfig        *apiConfigCmd        `command:"config" description:"Manage config"`
-	APIGroups        *apiGroupsCmd        `command:"groups" description:"Manage groups"`
-	APILights        *apiLightsCmd        `command:"lights" description:"Manage lights"`
-	APIResourceLinks *apiResourceLinksCmd `command:"resourcelinks" description:"Manage resource links"`
-	APIRules         *apiRulesCmd         `command:"rules" description:"Manage rules"`
-	APIScenes        *apiScenesCmd        `command:"scenes" description:"Manage scenes"`
-	APISchedules     *apiSchedulesCmd     `command:"schedules" description:"Manage schedules"`
-	APISensors       *apiSensorsCmd       `command:"sensors" description:"Manage sensors"`
+	V1 *apiV1Cmd `command:"v1" description:"Interact with v1 of the Hue Bridge API"`
 }

cmd/api.go

@@ -0,0 +1,13 @@
+package cmd
+
+type apiV1Cmd struct {
+	APICapabilities  *apiV1CapabilitiesCmd  `command:"capabilities" description:"Show capabilities and resource usage"`
+	APIConfig        *apiV1ConfigCmd        `command:"config" description:"Manage config"`
+	APIGroups        *apiV1GroupsCmd        `command:"groups" description:"Manage groups"`
+	APILights        *apiV1LightsCmd        `command:"lights" description:"Manage lights"`
+	APIResourceLinks *apiV1ResourceLinksCmd `command:"resourcelinks" description:"Manage resource links"`
+	APIRules         *apiV1RulesCmd         `command:"rules" description:"Manage rules"`
+	APIScenes        *apiV1ScenesCmd        `command:"scenes" description:"Manage scenes"`
+	APISchedules     *apiV1SchedulesCmd     `command:"schedules" description:"Manage schedules"`
+	APISensors       *apiV1SensorsCmd       `command:"sensors" description:"Manage sensors"`
+}

cmd/api_capabilities.go

@@ -0,0 +1,4 @@
+package cmd
+
+//go:generate ./gen_api_read.sh ID=capabilities_get TYPE=apiV1CapabilitiesCmd FUNC_CALL=bridge.GetCapabilities()
+type apiV1CapabilitiesCmd struct{}

cmd/api_v1.go

@@ -7,14 +7,12 @@ import (
 	"github.com/dansimau/huecfg/pkg/jsonutil"
 )
 
-// huecfg api config ...
-type apiConfigCmd struct {
+type apiV1ConfigCmd struct {
 	CreateUser *apiConfigCreateUserCmd `command:"create-user" description:"Create user to interact with Hue Bridge"`
 	Dump       *apiConfigDumpCmd       `command:"dump" description:"Fetch the full state of the device in a single JSON document"`
 	Get        *apiConfigGetCmd        `command:"get" description:"Show Hue Bridge configuration"`
 }
 
-// huecfg api config create-user
 type apiConfigCreateUserCmd struct {
 	DeviceType        string `long:"device-type" description:"A string in the format '<application_name>#<devicename>'" default:"huecfg#cli"`
 	GenerateClientKey bool   `long:"generate-client-key" description:"Generate a random username"`
@@ -39,10 +37,8 @@ func (c *apiConfigCreateUserCmd) Execute(args []string) error {
 	return nil
 }
 
-// huecfg api config dump
-//go:generate ./gen_api_read.sh ID=config_dump TYPE=apiConfigDumpCmd FUNC_CALL=bridge.GetFullState()
+//go:generate ./gen_api_read.sh ID=config_dump TYPE=apiV1ConfigDumpCmd FUNC_CALL=bridge.GetFullState()
 type apiConfigDumpCmd struct{}
 
-// huecfg api config get
-//go:generate ./gen_api_read.sh ID=config_get TYPE=apiConfigGetCmd FUNC_CALL=bridge.GetConfig()
+//go:generate ./gen_api_read.sh ID=config_get TYPE=apiV1ConfigGetCmd FUNC_CALL=bridge.GetConfig()
 type apiConfigGetCmd struct{}

cmd/api_v1_capabilities.go

@@ -1,7 +1,6 @@
 package cmd
 
-// huecfg api groups ...
-type apiGroupsCmd struct {
+type apiV1GroupsCmd struct {
 	Create   *apiGroupsCreateCmd   `command:"create" description:"Create a new group"`
 	Delete   *apiGroupsDeleteCmd   `command:"delete" description:"Delete a device from the bridge"`
 	Get      *apiGroupsGetCmd      `command:"get" description:"Fetch the specified group by ID"`
@@ -10,43 +9,37 @@ type apiGroupsCmd struct {
 	SetState *apiGroupsSetStateCmd `command:"set-state" description:"Set the state of all lights in a group"`
 }
 
-// huecfg api groups create
-//go:generate ./gen_api_write.sh ID=groups_create TYPE=apiGroupsCreateCmd DATA=c.Data FUNC_CALL=bridge.CreateGroup(data)
+//go:generate ./gen_api_write.sh ID=groups_create TYPE=apiV1GroupsCreateCmd DATA=c.Data FUNC_CALL=bridge.CreateGroup(data)
 type apiGroupsCreateCmd struct {
 	Data string `long:"data" description:"JSON data to send" default:"-"`
 }
 
-// huecfg api groups delete ...
-//go:generate ./gen_api_read.sh ID=groups_delete TYPE=apiGroupsDeleteCmd FUNC_CALL=bridge.DeleteGroup(c.Arguments.ID)
+//go:generate ./gen_api_read.sh ID=groups_delete TYPE=apiV1GroupsDeleteCmd FUNC_CALL=bridge.DeleteGroup(c.Arguments.ID)
 type apiGroupsDeleteCmd struct {
 	Arguments struct {
 		ID string `description:"ID of the group to delete."`
 	} `positional-args:"true" required:"true" positional-arg-name:"group-ID"`
 }
 
-// huecfg api groups get-all
-//go:generate ./gen_api_read.sh ID=groups_get_all TYPE=apiGroupsGetAllCmd FUNC_CALL=bridge.GetGroups()
+//go:generate ./gen_api_read.sh ID=groups_get_all TYPE=apiV1GroupsGetAllCmd FUNC_CALL=bridge.GetGroups()
 type apiGroupsGetAllCmd struct{}
 
-// huecfg api groups get
-//go:generate ./gen_api_read.sh ID=groups_get TYPE=apiGroupsGetCmd FUNC_CALL=bridge.GetGroup(c.Arguments.ID)
+//go:generate ./gen_api_read.sh ID=groups_get TYPE=apiV1GroupsGetCmd FUNC_CALL=bridge.GetGroup(c.Arguments.ID)
 type apiGroupsGetCmd struct {
 	Arguments struct {
 		ID string
 	} `positional-args:"true" required:"true" positional-arg-name:"group-ID"`
 }
 
-// huecfg api groups set
-//go:generate ./gen_api_write.sh ID=groups_set TYPE=apiGroupsSetCmd "FUNC_CALL=bridge.SetGroupAttributes(c.Arguments.ID, data)" DATA=c.Data
+//go:generate ./gen_api_write.sh ID=groups_set TYPE=apiV1GroupsSetCmd "FUNC_CALL=bridge.SetGroupAttributes(c.Arguments.ID, data)" DATA=c.Data
 type apiGroupsSetCmd struct {
 	Data      string `long:"data" description:"JSON data to send"`
 	Arguments struct {
 		ID string `description:"ID of the group to set attributes for."`
 	} `positional-args:"true" required:"true" positional-arg-name:"light-ID"`
 }
 
-// huecfg api groups set-state ...
-//go:generate ./gen_api_write.sh ID=groups_set_state TYPE=apiGroupsSetStateCmd "FUNC_CALL=bridge.SetGroupState(c.Arguments.ID, data)" DATA=c.Data
+//go:generate ./gen_api_write.sh ID=groups_set_state TYPE=apiV1GroupsSetStateCmd "FUNC_CALL=bridge.SetGroupState(c.Arguments.ID, data)" DATA=c.Data
 type apiGroupsSetStateCmd struct {
 	Data      string `long:"data" description:"JSON data to send" default:"-"`
 	Arguments struct {