Updates shell doc of v1 client

This patch updates shell doc of designate v1 client.

Closes-Bug: #1511672

Change-Id: Iaa35b4fa97e0a3680769c0942a51c28e7cede2fc

2 files changed, 160 insertions, 87 deletions

diff --git a/doc/source/shell-examples.rst b/doc/source/shell-examples.rst
index 5956177..d7d71ea 100644
--- a/doc/source/shell-examples.rst
+++ b/doc/source/shell-examples.rst
@@ -12,23 +12,39 @@ Typically the designate client talks to Keystone (or a Keystone like service) vi
     +------------+--------------------------------------+
     | Field      | Value                                |
     +------------+--------------------------------------+
-    | created_at | 2013-07-09T13:20:23.664811           |
-    | id         | 1af2d561-b802-44d7-8208-46475dcd45f9 |
-    | name       | ns.foo.com.                          |
+    | id         | 3dee78df-c6b8-4fbd-8e89-3186c1a4734f |
+    | created_at | 2015-11-04T08:47:12.000000           |
     | updated_at | None                                 |
+    | name       | ns.foo.com.                          |
     +------------+--------------------------------------+
 
     $ designate --os-endpoint http://127.0.0.1:9001/v1 domain-create --name testing123.net. --email me@mydomain.com
-    +------------+--------------------------------------+
-    | Field      | Value                                |
-    +------------+--------------------------------------+
-    | name       | testing123.net.                      |
-    | created_at | 2013-07-09T13:20:30.826155           |
-    | updated_at | None                                 |
-    | id         | 5c02c519-4928-4a38-bd10-c748c200912f |
-    | ttl        | 3600                                 |
-    | serial     | 1373376030                           |
-    | email      | me@mydomain.com                      |
-    +------------+--------------------------------------+
+    +-------------+--------------------------------------+
+    | Field       | Value                                |
+    +-------------+--------------------------------------+
+    | description | None                                 |
+    | created_at  | 2015-11-04T08:49:53.000000           |
+    | updated_at  | None                                 |
+    | email       | me@mydomain.com                      |
+    | ttl         | 3600                                 |
+    | serial      | 1446626993                           |
+    | id          | f98c3d91-f514-4956-a955-20eefb413a64 |
+    | name        | testing123.net.                      |
+    +-------------+--------------------------------------+
+
+    $ designate --os-endpoint http://127.0.0.1:9001/v1 record-create --name myhost.testing123.net. --type A --data 1.2.3.4 f98c3d91-f514-4956-a955-20eefb413a64
+    +-------------+--------------------------------------+
+    | Field       | Value                                |
+    +-------------+--------------------------------------+
+    | description | None                                 |
+    | type        | A                                    |
+    | created_at  | 2015-11-04T08:52:41.000000           |
+    | updated_at  | None                                 |
+    | domain_id   | f98c3d91-f514-4956-a955-20eefb413a64 |
+    | priority    | None                                 |
+    | ttl         | None                                 |
+    | data        | 1.2.3.4                              |
+    | id          | b5a74471-8062-4395-be70-968805a0d832 |
+    | name        | myhost.testing123.net.               |
+    +-------------+--------------------------------------+
 
-    $ designate --os-endpoint http://127.0.0.1:9001/v1 record-create --name myhost.testing123.net. --type A --data 1.2.3.4 5c02c519-4928-4a38-bd10-c748c200912f
diff --git a/doc/source/shell.rst b/doc/source/shell.rst
index b85d2ec..aa0ea4b 100644
--- a/doc/source/shell.rst
+++ b/doc/source/shell.rst
@@ -85,10 +85,8 @@ We've already seen the ``domain-create`` and ``record-create`` subcommands, here
 ======================= ====================================================== ===============
 subcommand              Notes                                                  Admin Required
 ======================= ====================================================== ===============
+complete                print bash completion command
 diagnostics-ping        Ping a service on a given host
-diagnostics-sync-all    Sync Everything
-diagnostics-sync-domain Sync a single Domain
-diagnostics-sync-record Sync a single Record
 domain-create           Create Domain
 domain-delete           Delete Domain
 domain-get              Get Domain
@@ -96,6 +94,9 @@ domain-list             List Domains
 domain-servers-list     List Domain Servers
 domain-update           Update Domain
 help                    print detailed help for another command
+quota-get               Get Quota
+quota-reset             Reset Quota
+quota-update            Update Quota
 record-create           Create Record
 record-delete           Delete Record
 record-get              Get Record
@@ -112,80 +113,136 @@ server-delete           Delete Server
 server-get              Get Server
 server-list             List Servers
 server-update           Update Server
+sync-all                Sync Everything
+sync-domain             Sync a single Domain
+sync-record             Sync a single Record
+touch-domain            Touch a single Domain
+
 ======================= ====================================================== ===============
 
 Builtin designate documentation
 -------------------------------
 
 You'll find complete documentation on the shell by running
-``designate --help``::
-
-    usage: designate [--version] [-v] [--log-file LOG_FILE] [-q] [-h] [--debug]
-                     [--os-endpoint OS_ENDPOINT] [--os-auth-url OS_AUTH_URL]
-                     [--os-username OS_USERNAME] [--os-password OS_PASSWORD]
-                     [--os-tenant-id OS_TENANT_ID]
-                     [--os-tenant-name OS_TENANT_NAME] [--os-token OS_TOKEN]
-                     [--os-service-type OS_SERVICE_TYPE]
-                     [--os-region-name OS_REGION_NAME]
-                     [--sudo-tenant-id SUDO_TENANT_ID] [--insecure]
-
-    Designate Client
-
-    optional arguments:
-      --version             show program's version number and exit
-      -v, --verbose         Increase verbosity of output. Can be repeated.
-      --log-file LOG_FILE   Specify a file to log output. Disabled by default.
-      -q, --quiet           suppress output except warnings and errors
-      -h, --help            show this help message and exit
-      --debug               show tracebacks on errors
-      --os-endpoint OS_ENDPOINT
-                            Defaults to env[OS_DNS_ENDPOINT]
-      --os-auth-url OS_AUTH_URL
-                            Defaults to env[OS_AUTH_URL]
-      --os-username OS_USERNAME
-                            Defaults to env[OS_USERNAME]
-      --os-password OS_PASSWORD
-                            Defaults to env[OS_PASSWORD]
-      --os-tenant-id OS_TENANT_ID
-                            Defaults to env[OS_TENANT_ID]
-      --os-tenant-name OS_TENANT_NAME
-                            Defaults to env[OS_TENANT_NAME]
-      --os-token OS_TOKEN   Defaults to env[OS_SERVICE_TOKEN]
-      --os-service-type OS_SERVICE_TYPE
-                            Defaults to env[OS_DNS_SERVICE_TYPE], or 'dns'
-      --os-region-name OS_REGION_NAME
-                            Defaults to env[OS_REGION_NAME]
-      --sudo-tenant-id SUDO_TENANT_ID
-                            Defaults to env[DESIGNATE_SUDO_TENANT_ID]
-      --insecure            Explicitly allow 'insecure' SSL requests
-
-    Commands:
-      diagnostics-ping  Ping a service on a given host
-      diagnostics-sync-all  Sync Everything
-      diagnostics-sync-domain  Sync a single Domain
-      diagnostics-sync-record  Sync a single Record
-      domain-create  Create Domain
-      domain-delete  Delete Domain
-      domain-get     Get Domain
-      domain-list    List Domains
-      domain-servers-list  List Domain Servers
-      domain-update  Update Domain
-      help           print detailed help for another command
-      record-create  Create Record
-      record-delete  Delete Record
-      record-get     Get Record
-      record-list    List Records
-      record-update  Update Record
-      report-count-all  Get count totals for all tenants, domains and records
-      report-count-domains  Get counts for total domains
-      report-count-records  Get counts for total records
-      report-count-tenants  Get counts for total tenants
-      report-tenant-domains  Get a list of domains for given tenant
-      report-tenants-all  Get list of tenants and domain count for each
-      server-create  Create Server
-      server-delete  Delete Server
-      server-get     Get Server
-      server-list    List Servers
-      server-update  Update Server
+``designate --help``:
+
+usage: designate [--version] [-v] [--log-file LOG_FILE] [-q] [-h] [--debug]
+                 [--os-username OS_USERNAME] [--os-user-id OS_USER_ID]
+                 [--os-user-domain-id OS_USER_DOMAIN_ID]
+                 [--os-user-domain-name OS_USER_DOMAIN_NAME]
+                 [--os-password OS_PASSWORD] [--os-tenant-name OS_TENANT_NAME]
+                 [--os-tenant-id OS_TENANT_ID]
+                 [--os-project-name OS_PROJECT_NAME]
+                 [--os-domain-name OS_DOMAIN_NAME]
+                 [--os-domain-id OS_DOMAIN_ID] [--os-project-id OS_PROJECT_ID]
+                 [--os-project-domain-id OS_PROJECT_DOMAIN_ID]
+                 [--os-project-domain-name OS_PROJECT_DOMAIN_NAME]
+                 [--os-auth-url OS_AUTH_URL] [--os-region-name OS_REGION_NAME]
+                 [--os-token OS_TOKEN] [--os-endpoint OS_ENDPOINT]
+                 [--os-endpoint-type OS_ENDPOINT_TYPE]
+                 [--os-service-type OS_SERVICE_TYPE] [--os-cacert OS_CACERT]
+                 [--insecure] [--all-tenants] [--edit-managed]
+
+Designate Client
+
+optional arguments:
+  --version             show program's version number and exit
+  -v, --verbose         Increase verbosity of output. Can be repeated.
+  --log-file LOG_FILE   Specify a file to log output. Disabled by default.
+  -q, --quiet           Suppress output except warnings and errors.
+  -h, --help            Show this help message and exit.
+  --debug               Show tracebacks on errors.
+  --os-username OS_USERNAME
+                        Name used for authentication with the OpenStack
+                        Identity service. Defaults to env[OS_USERNAME].
+  --os-user-id OS_USER_ID
+                        User ID used for authentication with the OpenStack
+                        Identity service. Defaults to env[OS_USER_ID].
+  --os-user-domain-id OS_USER_DOMAIN_ID
+                        Defaults to env[OS_USER_DOMAIN_ID].
+  --os-user-domain-name OS_USER_DOMAIN_NAME
+                        Defaults to env[OS_USER_DOMAIN_NAME].
+  --os-password OS_PASSWORD
+                        Password used for authentication with the OpenStack
+                        Identity service. Defaults to env[OS_PASSWORD].
+  --os-tenant-name OS_TENANT_NAME
+                        Tenant to request authorization on. Defaults to
+                        env[OS_TENANT_NAME].
+  --os-tenant-id OS_TENANT_ID
+                        Tenant to request authorization on. Defaults to
+                        env[OS_TENANT_ID].
+  --os-project-name OS_PROJECT_NAME
+                        Project to request authorization on. Defaults to
+                        env[OS_PROJECT_NAME].
+  --os-domain-name OS_DOMAIN_NAME
+                        Project to request authorization on. Defaults to
+                        env[OS_DOMAIN_NAME].
+  --os-domain-id OS_DOMAIN_ID
+                        Defaults to env[OS_DOMAIN_ID].
+  --os-project-id OS_PROJECT_ID
+                        Project to request authorization on. Defaults to
+                        env[OS_PROJECT_ID].
+  --os-project-domain-id OS_PROJECT_DOMAIN_ID
+                        Defaults to env[OS_PROJECT_DOMAIN_ID].
+  --os-project-domain-name OS_PROJECT_DOMAIN_NAME
+                        Defaults to env[OS_PROJECT_DOMAIN_NAME].
+  --os-auth-url OS_AUTH_URL
+                        Specify the Identity endpoint to use for
+                        authentication. Defaults to env[OS_AUTH_URL].
+  --os-region-name OS_REGION_NAME
+                        Specify the region to use. Defaults to
+                        env[OS_REGION_NAME].
+  --os-token OS_TOKEN   Specify an existing token to use instead of retrieving
+                        one via authentication (e.g. with username &
+                        password). Defaults to env[OS_SERVICE_TOKEN].
+  --os-endpoint OS_ENDPOINT
+                        Specify an endpoint to use instead of retrieving one
+                        from the service catalog (via authentication).
+                        Defaults to env[OS_DNS_ENDPOINT].
+  --os-endpoint-type OS_ENDPOINT_TYPE
+                        Defaults to env[OS_ENDPOINT_TYPE].
+  --os-service-type OS_SERVICE_TYPE
+                        Defaults to env[OS_DNS_SERVICE_TYPE], or 'dns'.
+  --os-cacert OS_CACERT
+                        CA certificate bundle file. Defaults to
+                        env[OS_CACERT].
+  --insecure            Explicitly allow 'insecure' SSL requests.
+  --all-tenants         Allows to list all domains from all tenants.
+  --edit-managed        Allows to edit records that are marked as managed.
+
+
+Commands:
+  complete       print bash completion command
+  diagnostics-ping  Ping a service on a given host
+  domain-create  Create Domain
+  domain-delete  Delete Domain
+  domain-get     Get Domain
+  domain-list    List Domains
+  domain-servers-list  List Domain Servers
+  domain-update  Update Domain
+  help           print detailed help for another command
+  quota-get      Get Quota
+  quota-reset    Reset Quota
+  quota-update   Update Quota
+  record-create  Create Record
+  record-delete  Delete Record
+  record-get     Get Record
+  record-list    List Records
+  record-update  Update Record
+  report-count-all  Get count totals for all tenants, domains and records
+  report-count-domains  Get counts for total domains
+  report-count-records  Get counts for total records
+  report-count-tenants  Get counts for total tenants
+  report-tenant-domains  Get a list of domains for given tenant
+  report-tenants-all  Get list of tenants and domain count for each
+  server-create  Create Server
+  server-delete  Delete Server
+  server-get     Get Server
+  server-list    List Servers
+  server-update  Update Server
+  sync-all       Sync Everything
+  sync-domain    Sync a single Domain
+  sync-record    Sync a single Record
+  touch-domain   Touch a single Domain
 
 .. _REST API create-domain: https://designate.readthedocs.org/en/latest/rest/domains.html#create-domain