update auto-gen code

reubenmiller · May 17, 2024 · af7be5b · af7be5b
1 parent 208a14f
commit af7be5b
Show file tree

Hide file tree

Showing 7 changed files with 22 additions and 19 deletions.
diff --git a/api/spec/json/remoteAccessConfigurations.json b/api/spec/json/remoteAccessConfigurations.json
@@ -1,7 +1,7 @@
 {
   "group": {
     "name": "remoteaccess/configurations",
-    "description": "Manage Cloud Remote Access configuration",
+    "description": "Manage remote access configurations",
     "descriptionLong": "Cloud Remote Access configuration management",
     "link": "https://cumulocity.com/docs/cloud-remote-access/using-cloud-remote-access/"
   },
@@ -47,7 +47,7 @@
     },
     {
       "name": "get",
-      "description": "Get remote access configuration",
+      "description": "Get a remote access configuration",
       "descriptionLong": "Get an existing remote access configuration for a device",
       "alias": {
         "go": "get",
@@ -138,10 +138,11 @@
       ],
       "body": [
         {
-          "name": "name",
+          "name": "newName",
           "type": "string",
-          "description": "Profile name",
-          "required": true
+          "property": "name",
+          "required": false,
+          "description": "New configuration name"
         }
       ]
     },

diff --git a/api/spec/yaml/remoteAccessConfigurations.yaml b/api/spec/yaml/remoteAccessConfigurations.yaml
@@ -2,7 +2,7 @@
 ---
 group:
   name: remoteaccess/configurations
-  description: Manage Cloud Remote Access configuration
+  description: Manage remote access configurations
   descriptionLong: Cloud Remote Access configuration management
   link: https://cumulocity.com/docs/cloud-remote-access/using-cloud-remote-access/
 
@@ -35,7 +35,7 @@ commands:
         pipeline: true
 
   - name: get
-    description: Get remote access configuration
+    description: Get a remote access configuration
     descriptionLong: Get an existing remote access configuration for a device
     alias:
       go: get
@@ -65,6 +65,8 @@ commands:
         pipeline: true
 
   - name: update
+    # Hide for now, as updating requires to PUT the entire existing state into the body plus the desired changes
+    # For power-users this might be manageable but it is just a poor user experience
     hidden: true
     description: Update remote access configuration
     descriptionLong: Update an existing remote access configuration
@@ -96,10 +98,11 @@ commands:
         description: Connection
         pipeline: true
     body:
-      - name: name
+      - name: newName
         type: string
-        description: Profile name
-        required: true
+        property: name
+        required: false
+        description: New configuration name
 
   - name: delete
     description: Delete remote access configuration

diff --git a/pkg/cmd/remoteaccess/configurations/configurations.auto.go b/pkg/cmd/remoteaccess/configurations/configurations.auto.go
@@ -23,7 +23,7 @@ func NewSubCommand(f *cmdutil.Factory) *SubCmdConfigurations {
 
 	cmd := &cobra.Command{
 		Use:   "configurations",
-		Short: "Manage Cloud Remote Access configuration",
+		Short: "Manage remote access configurations",
 		Long:  `Cloud Remote Access configuration management`,
 	}
 

diff --git a/pkg/cmd/remoteaccess/configurations/get/get.auto.go b/pkg/cmd/remoteaccess/configurations/get/get.auto.go
diff --git a/pkg/cmd/remoteaccess/configurations/update/update.auto.go b/pkg/cmd/remoteaccess/configurations/update/update.auto.go
diff --git a/pkg/cmd/remoteaccess/connect/connect.manual.go b/pkg/cmd/remoteaccess/connect/connect.manual.go
@@ -16,8 +16,8 @@ func NewSubCommand(f *cmdutil.Factory) *SubCmdConnect {
 
 	cmd := &cobra.Command{
 		Use:   "connect",
-		Short: "Connect to device via remote access",
-		Long:  `Connect to device via remote access`,
+		Short: "Connect to a device",
+		Long:  `Connect to a device using the protocol defined in an existing configuration`,
 	}
 
 	// Subcommands

diff --git a/tools/PSc8y/Public/Get-RemoteAccessConfiguration.ps1 b/tools/PSc8y/Public/Get-RemoteAccessConfiguration.ps1
@@ -2,7 +2,7 @@
 Function Get-RemoteAccessConfiguration {
 <#
 .SYNOPSIS
-Get remote access configuration
+Get a remote access configuration
 
 .DESCRIPTION
 Get an existing remote access configuration for a device