Skip to content

Commit

Permalink
#21: updated README to reflect new set-auth and clear-auth commands
Browse files Browse the repository at this point in the history
  • Loading branch information
gdereese committed Feb 28, 2018
1 parent 2467530 commit 6377951
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -149,12 +149,13 @@ Each API operation command has the following options to configure additional asp

The following commands are added to the CLI by default:

| Command | Description |
| :---------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `about` | Displays information about the API. This command displays various bits from the `info` object of the spec to the user such as the `version`, `contact` and `termsOfService` properties. |
| `authorize` | Sets the value(s) required to fulfill a given authorization scheme accepted/required by the API. An `authorize` sub-command is created for each scheme defined in the spec's `securityDefinitions` object. You can type `help authorize` at the CLI prompt to list the schemes available to use. |
| `exit` | Exits the current CLI session and returns to the host command prompt. |
| `help` | Lists each command available in the CLI with a brief description of each. The usage pattern, including required and optional parameters, is also specified for each command. |
| Command | Description |
| :----------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `about` | Displays information about the API. This command displays various bits from the `info` object of the spec to the user such as the `version`, `contact` and `termsOfService` properties. |
| `clear-auth` | Clears the auth value(s) for the specified authorization scheme. |
| `set-auth` | Sets the value(s) required to fulfill a given authorization scheme accepted/required by the API. A `set-auth` sub-command is created for each scheme defined in the spec's `securityDefinitions` object. You can type `help set-auth` at the CLI prompt to list the schemes available to use. |
| `exit` | Exits the current CLI session and returns to the host command prompt. |
| `help` | Lists each command available in the CLI with a brief description of each. The usage pattern, including required and optional parameters, is also specified for each command. |

## Options

Expand Down

0 comments on commit 6377951

Please sign in to comment.