Skip to content

Commit

Permalink
update docs for release
Browse files Browse the repository at this point in the history
  • Loading branch information
reubenmiller committed Oct 20, 2022
1 parent 8d41db7 commit 928792e
Show file tree
Hide file tree
Showing 62 changed files with 2,189 additions and 55 deletions.
9 changes: 7 additions & 2 deletions docs/go-c8y-cli/docs/cli/c8y/agents/c8y_agents_get.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,13 @@ Get agent by id
### Options

```
-h, --help help for get
--id strings Agent ID (required) (accepts pipeline)
-h, --help help for get
--id strings Agent ID (required) (accepts pipeline)
--skipChildrenNames Don't include the child devices names in the response. This can improve the API response because the names don't need to be retrieved
--withChildren Determines if children with ID and name should be returned when fetching the managed object. Set it to false to improve query performance.
--withChildrenCount When set to true, the returned result will contain the total number of children in the respective objects (childAdditions, childAssets and childDevices)
--withGroups When set to true it returns additional information about the groups to which the searched managed object belongs. This results in setting the assetParents property with additional information about the groups.
--withParents Include a flat list of all parents and grandparents of the given object
```

### Options inherited from parent commands
Expand Down
4 changes: 4 additions & 0 deletions docs/go-c8y-cli/docs/cli/c8y/agents/c8y_agents_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,11 @@ Find an agent by name, then find other agents which the same type
--owner string Filter by owner
--query string Additional query filter (accepts pipeline)
--queryTemplate string String template to be used when applying the given query. Use %s to reference the query/pipeline input
--skipChildrenNames Don't include the child devices names in the response. This can improve the API response because the names don't need to be retrieved
--type string Filter by type
--withChildren Determines if children with ID and name should be returned when fetching the managed object. Set it to false to improve query performance.
--withChildrenCount When set to true, the returned result will contain the total number of children in the respective objects (childAdditions, childAssets and childDevices)
--withGroups When set to true it returns additional information about the groups to which the searched managed object belongs. This results in setting the assetParents property with additional information about the groups.
--withParents Include a flat list of all parents and grandparents of the given object
```

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,13 @@ Get a configuration package
### Options

```
-h, --help help for get
--id strings Configuration package (managedObject) id (required) (accepts pipeline)
-h, --help help for get
--id strings Configuration package (managedObject) id (required) (accepts pipeline)
--skipChildrenNames Don't include the child devices names in the response. This can improve the API response because the names don't need to be retrieved
--withChildren Determines if children with ID and name should be returned when fetching the managed object. Set it to false to improve query performance.
--withChildrenCount When set to true, the returned result will contain the total number of children in the respective objects (childAdditions, childAssets and childDevices)
--withGroups When set to true it returns additional information about the groups to which the searched managed object belongs. This results in setting the assetParents property with additional information about the groups.
--withParents Include a flat list of all parents and grandparents of the given object
```

### Options inherited from parent commands
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,11 @@ Get a list of configuration files
--orderBy string Order by. e.g. _id asc or name asc or creationTime.date desc (default "name")
--query string Additional query filter (accepts pipeline)
--queryTemplate string String template to be used when applying the given query. Use %s to reference the query/pipeline input
--skipChildrenNames Don't include the child devices names in the response. This can improve the API response because the names don't need to be retrieved
--withChildren Determines if children with ID and name should be returned when fetching the managed object. Set it to false to improve query performance.
--withChildrenCount When set to true, the returned result will contain the total number of children in the respective objects (childAdditions, childAssets and childDevices)
--withGroups When set to true it returns additional information about the groups to which the searched managed object belongs. This results in setting the assetParents property with additional information about the groups.
--withParents Include a flat list of all parents and grandparents of the given object
```

### Options inherited from parent commands
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,13 @@ Get device group by id
### Options

```
-h, --help help for get
--id strings Device group ID (required) (accepts pipeline)
-h, --help help for get
--id strings Device group ID (required) (accepts pipeline)
--skipChildrenNames Don't include the child devices names in the response. This can improve the API response because the names don't need to be retrieved
--withChildren Determines if children with ID and name should be returned when fetching the managed object. Set it to false to improve query performance.
--withChildrenCount When set to true, the returned result will contain the total number of children in the respective objects (childAdditions, childAssets and childDevices)
--withGroups When set to true it returns additional information about the groups to which the searched managed object belongs. This results in setting the assetParents property with additional information about the groups.
--withParents Include a flat list of all parents and grandparents of the given object
```

### Options inherited from parent commands
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,11 @@ Get a collection of device groups with names that start with 'parent'
--owner string Filter by owner
--query string Additional query filter (accepts pipeline)
--queryTemplate string String template to be used when applying the given query. Use %s to reference the query/pipeline input
--skipChildrenNames Don't include the child devices names in the response. This can improve the API response because the names don't need to be retrieved
--type string Filter by type
--withChildren Include names of child assets (only use where necessary as it is slow for large groups)
--withChildrenCount When set to true, the returned result will contain the total number of children in the respective objects (childAdditions, childAssets and childDevices)
--withGroups When set to true it returns additional information about the groups to which the searched managed object belongs. This results in setting the assetParents property with additional information about the groups.
--withParents Include a flat list of all parents and grandparents of the given object
```

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ Get a list of the child devices of an existing managed object
--query string Additional query filter
--queryTemplate string String template to be used when applying the given query. Use %s to reference the query/pipeline input
--withChildren Determines if children with ID and name should be returned when fetching the managed object. Set it to false to improve query performance.
--withChildrenCount When set to true, the returned result will contain the total number of children in the respective objects (childAdditions, childAssets and childDevices)
```

### Options inherited from parent commands
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,13 @@ Get a device profile
### Options

```
-h, --help help for get
--id strings DeviceProfile (managedObject) id (required) (accepts pipeline)
-h, --help help for get
--id strings DeviceProfile (managedObject) id (required) (accepts pipeline)
--skipChildrenNames Don't include the child devices names in the response. This can improve the API response because the names don't need to be retrieved
--withChildren Determines if children with ID and name should be returned when fetching the managed object. Set it to false to improve query performance.
--withChildrenCount When set to true, the returned result will contain the total number of children in the respective objects (childAdditions, childAssets and childDevices)
--withGroups When set to true it returns additional information about the groups to which the searched managed object belongs. This results in setting the assetParents property with additional information about the groups.
--withParents Include a flat list of all parents and grandparents of the given object
```

### Options inherited from parent commands
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,11 @@ Get a list of device profiles
--orderBy string Order by. e.g. _id asc or name asc or creationTime.date desc (default "creationTime.date desc,creationTime desc")
--query string Additional query filter
--queryTemplate string String template to be used when applying the given query. Use %s to reference the query/pipeline input
--skipChildrenNames Don't include the child devices names in the response. This can improve the API response because the names don't need to be retrieved
--withChildren Determines if children with ID and name should be returned when fetching the managed object. Set it to false to improve query performance.
--withChildrenCount When set to true, the returned result will contain the total number of children in the respective objects (childAdditions, childAssets and childDevices)
--withGroups When set to true it returns additional information about the groups to which the searched managed object belongs. This results in setting the assetParents property with additional information about the groups.
--withParents Include a flat list of all parents and grandparents of the given object
```

### Options inherited from parent commands
Expand Down
9 changes: 7 additions & 2 deletions docs/go-c8y-cli/docs/cli/c8y/devices/c8y_devices_get.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,13 @@ Get device by id
### Options

```
-h, --help help for get
--id strings Device ID (required) (accepts pipeline)
-h, --help help for get
--id strings Device ID (required) (accepts pipeline)
--skipChildrenNames Don't include the child devices names in the response. This can improve the API response because the names don't need to be retrieved
--withChildren Determines if children with ID and name should be returned when fetching the managed object. Set it to false to improve query performance.
--withChildrenCount When set to true, the returned result will contain the total number of children in the respective objects (childAdditions, childAssets and childDevices)
--withGroups When set to true it returns additional information about the groups to which the searched managed object belongs. This results in setting the assetParents property with additional information about the groups.
--withParents Include a flat list of all parents and grandparents of the given object
```

### Options inherited from parent commands
Expand Down
4 changes: 4 additions & 0 deletions docs/go-c8y-cli/docs/cli/c8y/devices/c8y_devices_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,11 @@ Get devices with type 'c8y_MacOS' then devices with type 'c8y_Linux' (using pipe
--owner string Filter by owner
--query string Additional query filter (accepts pipeline)
--queryTemplate string String template to be used when applying the given query. Use %s to reference the query/pipeline input
--skipChildrenNames Don't include the child devices names in the response. This can improve the API response because the names don't need to be retrieved
--type string Filter by type
--withChildren Determines if children with ID and name should be returned when fetching the managed object. Set it to false to improve query performance.
--withChildrenCount When set to true, the returned result will contain the total number of children in the respective objects (childAdditions, childAssets and childDevices)
--withGroups When set to true it returns additional information about the groups to which the searched managed object belongs. This results in setting the assetParents property with additional information about the groups.
--withParents Include a flat list of all parents and grandparents of the given object
```

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ Get a list of the child devices of an existing managed object
--query string Additional query filter
--queryTemplate string String template to be used when applying the given query. Use %s to reference the query/pipeline input
--withChildren Determines if children with ID and name should be returned when fetching the managed object. Set it to false to improve query performance.
--withChildrenCount When set to true, the returned result will contain the total number of children in the respective objects (childAdditions, childAssets and childDevices)
```

### Options inherited from parent commands
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,11 @@ Find any ntp services which are currently down
--orderBy string Order by. e.g. _id asc or name asc or creationTime.date desc
--query string Additional query filter
--serviceType string Filter by service type e.g. systemd
--skipChildrenNames Don't include the child devices names in the response. This can improve the API response because the names don't need to be retrieved
--status string Filter by service status (custom values allowed)
--withChildren Determines if children with ID and name should be returned when fetching the managed object. Set it to false to improve query performance.
--withChildrenCount When set to true, the returned result will contain the total number of children in the respective objects (childAdditions, childAssets and childDevices)
--withGroups When set to true it returns additional information about the groups to which the searched managed object belongs. This results in setting the assetParents property with additional information about the groups.
--withParents Include a flat list of all parents and grandparents of the given object
```

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,14 @@ Get service status (using pipeline)
### Options

```
--device strings Device id (required for name lookup)
-h, --help help for get
--id strings Service id or name (required) (accepts pipeline)
--device strings Device id (required for name lookup)
-h, --help help for get
--id strings Service id or name (required) (accepts pipeline)
--skipChildrenNames Don't include the child devices names in the response. This can improve the API response because the names don't need to be retrieved
--withChildren Determines if children with ID and name should be returned when fetching the managed object. Set it to false to improve query performance.
--withChildrenCount When set to true, the returned result will contain the total number of children in the respective objects (childAdditions, childAssets and childDevices)
--withGroups When set to true it returns additional information about the groups to which the searched managed object belongs. This results in setting the assetParents property with additional information about the groups.
--withParents Include a flat list of all parents and grandparents of the given object
```

### Options inherited from parent commands
Expand Down
9 changes: 7 additions & 2 deletions docs/go-c8y-cli/docs/cli/c8y/firmware/c8y_firmware_get.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,13 @@ Get a firmware package (using pipeline)
### Options

```
-h, --help help for get
--id strings Firmware package (managedObject) id (required) (accepts pipeline)
-h, --help help for get
--id strings Firmware package (managedObject) id (required) (accepts pipeline)
--skipChildrenNames Don't include the child devices names in the response. This can improve the API response because the names don't need to be retrieved
--withChildren Determines if children with ID and name should be returned when fetching the managed object. Set it to false to improve query performance.
--withChildrenCount When set to true, the returned result will contain the total number of children in the respective objects (childAdditions, childAssets and childDevices)
--withGroups When set to true it returns additional information about the groups to which the searched managed object belongs. This results in setting the assetParents property with additional information about the groups.
--withParents Include a flat list of all parents and grandparents of the given object
```

### Options inherited from parent commands
Expand Down
5 changes: 5 additions & 0 deletions docs/go-c8y-cli/docs/cli/c8y/firmware/c8y_firmware_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,11 @@ Get a list of firmware packages
--orderBy string Order by. e.g. _id asc or name asc or creationTime.date desc (default "name")
--query string Additional query filter (accepts pipeline)
--queryTemplate string String template to be used when applying the given query. Use %s to reference the query/pipeline input
--skipChildrenNames Don't include the child devices names in the response. This can improve the API response because the names don't need to be retrieved
--withChildren Determines if children with ID and name should be returned when fetching the managed object. Set it to false to improve query performance.
--withChildrenCount When set to true, the returned result will contain the total number of children in the respective objects (childAdditions, childAssets and childDevices)
--withGroups When set to true it returns additional information about the groups to which the searched managed object belongs. This results in setting the assetParents property with additional information about the groups.
--withParents Include a flat list of all parents and grandparents of the given object
```

### Options inherited from parent commands
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,14 @@ Get a firmware patch
### Options

```
--firmware strings Firmware package id or name (used to help completion be more accurate)
-h, --help help for get
--id strings Firmware patch id or name (required) (accepts pipeline)
--withParents Include parent references (default true)
--firmware strings Firmware package id or name (used to help completion be more accurate)
-h, --help help for get
--id strings Firmware patch id or name (required) (accepts pipeline)
--skipChildrenNames Don't include the child devices names in the response. This can improve the API response because the names don't need to be retrieved
--withChildren Determines if children with ID and name should be returned when fetching the managed object. Set it to false to improve query performance.
--withChildrenCount When set to true, the returned result will contain the total number of children in the respective objects (childAdditions, childAssets and childDevices)
--withGroups When set to true it returns additional information about the groups to which the searched managed object belongs. This results in setting the assetParents property with additional information about the groups.
--withParents Include a flat list of all parents and grandparents of the given object (default true)
```

### Options inherited from parent commands
Expand Down
Loading

0 comments on commit 928792e

Please sign in to comment.