docs: prepare for release

reubenmiller · Mar 5, 2023 · a1032b6 · a1032b6
1 parent 574e828
commit a1032b6
Show file tree

Hide file tree

Showing 14 changed files with 42 additions and 33 deletions.
diff --git a/docs/go-c8y-cli/docs/cli/c8y/api/c8y_api.md b/docs/go-c8y-cli/docs/cli/c8y/api/c8y_api.md
@@ -18,9 +18,12 @@ c8y api [flags]
 $ c8y api GET /alarm/alarms
 Get a list of alarms
 
-$ c8y api GET "/alarm/alarms?pageSize=10&status=ACTIVE"
+$ c8y api GET "/alarm/alarms&status=ACTIVE" --pageSize 10
 Get a list of alarms with custom query parameters
 
+$ c8y api GET "/alarm/alarms&status=ACTIVE" --pageSize 1 --withTotalPages
+Get a total ACTIVE alarms
+
 $ c8y api POST "alarm/alarms" --data "text=one,severity=MAJOR,type=test_Type,time=2019-01-01,source.id='12345'" --keepProperties
 Create a new alarm
 

diff --git a/docs/go-c8y-cli/docs/cli/c8y/identity/c8y_identity.md b/docs/go-c8y-cli/docs/cli/c8y/identity/c8y_identity.md
@@ -2,11 +2,11 @@
 category: identity
 title: c8y identity
 ---
-Cumulocity identity
+Cumulocity external identity
 
 ### Synopsis
 
-REST endpoint to interact with Cumulocity identity objects
+REST endpoint to interact with Cumulocity external identity objects
 
 ### Options
 

diff --git a/docs/go-c8y-cli/docs/cli/c8y/identity/c8y_identity_create.md b/docs/go-c8y-cli/docs/cli/c8y/identity/c8y_identity_create.md
@@ -2,7 +2,7 @@
 category: identity
 title: c8y identity create
 ---
-Create external id
+Create external identity
 
 ### Synopsis
 

diff --git a/docs/go-c8y-cli/docs/cli/c8y/identity/c8y_identity_delete.md b/docs/go-c8y-cli/docs/cli/c8y/identity/c8y_identity_delete.md
@@ -2,7 +2,7 @@
 category: identity
 title: c8y identity delete
 ---
-Delete external id
+Delete external identity
 
 ### Synopsis
 

diff --git a/docs/go-c8y-cli/docs/cli/c8y/identity/c8y_identity_get.md b/docs/go-c8y-cli/docs/cli/c8y/identity/c8y_identity_get.md
@@ -2,7 +2,7 @@
 category: identity
 title: c8y identity get
 ---
-Get external id
+Get external identity
 
 ### Synopsis
 

diff --git a/docs/go-c8y-cli/docs/cli/c8y/identity/c8y_identity_list.md b/docs/go-c8y-cli/docs/cli/c8y/identity/c8y_identity_list.md
@@ -2,7 +2,7 @@
 category: identity
 title: c8y identity list
 ---
-Get external id collection
+Get external identity collection
 
 ### Synopsis
 

diff --git a/docs/go-c8y-cli/docs/cli/c8y/tenantoptions/c8y_tenantoptions_create.md b/docs/go-c8y-cli/docs/cli/c8y/tenantoptions/c8y_tenantoptions_create.md
@@ -19,11 +19,14 @@ Create a tenant option
 ### Options
 
 ```
-      --category string         Category of option (required)
-  -h, --help                    help for create
-      --key string              Key of option (required) (accepts pipeline)
-      --processingMode string   Cumulocity processing mode
-      --value string            Value of option (required)
+      --category string            Category of option
+  -d, --data stringArray           static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100'
+  -h, --help                       help for create
+      --key string                 Key of option (accepts pipeline)
+      --processingMode string      Cumulocity processing mode
+      --template string            Body template
+      --templateVars stringArray   Body template variables
+      --value string               Value of option
 ```
 
 ### Options inherited from parent commands

diff --git a/docs/go-c8y-cli/docs/cli/c8y/tenantoptions/c8y_tenantoptions_update.md b/docs/go-c8y-cli/docs/cli/c8y/tenantoptions/c8y_tenantoptions_update.md
@@ -23,11 +23,14 @@ Update a tenant option
 ### Options
 
 ```
-      --category string         Tenant Option category (required)
-  -h, --help                    help for update
-      --key string              Tenant Option key (required) (accepts pipeline)
-      --processingMode string   Cumulocity processing mode
-      --value string            New value (required)
+      --category string            Tenant Option category (required)
+  -d, --data stringArray           static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100'
+  -h, --help                       help for update
+      --key string                 Tenant Option key (required) (accepts pipeline)
+      --processingMode string      Cumulocity processing mode
+      --template string            Body template
+      --templateVars stringArray   Body template variables
+      --value string               New value
 ```
 
 ### Options inherited from parent commands

diff --git a/docs/go-c8y-cli/docs/cli/psc8y/ExternalIdentity/Get-ExternalId.md b/docs/go-c8y-cli/docs/cli/psc8y/ExternalIdentity/Get-ExternalId.md
@@ -12,7 +12,7 @@ title: Get-ExternalId
 
 
 ## SYNOPSIS
-Get external id
+Get external identity
 
 ## SYNTAX
 

diff --git a/docs/go-c8y-cli/docs/cli/psc8y/ExternalIdentity/Get-ExternalIdCollection.md b/docs/go-c8y-cli/docs/cli/psc8y/ExternalIdentity/Get-ExternalIdCollection.md
@@ -12,7 +12,7 @@ title: Get-ExternalIdCollection
 
 
 ## SYNOPSIS
-Get external id collection
+Get external identity collection
 
 ## SYNTAX
 

diff --git a/docs/go-c8y-cli/docs/cli/psc8y/ExternalIdentity/New-ExternalId.md b/docs/go-c8y-cli/docs/cli/psc8y/ExternalIdentity/New-ExternalId.md
@@ -12,7 +12,7 @@ title: New-ExternalId
 
 
 ## SYNOPSIS
-Create external id
+Create external identity
 
 ## SYNTAX
 

diff --git a/docs/go-c8y-cli/docs/cli/psc8y/ExternalIdentity/Remove-ExternalId.md b/docs/go-c8y-cli/docs/cli/psc8y/ExternalIdentity/Remove-ExternalId.md
@@ -12,7 +12,7 @@ title: Remove-ExternalId
 
 
 ## SYNOPSIS
-Delete external id
+Delete external identity
 
 ## SYNTAX
 

diff --git a/docs/go-c8y-cli/docs/cli/psc8y/TenantOption/New-TenantOption.md b/docs/go-c8y-cli/docs/cli/psc8y/TenantOption/New-TenantOption.md
@@ -18,9 +18,9 @@ Create tenant option
 
 ```
 New-TenantOption
-	[-Category] <String>
-	[-Key] <Object[]>
-	[-Value] <String>
+	[[-Category] <String>]
+	[[-Key] <Object[]>]
+	[[-Value] <String>]
 	[-Data <Object>]
 	[-NoAccept]
 	[-ProcessingMode <String>]
@@ -87,44 +87,44 @@ Create a tenant option
 ## PARAMETERS
 
 ### -Category
-Category of option (required)
+Category of option
 
 ```yaml
 Type: String
 Parameter Sets: (All)
 Aliases:
 
-Required: True
+Required: False
 Position: 1
 Default value: None
 Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
 ### -Key
-Key of option (required)
+Key of option
 
 ```yaml
 Type: Object[]
 Parameter Sets: (All)
 Aliases:
 
-Required: True
+Required: False
 Position: 2
 Default value: None
 Accept pipeline input: True (ByPropertyName, ByValue)
 Accept wildcard characters: False
 ```
 
 ### -Value
-Value of option (required)
+Value of option
 
 ```yaml
 Type: String
 Parameter Sets: (All)
 Aliases:
 
-Required: True
+Required: False
 Position: 3
 Default value: None
 Accept pipeline input: False

diff --git a/docs/go-c8y-cli/docs/cli/psc8y/TenantOption/Update-TenantOption.md b/docs/go-c8y-cli/docs/cli/psc8y/TenantOption/Update-TenantOption.md
@@ -20,7 +20,7 @@ Update tenant option
 Update-TenantOption
 	[-Category] <String>
 	[-Key] <Object[]>
-	[-Value] <String>
+	[[-Value] <String>]
 	[-Data <Object>]
 	[-NoAccept]
 	[-ProcessingMode <String>]
@@ -117,14 +117,14 @@ Accept wildcard characters: False
 ```
 
 ### -Value
-New value (required)
+New value
 
 ```yaml
 Type: String
 Parameter Sets: (All)
 Aliases:
 
-Required: True
+Required: False
 Position: 3
 Default value: None
 Accept pipeline input: False