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 {

cmd/api_capabilities_get_gen.go cmd/api_v1_capabilities_get_gen.go

@@ -1,7 +1,6 @@
 package cmd
 
-// huecfg api lights ...
-type apiLightsCmd struct {
+type apiV1LightsCmd struct {
 	Delete   *apiLightsDeleteCmd   `command:"delete" description:"Delete a device from the bridge"`
 	Get      *apiLightsGetCmd      `command:"get" description:"Fetch the specified light by ID"`
 	GetAll   *apiLightsGetAllCmd   `command:"get-all" description:"Fetch all lights at once"`
@@ -10,45 +9,39 @@ type apiLightsCmd struct {
 	SetState *apiLightsSetStateCmd `command:"set-state" description:"Set the state of a given light"`
 }
 
-// huecfg api lights delete ...
-//go:generate ./gen_api_read.sh ID=lights_delete TYPE=apiLightsDeleteCmd FUNC_CALL=bridge.DeleteLight(c.Arguments.ID)
+//go:generate ./gen_api_read.sh ID=lights_delete TYPE=apiV1LightsDeleteCmd FUNC_CALL=bridge.DeleteLight(c.Arguments.ID)
 type apiLightsDeleteCmd struct {
 	Arguments struct {
 		ID string `description:"ID of the device to delete."`
 	} `positional-args:"true" required:"true" positional-arg-name:"device-ID"`
 }
 
-// huecfg api lights get
-//go:generate ./gen_api_read.sh ID=lights_get TYPE=apiLightsGetCmd FUNC_CALL=bridge.GetLight(c.Arguments.ID)
+//go:generate ./gen_api_read.sh ID=lights_get TYPE=apiV1LightsGetCmd FUNC_CALL=bridge.GetLight(c.Arguments.ID)
 type apiLightsGetCmd struct {
 	Arguments struct {
 		ID string `description:"ID of the light to get attributes of."`
 	} `positional-args:"true" required:"true" positional-arg-name:"light-ID"`
 }
 
-// huecfg api lights get-all
-//go:generate ./gen_api_read.sh ID=lights_all TYPE=apiLightsGetAllCmd FUNC_CALL=bridge.GetLights()
+//go:generate ./gen_api_read.sh ID=lights_all TYPE=apiV1LightsGetAllCmd FUNC_CALL=bridge.GetLights()
 type apiLightsGetAllCmd struct{}
 
-// huecfg api lights search
-//go:generate ./gen_api_read.sh ID=lights_search TYPE=apiLightsSearchCmd FUNC_CALL=bridge.SearchForNewLights(c.Arguments.IDs...)
+//go:generate ./gen_api_read.sh ID=lights_search TYPE=apiV1LightsSearchCmd FUNC_CALL=bridge.SearchForNewLights(c.Arguments.IDs...)
 type apiLightsSearchCmd struct {
 	Arguments struct {
 		IDs []string `description:"ID of the light to get attributes of."`
 	} `positional-args:"true" required:"false" positional-arg-name:"device-ID"`
 }
 
-// huecfg api lights set
-//go:generate ./gen_api_write.sh ID=lights_set TYPE=apiLightsSetCmd "FUNC_CALL=bridge.SetLightAttributes(c.Arguments.ID, data)" DATA=c.Data
+//go:generate ./gen_api_write.sh ID=lights_set TYPE=apiV1LightsSetCmd "FUNC_CALL=bridge.SetLightAttributes(c.Arguments.ID, data)" DATA=c.Data
 type apiLightsSetCmd struct {
 	Data      string `long:"data" description:"JSON data to send"`
 	Arguments struct {
 		ID string `description:"ID of the light to set attributes for."`
 	} `positional-args:"true" required:"true" positional-arg-name:"light-ID"`
 }
 
-// huecfg api lights set-state ...
-//go:generate ./gen_api_write.sh ID=lights_set_state TYPE=apiLightsSetStateCmd "FUNC_CALL=bridge.SetLightState(c.Arguments.ID, data)" DATA=c.Data
+//go:generate ./gen_api_write.sh ID=lights_set_state TYPE=apiV1LightsSetStateCmd "FUNC_CALL=bridge.SetLightState(c.Arguments.ID, data)" DATA=c.Data
 type apiLightsSetStateCmd struct {
 	Data      string `long:"data" description:"JSON data to send" default:"-"`
 	Arguments struct {

cmd/api_config.go cmd/api_v1_config.go

@@ -1,35 +1,30 @@
 package cmd
 
-// huecfg api resourcelinks ...
-type apiResourceLinksCmd struct {
+type apiV1ResourceLinksCmd struct {
 	Create *apiResourceLinksCreateCmd `command:"create" description:"Create a new resourcelink"`
 	Delete *apiResourceLinksDeleteCmd `command:"delete" description:"Delete a device from the bridge"`
 	Get    *apiResourceLinksGetCmd    `command:"get" description:"Fetch the specified resourcelink by ID"`
 	GetAll *apiResourceLinksGetAllCmd `command:"get-all" description:"Fetch all resourcelinks at once"`
 }
 
-// huecfg api resourcelinks create
-//go:generate ./gen_api_write.sh ID=resourcelinks_create TYPE=apiResourceLinksCreateCmd DATA=c.Data FUNC_CALL=bridge.CreateResourceLink(data)
+//go:generate ./gen_api_write.sh ID=resourcelinks_create TYPE=apiV1ResourceLinksCreateCmd DATA=c.Data FUNC_CALL=bridge.CreateResourceLink(data)
 type apiResourceLinksCreateCmd struct {
 	Data string `long:"data" description:"JSON data to send" default:"-"`
 }
 
-// huecfg api resourcelinks delete ...
-//go:generate ./gen_api_read.sh ID=resourcelinks_delete TYPE=apiResourceLinksDeleteCmd FUNC_CALL=bridge.DeleteResourceLink(c.Arguments.ID)
+//go:generate ./gen_api_read.sh ID=resourcelinks_delete TYPE=apiV1ResourceLinksDeleteCmd FUNC_CALL=bridge.DeleteResourceLink(c.Arguments.ID)
 type apiResourceLinksDeleteCmd struct {
 	Arguments struct {
 		ID string `description:"ID of the resourcelink to delete."`
 	} `positional-args:"true" required:"true" positional-arg-name:"resourcelink-ID"`
 }
 
-// huecfg api resourcelinks get ...
-//go:generate ./gen_api_read.sh ID=resourcelinks_get TYPE=apiResourceLinksGetCmd FUNC_CALL=bridge.GetResourceLink(c.Arguments.ID)
+//go:generate ./gen_api_read.sh ID=resourcelinks_get TYPE=apiV1ResourceLinksGetCmd FUNC_CALL=bridge.GetResourceLink(c.Arguments.ID)
 type apiResourceLinksGetCmd struct {
 	Arguments struct {
 		ID string
 	} `positional-args:"true" required:"true" positional-arg-name:"resourcelink-ID"`
 }
 
-// huecfg api resourcelinks get-all
-//go:generate ./gen_api_read.sh ID=resourcelinks_get_all TYPE=apiResourceLinksGetAllCmd FUNC_CALL=bridge.GetResourceLinks()
+//go:generate ./gen_api_read.sh ID=resourcelinks_get_all TYPE=apiV1ResourceLinksGetAllCmd FUNC_CALL=bridge.GetResourceLinks()
 type apiResourceLinksGetAllCmd struct{}

cmd/api_config_dump_gen.go cmd/api_v1_config_dump_gen.go

@@ -1,35 +1,30 @@
 package cmd
 
-// huecfg api rules ...
-type apiRulesCmd struct {
+type apiV1RulesCmd struct {
 	Create *apiRulesCreateCmd `command:"create" description:"Create a new rule"`
 	Delete *apiRulesDeleteCmd `command:"delete" description:"Delete a device from the bridge"`
 	Get    *apiRulesGetCmd    `command:"get" description:"Fetch the specified rule by ID"`
 	GetAll *apiRulesGetAllCmd `command:"get-all" description:"Fetch all rule data at once"`
 }
 
-// huecfg api rules create
-//go:generate ./gen_api_write.sh ID=rules_create TYPE=apiRulesCreateCmd DATA=c.Data FUNC_CALL=bridge.CreateRule(data)
+//go:generate ./gen_api_write.sh ID=rules_create TYPE=apiV1RulesCreateCmd DATA=c.Data FUNC_CALL=bridge.CreateRule(data)
 type apiRulesCreateCmd struct {
 	Data string `long:"data" description:"JSON data to send" default:"-"`
 }
 
-// huecfg api rules delete ...
-//go:generate ./gen_api_read.sh ID=rules_delete TYPE=apiRulesDeleteCmd FUNC_CALL=bridge.DeleteRule(c.Arguments.ID)
+//go:generate ./gen_api_read.sh ID=rules_delete TYPE=apiV1RulesDeleteCmd FUNC_CALL=bridge.DeleteRule(c.Arguments.ID)
 type apiRulesDeleteCmd struct {
 	Arguments struct {
 		ID string `description:"ID of the rule to delete."`
 	} `positional-args:"true" required:"true" positional-arg-name:"rule-ID"`
 }
 
-// huecfg api rules get
-//go:generate ./gen_api_read.sh ID=rules_get TYPE=apiRulesGetCmd FUNC_CALL=bridge.GetRule(c.Arguments.ID)
+//go:generate ./gen_api_read.sh ID=rules_get TYPE=apiV1RulesGetCmd FUNC_CALL=bridge.GetRule(c.Arguments.ID)
 type apiRulesGetCmd struct {
 	Arguments struct {
 		ID string
 	} `positional-args:"true" required:"true" positional-arg-name:"rule-ID"`
 }
 
-// huecfg api rules get-all
-//go:generate ./gen_api_read.sh ID=rules_get_all TYPE=apiRulesGetAllCmd FUNC_CALL=bridge.GetRules()
+//go:generate ./gen_api_read.sh ID=rules_get_all TYPE=apiV1RulesGetAllCmd FUNC_CALL=bridge.GetRules()
 type apiRulesGetAllCmd struct{}

cmd/api_config_get_gen.go cmd/api_v1_config_get_gen.go

@@ -1,37 +1,32 @@
 package cmd
 
-// huecfg api scenes ...
-type apiScenesCmd struct {
+type apiV1ScenesCmd struct {
 	Create *apiScenesCreateCmd `command:"create" description:"Create a new scene"`
 	Delete *apiScenesDeleteCmd `command:"delete" description:"Delete a device from the bridge"`
 	Get    *apiLightsGetCmd    `command:"get" description:"Fetch the specified scene by ID"`
 	GetAll *apiLightsGetAllCmd `command:"get-all" description:"Fetch all scenes at once"`
 }
 
-// huecfg api scenes create
-//go:generate ./gen_api_write.sh ID=scenes_create TYPE=apiScenesCreateCmd DATA=c.Data FUNC_CALL=bridge.CreateScene(data)
+//go:generate ./gen_api_write.sh ID=scenes_create TYPE=apiV1ScenesCreateCmd DATA=c.Data FUNC_CALL=bridge.CreateScene(data)
 type apiScenesCreateCmd struct {
 	Data string `long:"data" description:"JSON data to send" default:"-"`
 }
 
-// huecfg api scenes delete ...
-//go:generate ./gen_api_read.sh ID=scenes_delete TYPE=apiScenesDeleteCmd FUNC_CALL=bridge.DeleteScene(c.Arguments.ID)
+//go:generate ./gen_api_read.sh ID=scenes_delete TYPE=apiV1ScenesDeleteCmd FUNC_CALL=bridge.DeleteScene(c.Arguments.ID)
 type apiScenesDeleteCmd struct {
 	Arguments struct {
 		ID string `description:"ID of the scene to delete."`
 	} `positional-args:"true" required:"true" positional-arg-name:"scene-ID"`
 }
 
-// huecfg api scenes get-all
-//go:generate ./gen_api_read.sh ID=scenes_get_all TYPE=apiScenesGetAllCmd FUNC_CALL=bridge.GetScenes()
+//go:generate ./gen_api_read.sh ID=scenes_get_all TYPE=apiV1ScenesGetAllCmd FUNC_CALL=bridge.GetScenes()
 type apiScenesGetAllCmd struct {
 	Arguments struct {
 		ID string
 	} `positional-args:"true" required:"true" positional-arg-name:"scene-ID"`
 }
 
-// huecfg api scenes get
-//go:generate ./gen_api_read.sh ID=scenes_get TYPE=apiScenesGetCmd FUNC_CALL=bridge.GetScene(c.Arguments.ID)
+//go:generate ./gen_api_read.sh ID=scenes_get TYPE=apiV1ScenesGetCmd FUNC_CALL=bridge.GetScene(c.Arguments.ID)
 type apiScenesGetCmd struct {
 	Arguments struct {
 		ID string

cmd/api_groups.go cmd/api_v1_groups.go

@@ -1,32 +1,28 @@
 package cmd
 
-// huecfg api schedules ...
-type apiSchedulesCmd struct {
+type apiV1SchedulesCmd struct {
 	Create *apiSchedulesCreateCmd `command:"create" description:"Create a new scehdule"`
 	Delete *apiSchedulesDeleteCmd `command:"delete" description:"Delete a device from the bridge"`
 	Get    *apiSchedulesGetCmd    `command:"get" description:"Fetch the specified schedule by ID"`
 	GetAll *apiSchedulesGetAllCmd `command:"get-all" description:"Fetch all schedule data at once"`
 }
 
-// huecfg api schedules create
-//go:generate ./gen_api_write.sh ID=schedules_create TYPE=apiSchedulesCreateCmd DATA=c.Data FUNC_CALL=bridge.CreateSchedule(data)
+//go:generate ./gen_api_write.sh ID=schedules_create TYPE=apiV1SchedulesCreateCmd DATA=c.Data FUNC_CALL=bridge.CreateSchedule(data)
 type apiSchedulesCreateCmd struct {
 	Data string `long:"data" description:"JSON data to send" default:"-"`
 }
 
-// huecfg api schedules delete ...
-//go:generate ./gen_api_read.sh ID=schedules_delete TYPE=apiSchedulesDeleteCmd FUNC_CALL=bridge.DeleteSchedule(c.Arguments.ID)
+//go:generate ./gen_api_read.sh ID=schedules_delete TYPE=apiV1SchedulesDeleteCmd FUNC_CALL=bridge.DeleteSchedule(c.Arguments.ID)
 type apiSchedulesDeleteCmd struct {
 	Arguments struct {
 		ID string `description:"ID of the schedule to delete."`
 	} `positional-args:"true" required:"true" positional-arg-name:"schedule-ID"`
 }
 
-//go:generate ./gen_api_read.sh ID=schedules_all TYPE=apiSchedulesGetAllCmd FUNC_CALL=bridge.GetSchedules()
+//go:generate ./gen_api_read.sh ID=schedules_all TYPE=apiV1SchedulesGetAllCmd FUNC_CALL=bridge.GetSchedules()
 type apiSchedulesGetAllCmd struct{}
 
-// huecfg api schedules get ...
-//go:generate ./gen_api_read.sh ID=schedules_get TYPE=apiSchedulesGetCmd FUNC_CALL=bridge.GetSchedule(c.Arguments.ID)
+//go:generate ./gen_api_read.sh ID=schedules_get TYPE=apiV1SchedulesGetCmd FUNC_CALL=bridge.GetSchedule(c.Arguments.ID)
 type apiSchedulesGetCmd struct {
 	Arguments struct {
 		ID string