CLI doc edits

This commit is contained in:
james.haytko
2023-11-06 12:26:21 -06:00
parent faf5d00d4d
commit cca1ed9066
52 changed files with 207 additions and 135 deletions

View File

@@ -24,7 +24,7 @@ func newCreateCommand() *cobra.Command {
var directory bool
cmd := &cobra.Command{
Use: "create [-f file1 file2 ... | -d workflowDirectory ]",
Short: "Create Workflows in IdentityNow",
Short: "Create workflows in IdentityNow",
Long: help.Long,
Example: help.Example,
Aliases: []string{"cr"},
@@ -112,8 +112,8 @@ func newCreateCommand() *cobra.Command {
},
}
cmd.Flags().BoolVarP(&file, "file", "f", false, "specifies that workflow file paths are provided as arguments to be created")
cmd.Flags().BoolVarP(&directory, "directory", "d", false, "specifies that a directory of workflows is provided to be created")
cmd.Flags().BoolVarP(&file, "file", "f", false, "Specifies that workflow file paths are provided as arguments to be created")
cmd.Flags().BoolVarP(&directory, "directory", "d", false, "Specifies that a directory of workflows is provided to be created")
cmd.MarkFlagsMutuallyExclusive("file", "directory")
return cmd

View File

@@ -1,6 +1,6 @@
==Long==
# Create
Create Workflows in IdentityNow
Create workflows in IdentityNow
## API References:
- https://developer.sailpoint.com/idn/api/beta/create-workflow
@@ -9,7 +9,7 @@ Create Workflows in IdentityNow
==Example==
## File Paths:
**Note:** File paths are relative to the current working directory, and only one workflow is allowed per file path. Multiple Workflows can be provided by specifying multiple file paths as arguments.
**Note:** File paths are relative to the current working directory, and only one workflow is allowed per file path. Multiple workflows can be provided by specifying multiple file paths as arguments.
```bash
sail workflow create -f {file-path}

View File

@@ -19,7 +19,7 @@ func newDeleteCommand() *cobra.Command {
help := util.ParseHelp(deleteHelp)
cmd := &cobra.Command{
Use: "delete workflowID... ",
Short: "Delete a Workflow in IdentityNow",
Short: "Delete a workflow in IdentityNow",
Long: help.Long,
Example: help.Example,
Aliases: []string{"del"},

View File

@@ -1,6 +1,6 @@
==Long==
# Delete
Delete a workflow in IdentityNow
Delete a workflow in IdentityNow.
## API References:
- https://developer.sailpoint.com/idn/api/beta/delete-workflow

View File

@@ -22,7 +22,7 @@ func newDownloadCommand() *cobra.Command {
var folderPath string
cmd := &cobra.Command{
Use: "download",
Short: "Download Workflows from IdentityNow",
Short: "Download workflows from IdentityNow",
Long: help.Long,
Example: help.Example,
Aliases: []string{"down"},

View File

@@ -1,6 +1,6 @@
==Long==
# Download
Downloads all Workflows from IdentityNow
Downloads all workflows from IdentityNow.
## API References:
- https://developer.sailpoint.com/idn/api/beta/list-workflows

View File

@@ -20,7 +20,7 @@ func newGetCommand() *cobra.Command {
help := util.ParseHelp(getHelp)
cmd := &cobra.Command{
Use: "get",
Short: "Get Workflows in IdentityNow",
Short: "Get workflows in IdentityNow",
Long: help.Long,
Example: help.Example,
Aliases: []string{"g"},

View File

@@ -19,7 +19,7 @@ func newListCommand() *cobra.Command {
help := util.ParseHelp(listHelp)
cmd := &cobra.Command{
Use: "list",
Short: "List all Workflows in IdentityNow",
Short: "List all workflows in IdentityNow",
Long: help.Long,
Example: help.Example,
Aliases: []string{"ls"},

View File

@@ -23,7 +23,7 @@ func newUpdateCommand() *cobra.Command {
var directory bool
cmd := &cobra.Command{
Use: "update",
Short: "Update a Workflow in IdentityNow",
Short: "Update a workflow in IdentityNow",
Long: help.Long,
Example: help.Example,
Aliases: []string{"up"},

View File

@@ -1,7 +1,7 @@
==Long==
# Update
Update a Workflow in IdentityNow
Update a workflow in IdentityNow.
Arguments can be a list of directories or files.
If a directory is specified, all JSON files in the directory will be parsed and the workflows uploaded.

View File

@@ -15,7 +15,7 @@ func NewWorkflowCommand() *cobra.Command {
help := util.ParseHelp(workflowHelp)
cmd := &cobra.Command{
Use: "workflow",
Short: "Manage Workflows in IdentityNow",
Short: "Manage workflows in IdentityNow",
Long: help.Long,
Example: help.Example,
Aliases: []string{"work"},

View File

@@ -2,7 +2,7 @@
# Workflows
Manage Workflows in IdentityNow
Manage workflows in IdentityNow.
====