diff --git a/doc/source/command-objects/credential.rst b/doc/source/command-objects/credential.rst index ed8a00db..538362a8 100644 --- a/doc/source/command-objects/credential.rst +++ b/doc/source/command-objects/credential.rst @@ -1,27 +1,113 @@ -=========== +========== credential -=========== +========== Identity v3 credential create ------------------- +----------------- -.. ''[consider rolling the ec2 creds into this too]'' +Create new credential +.. program:: credential create .. code:: bash os credential create - --x509 - [] - [] + [--type ] + [--project ] + + +.. option:: --type + + New credential type + +.. option:: --project + + Project which limits the scope of the credential (name or ID) + +.. _credential_create: +.. describe:: + + User that owns the credential (name or ID) + +.. describe:: + + New credential data + +credential delete +----------------- + +Delete credential(s) + +.. program:: credential delete +.. code:: bash + + os credential delete + [ ...] + +.. _credential_delete: +.. describe:: + + ID(s) of credential to delete + +credential list +--------------- + +List credentials + +.. program:: credential list +.. code:: bash + + os credential list + +credential set +-------------- + +Set credential properties + +.. program:: credential set +.. code:: bash + + os credential set + [--user ] + [--type ] + [--data ] + [--project ] + + +.. option:: --user + + User that owns the credential (name or ID) + +.. option:: --type + + New credential type + +.. option:: --data + + New credential data + +.. option:: --project + + Project which limits the scope of the credential (name or ID) + +.. _credential_set: +.. describe:: + + ID of credential to change credential show ----------------- +--------------- +Display credential details + +.. program:: credential show .. code:: bash os credential show - [--token] - [--user] - [--x509 [--root]] + + +.. _credential_show: +.. describe:: + + ID of credential to display diff --git a/openstackclient/identity/v3/credential.py b/openstackclient/identity/v3/credential.py index 0ea29aba..0ef94cf4 100644 --- a/openstackclient/identity/v3/credential.py +++ b/openstackclient/identity/v3/credential.py @@ -29,14 +29,14 @@ LOG = logging.getLogger(__name__) class CreateCredential(command.ShowOne): - """Create credential command""" + """Create new credential""" def get_parser(self, prog_name): parser = super(CreateCredential, self).get_parser(prog_name) parser.add_argument( 'user', metavar='', - help=_('Name or ID of user that owns the credential'), + help=_('user that owns the credential (name or ID)'), ) parser.add_argument( '--type', @@ -53,8 +53,8 @@ class CreateCredential(command.ShowOne): parser.add_argument( '--project', metavar='', - help=_('Project name or ID which limits the ' - 'scope of the credential'), + help=_('Project which limits the scope of ' + 'the credential (name or ID)'), ) return parser @@ -110,7 +110,7 @@ class DeleteCredential(command.Command): class ListCredential(command.Lister): - """List credential command""" + """List credentials""" def take_action(self, parsed_args): columns = ('ID', 'Type', 'User ID', 'Blob', 'Project ID') @@ -124,7 +124,7 @@ class ListCredential(command.Lister): class SetCredential(command.Command): - """Set credential command""" + """Set credential properties""" def get_parser(self, prog_name): parser = super(SetCredential, self).get_parser(prog_name) @@ -137,7 +137,7 @@ class SetCredential(command.Command): '--user', metavar='', required=True, - help=_('Name or ID of user that owns the credential'), + help=_('User that owns the credential (name or ID)'), ) parser.add_argument( '--type', @@ -155,8 +155,8 @@ class SetCredential(command.Command): parser.add_argument( '--project', metavar='', - help=_('Project name or ID which limits the ' - 'scope of the credential'), + help=_('Project which limits the scope of ' + 'the credential (name or ID)'), ) return parser @@ -180,7 +180,7 @@ class SetCredential(command.Command): class ShowCredential(command.ShowOne): - """Show credential command""" + """Display credential details""" def get_parser(self, prog_name): parser = super(ShowCredential, self).get_parser(prog_name)