feat: adding support for chaining c8y userreferences addUserToGroup…

… using pipeline docs: `c8y userreferences` adding more examples and fixing some existing
reubenmiller · May 19, 2021 · 35255ec · 35255ec
1 parent 0215e81
commit 35255ec
Show file tree

Hide file tree

Showing 11 changed files with 69 additions and 28 deletions.
diff --git a/api/spec/json/userReferences.json b/api/spec/json/userReferences.json
@@ -1,6 +1,6 @@
 {
   "information": {
-    "name": "userReferences",
+    "name": "userreferences",
     "description": "Cumulocity user references",
     "descriptionLong": "REST endpoint to interact with Cumulocity user references",
     "link": "https://cumulocity.com/guides/reference/users/#user-reference-collection"
@@ -33,8 +33,12 @@
         ],
         "go": [
           {
-            "description": "List the users within a user group",
-            "command": "c8y userReferences addUserToGroup --group 1 --user myuser"
+            "description": "Add a user to a user group",
+            "command": "c8y userreferences addUserToGroup --group 1 --user myuser"
+          },
+          {
+            "description": "Add a list of users to business and admins group using pipeline",
+            "command": "c8y users list | c8y userreferences addUserToGroup --group business | c8y userreferences addUserToGroup --group admins"
           }
         ]
       },
@@ -61,6 +65,7 @@
           "property": "user.self",
           "description": "User id",
           "pipelineAliases": [
+            "user.id",
             "id",
             "self"
           ]
@@ -81,7 +86,7 @@
       "examples": {
         "powershell": [
           {
-            "description": "Add a user to a user group",
+            "description": "From a user from a user group",
             "beforeEach": [
               "$User = New-TestUser",
               "$Group = Get-UserGroupByName -Name \"business\"",
@@ -95,8 +100,12 @@
         ],
         "go": [
           {
-            "description": "List the users within a user group",
-            "command": "c8y userReferences deleteUserFromGroup --group 1 --user myuser"
+            "description": "From a user from a user group",
+            "command": "c8y userreferences deleteUserFromGroup --group 1 --user myuser"
+          },
+          {
+            "description": "From a user from a user group (using pipeline)",
+            "command": "c8y users get --id myuser | c8y userreferences deleteUserFromGroup --group 1"
           }
         ]
       },
@@ -165,7 +174,11 @@
         "go": [
           {
             "description": "List the users within a user group",
-            "command": "c8y userReferences listGroupMembership --group 1"
+            "command": "c8y userreferences listGroupMembership --group 1"
+          },
+          {
+            "description": "List users in user groups (via pipeline)",
+            "command": "c8y usergroups list | c8y userreferences listGroupMembership"
           }
         ]
       },

diff --git a/api/spec/yaml/userReferences.yml b/api/spec/yaml/userReferences.yml
@@ -2,7 +2,7 @@
 ---
 
 information:
-  name: userReferences
+  name: userreferences
   description: Cumulocity user references
   descriptionLong: 'REST endpoint to interact with Cumulocity user references'
   link: https://cumulocity.com/guides/reference/users/#user-reference-collection
@@ -27,8 +27,11 @@ endpoints:
           afterEach:
             - Remove-User -Id $User.id
       go:
-        - description: List the users within a user group
-          command: c8y userReferences addUserToGroup --group 1 --user myuser
+        - description: Add a user to a user group
+          command: c8y userreferences addUserToGroup --group 1 --user myuser
+
+        - description: Add a list of users to business and admins group using pipeline
+          command: c8y users list | c8y userreferences addUserToGroup --group business | c8y userreferences addUserToGroup --group admins
     pathParameters:
       - name: group
         type: '[]usergroup'
@@ -48,6 +51,7 @@ endpoints:
         property: user.self
         description: User id
         pipelineAliases:
+          - user.id
           - id
           - self
 
@@ -63,7 +67,7 @@ endpoints:
         powershell: Remove-UserFromGroup
     examples:
       powershell:
-        - description: Add a user to a user group
+        - description: From a user from a user group
           beforeEach:
             - $User = New-TestUser
             - $Group = Get-UserGroupByName -Name "business"
@@ -72,8 +76,11 @@ endpoints:
           afterEach:
             - Remove-User -Id $User.id
       go:
-        - description: List the users within a user group
-          command: c8y userReferences deleteUserFromGroup --group 1 --user myuser
+        - description: From a user from a user group
+          command: c8y userreferences deleteUserFromGroup --group 1 --user myuser
+
+        - description: From a user from a user group (using pipeline)
+          command: c8y users get --id myuser | c8y userreferences deleteUserFromGroup --group 1
     pathParameters:
       - name: group
         type: '[]usergroup'
@@ -123,7 +130,10 @@ endpoints:
             - Remove-User -Id $User.id
       go:
         - description: List the users within a user group
-          command: c8y userReferences listGroupMembership --group 1
+          command: c8y userreferences listGroupMembership --group 1
+
+        - description: List users in user groups (via pipeline)
+          command: c8y usergroups list | c8y userreferences listGroupMembership
     pathParameters:
       - name: id
         type: '[]usergroup'

diff --git a/docs/go-c8y-cli/docs/cli/c8y/userreferences/c8y_userreferences_addUserToGroup.md b/docs/go-c8y-cli/docs/cli/c8y/userreferences/c8y_userreferences_addUserToGroup.md
@@ -15,8 +15,11 @@ c8y userreferences addUserToGroup [flags]
 ### Examples
 
 ```
-$ c8y userReferences addUserToGroup --group 1 --user myuser
-List the users within a user group
+$ c8y userreferences addUserToGroup --group 1 --user myuser
+Add a user to a user group
+
+$ c8y users list | c8y userreferences addUserToGroup --group business | c8y userreferences addUserToGroup --group admins
+Add a list of users to business and admins group using pipeline
         
 ```
 

diff --git a/...o-c8y-cli/docs/cli/c8y/userreferences/c8y_userreferences_deleteUserFromGroup.md b/...o-c8y-cli/docs/cli/c8y/userreferences/c8y_userreferences_deleteUserFromGroup.md
@@ -15,8 +15,11 @@ c8y userreferences deleteUserFromGroup [flags]
 ### Examples
 
 ```
-$ c8y userReferences deleteUserFromGroup --group 1 --user myuser
-List the users within a user group
+$ c8y userreferences deleteUserFromGroup --group 1 --user myuser
+From a user from a user group
+
+$ c8y users get --id myuser | c8y userreferences deleteUserFromGroup --group 1
+From a user from a user group (using pipeline)
         
 ```
 

diff --git a/...o-c8y-cli/docs/cli/c8y/userreferences/c8y_userreferences_listGroupMembership.md b/...o-c8y-cli/docs/cli/c8y/userreferences/c8y_userreferences_listGroupMembership.md
@@ -15,8 +15,11 @@ c8y userreferences listGroupMembership [flags]
 ### Examples
 
 ```
-$ c8y userReferences listGroupMembership --group 1
+$ c8y userreferences listGroupMembership --group 1
 List the users within a user group
+
+$ c8y usergroups list | c8y userreferences listGroupMembership
+List users in user groups (via pipeline)
         
 ```
 

diff --git a/docs/go-c8y-cli/docs/cli/psc8y/Users/Remove-UserFromGroup.md b/docs/go-c8y-cli/docs/cli/psc8y/Users/Remove-UserFromGroup.md
@@ -74,7 +74,7 @@ Delete an existing user from a user group
 Remove-UserFromGroup -Group $Group.id -User $User.id
 ```
 
-Add a user to a user group
+From a user from a user group
 
 ## PARAMETERS
 

diff --git a/pkg/cmd/userreferences/addusertogroup/addUserToGroup.auto.go b/pkg/cmd/userreferences/addusertogroup/addUserToGroup.auto.go
diff --git a/pkg/cmd/userreferences/deleteuserfromgroup/deleteUserFromGroup.auto.go b/pkg/cmd/userreferences/deleteuserfromgroup/deleteUserFromGroup.auto.go
diff --git a/pkg/cmd/userreferences/listgroupmembership/listGroupMembership.auto.go b/pkg/cmd/userreferences/listgroupmembership/listGroupMembership.auto.go
diff --git a/tools/PSc8y/Public/Remove-UserFromGroup.ps1 b/tools/PSc8y/Public/Remove-UserFromGroup.ps1
@@ -13,7 +13,7 @@ https://reubenmiller.github.io/go-c8y-cli/docs/cli/c8y/userreferences_deleteUser
 .EXAMPLE
 PS> Remove-UserFromGroup -Group $Group.id -User $User.id
 
-Add a user to a user group
+From a user from a user group
 
 
 #>

diff --git a/tools/PSc8y/Tests/Remove-UserFromGroup.auto.Tests.ps1 b/tools/PSc8y/Tests/Remove-UserFromGroup.auto.Tests.ps1
@@ -8,7 +8,7 @@ Describe -Name "Remove-UserFromGroup" {
 
     }
 
-    It "Add a user to a user group" {
+    It "From a user from a user group" {
         $Response = PSc8y\Remove-UserFromGroup -Group $Group.id -User $User.id
         $LASTEXITCODE | Should -Be 0
     }