fix: api doc

Author: mabdh

Makefile

@@ -52,6 +52,10 @@ proto: ## Generate the protobuf files
 help:
 	@grep -E '^[a-zA-Z0-9_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
 
+clean-doc:
+	@echo "> cleaning up auto-generated docs"
+	@rm -rf ./docs/docs/reference/cli.md
+
 doc: clean-doc ## Generate api and cli documentation
 	@echo "> generate cli docs"
 	@go run . reference --plain | sed '1 s,.*,# CLI,' > ./docs/docs/reference/cli.md

docs/docs/reference/cli.md

@@ -1,10 +1,10 @@
 # CLI
 
-##  shield action 
+## `shield action`
 
 Manage actions
 
-###  shield action create [flags] 
+### `shield action create [flags]`
 
 Create an action
 
@@ -13,51 +13,39 @@ Create an action
 -H, --header string   Header <key>:<value>
 ````
 
-###  shield action edit [flags] 
-
-Edit an action
-
-```
--f, --file string   Path to the action body file
-````
-
-###  shield action list 
+### `shield action list`
 
 List all actions
 
-###  shield action view 
-
-View an action
-
-##  shield auth 
+## `shield auth`
 
 Auth configs that need to be used with shield
 
-##  shield completion [bash|zsh|fish|powershell] 
+## `shield completion [bash|zsh|fish|powershell]`
 
 Generate shell completion scripts
 
-##  shield config
+## `shield config <command>`
 
 Manage client configurations
 
-###  shield config init 
+### `shield config init`
 
 Initialize a new client configuration
 
-###  shield config list 
+### `shield config list`
 
 List client configuration settings
 
-##  shield environment 
+## `shield environment`
 
 List of supported environment variables
 
-##  shield group 
+## `shield group`
 
 Manage groups
 
-###  shield group create [flags] 
+### `shield group create [flags]`
 
 Create a group
 
@@ -66,79 +54,63 @@ Create a group
 -H, --header string   Header <key>:<value>
 ````
 
-###  shield group edit [flags] 
+### `shield group edit [flags]`
 
 Edit a group
 
 ```
 -f, --file string   Path to the group body file
 ````
 
-###  shield group list 
+### `shield group list`
 
 List all groups
 
-###  shield group view [flags] 
+### `shield group view [flags]`
 
 View a group
 
 ```
 -m, --metadata   Set this flag to see metadata
 ````
 
-##  shield namespace 
+## `shield namespace`
 
 Manage namespaces
 
-###  shield namespace create [flags] 
+### `shield namespace create [flags]`
 
 Create a namespace
 
 ```
 -f, --file string   Path to the namespace body file
 ````
 
-###  shield namespace edit [flags] 
+### `shield namespace edit [flags]`
 
 Edit a namespace
 
 ```
 -f, --file string   Path to the namespace body file
 ````
 
-###  shield namespace list 
+### `shield namespace list`
 
 List all namespaces
 
-###  shield namespace view 
+### `shield namespace view`
 
 View a namespace
 
-##  shield organization 
+## `shield organization`
 
 Manage organizations
 
-###  shield organization admadd [flags] 
-
-add admins to an organization
-
-```
--f, --file string   Path to the provider config
-````
-
-###  shield organization admlist 
+### `shield organization admlist`
 
 list admins of an organization
 
-###  shield organization admremove [flags] 
-
-remove admins from an organization
-
-```
--u, --user string   Id of the user to be removed
-````
-
-###  shield organization create [flags] 
+### `shield organization create [flags]`
 
 Create an organization
 
@@ -147,31 +119,31 @@ Create an organization
 -H, --header string   Header <key>:<value>
 ````
 
-###  shield organization edit [flags] 
+### `shield organization edit [flags]`
 
 Edit an organization
 
 ```
 -f, --file string   Path to the organization body file
 ````
 
-###  shield organization list 
+### `shield organization list`
 
 List all organizations
 
-###  shield organization view [flags] 
+### `shield organization view [flags]`
 
 View an organization
 
 ```
 -m, --metadata   Set this flag to see metadata
 ````
 
-##  shield policy 
+## `shield policy`
 
 Manage policies
 
-###  shield policy create [flags] 
+### `shield policy create [flags]`
 
 Create a policy
 
@@ -180,27 +152,15 @@ Create a policy
 -H, --header string   Header <key>:<value>
 ````
 
-###  shield policy edit [flags] 
-
-Edit a policy
-
-```
--f, --file string   Path to the policy body file
-````
-
-###  shield policy list 
+### `shield policy list`
 
 List all policies
 
-###  shield policy view 
-
-View a policy
-
-##  shield project 
+## `shield project`
 
 Manage projects
 
-###  shield project create [flags] 
+### `shield project create [flags]`
 
 Create a project
 
@@ -209,31 +169,31 @@ Create a project
 -H, --header string   Header <key>:<value>
 ````
 
-###  shield project edit [flags] 
+### `shield project edit [flags]`
 
 Edit a project
 
 ```
 -f, --file string   Path to the project body file
 ````
 
-###  shield project list 
+### `shield project list`
 
 List all projects
 
-###  shield project view [flags] 
+### `shield project view [flags]`
 
 View a project
 
 ```
 -m, --metadata   Set this flag to see metadata
 ````
 
-##  shield role 
+## `shield role`
 
 Manage roles
 
-###  shield role create [flags] 
+### `shield role create [flags]`
 
 Create a role
 
@@ -242,31 +202,15 @@ Create a role
 -H, --header string   Header <key>:<value>
 ````
 
-###  shield role edit [flags] 
-
-Edit a role
-
-```
--f, --file string   Path to the role body file
-````
-
-###  shield role list 
+### `shield role list`
 
 List all roles
 
-###  shield role view [flags] 
-
-View a role
-
-```
--m, --metadata   Set this flag to see metadata
-````
-
-##  shield server
+## `shield server <command>`
 
 Server management
 
-###  shield server init [flags] 
+### `shield server init [flags]`
 
 Initialize server
 
@@ -283,37 +227,38 @@ Initialize server
                          local storage file "file:///tmp/rules"
                          GCS Bucket "gs://shield-bucket-example"
                          (default: file://{pwd}/rules)
-````                      
+                         
+````
 
-###  shield server migrate [flags] 
+### `shield server migrate [flags]`
 
 Run DB Schema Migrations
 
 ```
 -c, --config string   Config file path
 ````
 
-###  shield server migration-rollback [flags] 
+### `shield server migration-rollback [flags]`
 
 Run DB Schema Migrations Rollback to last state
 
 ```
 -c, --config string   Config file path
 ````
 
-###  shield server start [flags] 
+### `shield server start [flags]`
 
 Start server and proxy default on port 8080
 
 ```
 -c, --config string   Config file path
 ````
 
-##  shield user 
+## `shield user`
 
 Manage users
 
-###  shield user create [flags] 
+### `shield user create [flags]`
 
 Create an user
 
@@ -322,22 +267,23 @@ Create an user
 -H, --header string   Header <key>:<value>
 ````
 
-###  shield user edit [flags] 
+### `shield user edit [flags]`
 
 Edit an user
 
 ```
 -f, --file string   Path to the user body file
 ````
 
-###  shield user list 
+### `shield user list`
 
 List all users
 
-###  shield user view [flags] 
+### `shield user view [flags]`
 
 View an user
 
 ```
 -m, --metadata   Set this flag to see metadata
-````
+````
+