Skip to content

Commit

Permalink
Merge pull request #305 from npamudika/3.1.x
Browse files Browse the repository at this point in the history
Add doc changes
  • Loading branch information
malinthaprasan authored May 12, 2020
2 parents d1094e5 + 9a45333 commit 00c2d35
Show file tree
Hide file tree
Showing 12 changed files with 27 additions and 31 deletions.
6 changes: 3 additions & 3 deletions import-export-cli/docs/apictl.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,16 +25,16 @@ apictl [flags]
* [apictl add-env](apictl_add-env.md) - Add Environment to Config file
* [apictl change](apictl_change.md) - Change a configuration
* [apictl change-status](apictl_change-status.md) - Change Status of an API
* [apictl delete](apictl_delete.md) - Delete an API/APIProduct/Application in an environment
* [apictl delete](apictl_delete.md) - Delete an API/Application in an environment
* [apictl export-api](apictl_export-api.md) - Export API
* [apictl export-apis](apictl_export-apis.md) - Export APIs for migration
* [apictl export-app](apictl_export-app.md) - Export App
* [apictl get-keys](apictl_get-keys.md) - Generate access token to invoke the API or API Product
* [apictl get-keys](apictl_get-keys.md) - Generate access token to invoke the API
* [apictl import-api](apictl_import-api.md) - Import API
* [apictl import-app](apictl_import-app.md) - Import App
* [apictl init](apictl_init.md) - Initialize a new project in given path
* [apictl install](apictl_install.md) - Install an operator
* [apictl list](apictl_list.md) - List APIs/APIProducts/Applications in an environment or List the environments
* [apictl list](apictl_list.md) - List APIs/Applications in an environment or List the environments
* [apictl login](apictl_login.md) - Login to an API Manager
* [apictl logout](apictl_logout.md) - Logout to from an API Manager
* [apictl remove](apictl_remove.md) - Remove an environmnet
Expand Down
6 changes: 2 additions & 4 deletions import-export-cli/docs/apictl_delete.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
## apictl delete

Delete an API/APIProduct/Application in an environment
Delete an API/Application in an environment

### Synopsis

Delete an API available in the environment specified by flag (--environment, -e) in default mode/
Delete an API Product available in the environment specified by flag (--environment, -e) in default mode/
Delete an Application of a specific user in the environment specified by flag (--environment, -e) in default mode/
Delete resources by filenames, stdin, resources and names, or by resources and label selector in kubernetes mode

Expand All @@ -16,8 +15,7 @@ apictl delete [flags]
### Examples

```
apictl delete api -n TwitterAPI -v 1.0.0 -r admin -e dev
apictl delete api-product -n TwitterAPI -r admin -e dev
apictl delete api -n TwitterAPI -v 1.0.0 -r admin -e dev
apictl delete app -n TestApplication -o admin -e dev
apictl delete api petstore
apictl delete api -l name=myLabel
Expand Down
2 changes: 1 addition & 1 deletion import-export-cli/docs/apictl_delete_api-product.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,5 +36,5 @@ NOTE: Both the flags (--name (-n) and --environment (-e)) are mandatory.

### SEE ALSO

* [apictl delete](apictl_delete.md) - Delete an API/APIProduct/Application in an environment
* [apictl delete](apictl_delete.md) - Delete an API/Application in an environment

2 changes: 1 addition & 1 deletion import-export-cli/docs/apictl_delete_api.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,5 +43,5 @@ Kubernetes Mode:

### SEE ALSO

* [apictl delete](apictl_delete.md) - Delete an API/APIProduct/Application in an environment
* [apictl delete](apictl_delete.md) - Delete an API/Application in an environment

2 changes: 1 addition & 1 deletion import-export-cli/docs/apictl_delete_app.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,5 +36,5 @@ NOTE: Both the flags (--name (-n), and --environment (-e)) are mandatory and the

### SEE ALSO

* [apictl delete](apictl_delete.md) - Delete an API/APIProduct/Application in an environment
* [apictl delete](apictl_delete.md) - Delete an API/Application in an environment

10 changes: 5 additions & 5 deletions import-export-cli/docs/apictl_get-keys.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
## apictl get-keys

Generate access token to invoke the API or API Product
Generate access token to invoke the API

### Synopsis

Generate JWT token to invoke the API or API Product by subscribing to a default application for testing purposes
Generate JWT token to invoke the API by subscribing to a default application for testing purposes

```
apictl get-keys [flags]
Expand All @@ -22,9 +22,9 @@ NOTE: Both the flags (--name (-n) and --environment (-e)) are mandatory
```
-e, --environment string Key generation environment
-h, --help help for get-keys
-n, --name string API or API Product to generate keys
-r, --provider string Provider of the API or API Product
-v, --version string Version of the API or API Product
-n, --name string API to generate keys
-r, --provider string Provider of the API
-v, --version string Version of the API
```

### Options inherited from parent commands
Expand Down
4 changes: 1 addition & 3 deletions import-export-cli/docs/apictl_list.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
## apictl list

List APIs/APIProducts/Applications in an environment or List the environments
List APIs/Applications in an environment or List the environments

### Synopsis

Display a list containing all the APIs available in the environment specified by flag (--environment, -e)/
Display a list containing all the API Products available in the environment specified by flag (--environment, -e)/
Display a list of Applications of a specific user in the environment specified by flag (--environment, -e)
OR
List all the environments
Expand All @@ -19,7 +18,6 @@ apictl list [flags]
```
apictl list envs
apictl list apis -e dev
apictl list api-products -e dev
apictl list apps -e dev
```

Expand Down
2 changes: 1 addition & 1 deletion import-export-cli/docs/apictl_list_api-products.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,5 +40,5 @@ NOTE: The flag (--environment (-e)) is mandatory

### SEE ALSO

* [apictl list](apictl_list.md) - List APIs/APIProducts/Applications in an environment or List the environments
* [apictl list](apictl_list.md) - List APIs/Applications in an environment or List the environments

2 changes: 1 addition & 1 deletion import-export-cli/docs/apictl_list_apis.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,5 +40,5 @@ NOTE: The flag (--environment (-e)) is mandatory

### SEE ALSO

* [apictl list](apictl_list.md) - List APIs/APIProducts/Applications in an environment or List the environments
* [apictl list](apictl_list.md) - List APIs/Applications in an environment or List the environments

2 changes: 1 addition & 1 deletion import-export-cli/docs/apictl_list_apps.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,5 +40,5 @@ NOTE: The flag (--environment (-e)) is mandatory

### SEE ALSO

* [apictl list](apictl_list.md) - List APIs/APIProducts/Applications in an environment or List the environments
* [apictl list](apictl_list.md) - List APIs/Applications in an environment or List the environments

2 changes: 1 addition & 1 deletion import-export-cli/docs/apictl_list_envs.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,5 +32,5 @@ apictl list envs

### SEE ALSO

* [apictl list](apictl_list.md) - List APIs/APIProducts/Applications in an environment or List the environments
* [apictl list](apictl_list.md) - List APIs/Applications in an environment or List the environments

18 changes: 9 additions & 9 deletions import-export-cli/shell-completions/apictl_zsh_completions.sh
Original file line number Diff line number Diff line change
Expand Up @@ -17,33 +17,33 @@ case $state in
;;
level2)
case $words[2] in
update)
_arguments '2: :(api help)'
;;
change-status)
_arguments '2: :(api help)'
;;
delete)
_arguments '2: :(api api-product app help)'
;;
install)
_arguments '2: :(api-operator help wso2am-operator)'
;;
list)
_arguments '2: :(api-products apis apps envs help)'
;;
add)
_arguments '2: :(api help)'
;;
change)
_arguments '2: :(help registry)'
;;
delete)
_arguments '2: :(api api-product app help)'
;;
list)
_arguments '2: :(api-products apis apps envs help)'
;;
remove)
_arguments '2: :(env help)'
;;
uninstall)
_arguments '2: :(api-operator help wso2am-operator)'
;;
update)
_arguments '2: :(api help)'
;;
*)
_arguments '*: :_files'
;;
Expand Down

0 comments on commit 00c2d35

Please sign in to comment.