NOISSUE - Add Change User Status Documentation #128
Conversation
Signed-off-by: 0x6f736f646f <blackd0t@protonmail.com>
Signed-off-by: 0x6f736f646f <blackd0t@protonmail.com>
docs/cli.md
Outdated
| -n, --name string Name query parameter | ||
| -o, --offset uint Offset query parameter | ||
| -r, --raw Enables raw output mode for easier parsing of output | ||
| -S, --status string Status query parameter |
There was a problem hiding this comment.
Should we clarify that it's only for users?
There was a problem hiding this comment.
I don't think so. It is the same thing with --email. I am suggesting we change the description for cli i.e
-e, --email string Email query parameter becomes -e, --email string User email query parameter and -S, --status string Status query parameter becomes -S, --status string User status query parameter
There was a problem hiding this comment.
OK, let's proceed this way. In this particular case, use lowercase user email query parameter and user status query parameter.
There was a problem hiding this comment.
@0x6f736f646f My bad, please capitalize. I thought string User email query parameter this is the message, not User email query parameter.
Signed-off-by: 0x6f736f646f <blackd0t@protonmail.com>
Signed-off-by: 0x6f736f646f <blackd0t@protonmail.com>
docs/cli.md
Outdated
| @@ -172,7 +234,7 @@ mainflux-cli provision channels <file> <user_token> | |||
|
|
|||
| #### Update Channel | |||
| ```bash | |||
| mainflux-cli channels update '{"id":"<channel_id>","name":"myNewName"}' <user_token> | |||
| mainflux-cli channels updatev '{"id":"<channel_id>","name":"myNewName"}' <user_token> | |||
There was a problem hiding this comment.
It is actually not a typo. But I will fix it
There was a problem hiding this comment.
Fixed it in mainflux core repo by this PR https://github.com/mainflux/mainflux/pull/1649
docs/api.md
Outdated
| Access-Control-Allow-Origin: * | ||
| Access-Control-Allow-Methods: * | ||
| Access-Control-Allow-Headers: * | ||
|
|
docs/cli.md
Outdated
| delete Delete channel | ||
| get Get channel | ||
| not-connected Not-connected list | ||
| update Update channel |
docs/cli.md
Outdated
| -t, --things-url string Things service URL (default "http://localhost") | ||
| -u, --users-url string Users service URL (default "http://localhost") | ||
|
|
||
| Use "mainflux-cli channels [command] --help" for more information about a command. | ||
|
|
Signed-off-by: 0x6f736f646f <blackd0t@protonmail.com>
docs/cli.md
Outdated
| mainflux-cli users get <user_id> <user_token> | ||
| ``` | ||
|
|
||
| #### Retrieve All User |
There was a problem hiding this comment.
Fix Retrieve All Users and probably better Retrieve Users or Get Users. BTW, this is not consistent with Get Channels and Get Things
There was a problem hiding this comment.
I will resort to using Get xxx as it has been implemented for api at #125
Signed-off-by: 0x6f736f646f <blackd0t@protonmail.com>
What does this do?
Add change user status to enabled and disabled for both
cliandapidocumentationsWhich issue(s) does this PR fix/relate to?
None
List any changes that modify/break current functionality
None
Have you included tests for your changes?
No
Did you document any new/modified functionality?
Yes
Notes
N/A