fix: consistent use of ID as metavar (#262)

satterly · web-flow · commit e47f857d501c · 2021-04-18T13:01:17.000+02:00
diff --git a/alertaclient/commands/cmd_ack.py b/alertaclient/commands/cmd_ack.py
@@ -4,7 +4,7 @@
 
 
 @click.command('ack', short_help='Acknowledge alerts')
-@click.option('--ids', '-i', metavar='UUID', multiple=True, help='List of alert IDs (can use short 8-char id)')
+@click.option('--ids', '-i', metavar='ID', multiple=True, help='List of alert IDs (can use short 8-char id)')
 @click.option('--query', '-q', 'query', metavar='QUERY', help='severity:"warning" AND resource:web')
 @click.option('--filter', '-f', 'filters', metavar='FILTER', multiple=True, help='KEY=VALUE eg. serverity=warning resource=web')
 @click.option('--text', help='Message associated with status change')
diff --git a/alertaclient/commands/cmd_action.py b/alertaclient/commands/cmd_action.py
@@ -5,7 +5,7 @@
 
 @click.command('action', short_help='Action alerts')
 @click.option('--action', '-a', metavar='ACTION', help='Custom action (user-defined)')
-@click.option('--ids', '-i', metavar='UUID', multiple=True, help='List of alert IDs (can use short 8-char id)')
+@click.option('--ids', '-i', metavar='ID', multiple=True, help='List of alert IDs (can use short 8-char id)')
 @click.option('--query', '-q', 'query', metavar='QUERY', help='severity:"warning" AND resource:web')
 @click.option('--filter', '-f', 'filters', metavar='FILTER', multiple=True, help='KEY=VALUE eg. serverity=warning resource=web')
 @click.option('--text', help='Message associated with action')
diff --git a/alertaclient/commands/cmd_close.py b/alertaclient/commands/cmd_close.py
@@ -4,7 +4,7 @@
 
 
 @click.command('ack', short_help='Close alerts')
-@click.option('--ids', '-i', metavar='UUID', multiple=True, help='List of alert IDs (can use short 8-char id)')
+@click.option('--ids', '-i', metavar='ID', multiple=True, help='List of alert IDs (can use short 8-char id)')
 @click.option('--query', '-q', 'query', metavar='QUERY', help='severity:"warning" AND resource:web')
 @click.option('--filter', '-f', 'filters', metavar='FILTER', multiple=True, help='KEY=VALUE eg. serverity=warning resource=web')
 @click.option('--text', help='Message associated with status change')
diff --git a/alertaclient/commands/cmd_delete.py b/alertaclient/commands/cmd_delete.py
@@ -4,7 +4,7 @@
 
 
 @click.command('delete', short_help='Delete alerts')
-@click.option('--ids', '-i', metavar='UUID', multiple=True, help='List of alert IDs (can use short 8-char id)')
+@click.option('--ids', '-i', metavar='ID', multiple=True, help='List of alert IDs (can use short 8-char id)')
 @click.option('--query', '-q', 'query', metavar='QUERY', help='severity:"warning" AND resource:web')
 @click.option('--filter', '-f', 'filters', metavar='FILTER', multiple=True, help='KEY=VALUE eg. serverity=warning resource=web')
 @click.pass_obj
diff --git a/alertaclient/commands/cmd_group.py b/alertaclient/commands/cmd_group.py
@@ -5,7 +5,7 @@
 
 
 @click.command('group', short_help='Create user group')
-@click.option('--id', '-i', metavar='UUID', help='Group ID')
+@click.option('--id', '-i', metavar='ID', help='Group ID')
 @click.option('--name', help='Group name')
 @click.option('--text', help='Description of user group')
 @click.option('--user', '-U', help='Add user to group')
diff --git a/alertaclient/commands/cmd_history.py b/alertaclient/commands/cmd_history.py
@@ -7,7 +7,7 @@
 
 
 @click.command('history', short_help='Show alert history')
-@click.option('--ids', '-i', metavar='UUID', multiple=True, help='List of alert IDs (can use short 8-char id)')
+@click.option('--ids', '-i', metavar='ID', multiple=True, help='List of alert IDs (can use short 8-char id)')
 @click.option('--query', '-q', 'query', metavar='QUERY', help='severity:"warning" AND resource:web')
 @click.option('--filter', '-f', 'filters', metavar='FILTER', multiple=True, help='KEY=VALUE eg. serverity=warning resource=web')
 @click.pass_obj
diff --git a/alertaclient/commands/cmd_note.py b/alertaclient/commands/cmd_note.py
@@ -4,8 +4,8 @@
 
 
 @click.command('note', short_help='Add note')
-@click.option('--ids', '-i', metavar='UUID', multiple=True, help='List of note IDs')
-@click.option('--alert-ids', '-i', metavar='UUID', multiple=True, help='List of alert IDs (can use short 8-char id)')
+@click.option('--ids', '-i', metavar='ID', multiple=True, help='List of note IDs')
+@click.option('--alert-ids', '-i', metavar='ID', multiple=True, help='List of alert IDs (can use short 8-char id)')
 @click.option('--query', '-q', 'query', metavar='QUERY', help='severity:"warning" AND resource:web')
 @click.option('--filter', '-f', 'filters', metavar='FILTER', multiple=True, help='KEY=VALUE eg. serverity=warning resource=web')
 @click.option('--text', help='Note or message')
diff --git a/alertaclient/commands/cmd_notes.py b/alertaclient/commands/cmd_notes.py
@@ -5,7 +5,7 @@
 
 
 @click.command('notes', short_help='List notes')
-@click.option('--alert-id', '-i', metavar='UUID', help='alert IDs (can use short 8-char id)')
+@click.option('--alert-id', '-i', metavar='ID', help='alert IDs (can use short 8-char id)')
 @click.pass_obj
 def cli(obj, alert_id):
     """List notes."""
diff --git a/alertaclient/commands/cmd_query.py b/alertaclient/commands/cmd_query.py
@@ -17,7 +17,7 @@
 
 
 @click.command('query', short_help='Search for alerts')
-@click.option('--ids', '-i', metavar='UUID', multiple=True, help='List of alert IDs (can use short 8-char id)')
+@click.option('--ids', '-i', metavar='ID', multiple=True, help='List of alert IDs (can use short 8-char id)')
 @click.option('--query', '-q', 'query', metavar='QUERY', help='severity:"warning" AND resource:web')
 @click.option('--filter', '-f', 'filters', metavar='FILTER', multiple=True, help='KEY=VALUE eg. serverity=warning resource=web')
 @click.option('--oneline', 'display', flag_value='oneline', default=True, help='Show alerts using table format')
diff --git a/alertaclient/commands/cmd_raw.py b/alertaclient/commands/cmd_raw.py
@@ -5,7 +5,7 @@
 
 
 @click.command('raw', short_help='Show alert raw data')
-@click.option('--ids', '-i', metavar='UUID', multiple=True, help='List of alert IDs (can use short 8-char id)')
+@click.option('--ids', '-i', metavar='ID', multiple=True, help='List of alert IDs (can use short 8-char id)')
 @click.option('--query', '-q', 'query', metavar='QUERY', help='severity:"warning" AND resource:web')
 @click.option('--filter', '-f', 'filters', metavar='FILTER', multiple=True, help='KEY=VALUE eg. serverity=warning resource=web')
 @click.pass_obj
diff --git a/alertaclient/commands/cmd_revoke.py b/alertaclient/commands/cmd_revoke.py
@@ -4,7 +4,7 @@
 
 
 @click.command('revoke', short_help='Revoke API key')
-@click.option('--api-key', '-K', required=True, help='API Key or UUID')
+@click.option('--api-key', '-K', required=True, help='API Key or ID')
 @click.pass_context
 def cli(ctx, api_key):
     ctx.invoke(revoke, delete=api_key)
diff --git a/alertaclient/commands/cmd_shelve.py b/alertaclient/commands/cmd_shelve.py
@@ -4,7 +4,7 @@
 
 
 @click.command('shelve', short_help='Shelve alerts')
-@click.option('--ids', '-i', metavar='UUID', multiple=True, help='List of alert IDs (can use short 8-char id)')
+@click.option('--ids', '-i', metavar='ID', multiple=True, help='List of alert IDs (can use short 8-char id)')
 @click.option('--query', '-q', 'query', metavar='QUERY', help='severity:"warning" AND resource:web')
 @click.option('--filter', '-f', 'filters', metavar='FILTER', multiple=True, help='KEY=VALUE eg. serverity=warning resource=web')
 @click.option('--timeout', metavar='SECONDS', type=int, help='Seconds before alert auto-unshelved.', default=7200, show_default=True)
diff --git a/alertaclient/commands/cmd_tag.py b/alertaclient/commands/cmd_tag.py
@@ -4,7 +4,7 @@
 
 
 @click.command('tag', short_help='Tag alerts')
-@click.option('--ids', '-i', metavar='UUID', multiple=True, help='List of alert IDs (can use short 8-char id)')
+@click.option('--ids', '-i', metavar='ID', multiple=True, help='List of alert IDs (can use short 8-char id)')
 @click.option('--query', '-q', 'query', metavar='QUERY', help='severity:"warning" AND resource:web')
 @click.option('--filter', '-f', 'filters', metavar='FILTER', multiple=True, help='KEY=VALUE eg. serverity=warning resource=web')
 @click.option('--tag', '-T', 'tags', required=True, multiple=True, help='List of tags')
diff --git a/alertaclient/commands/cmd_unack.py b/alertaclient/commands/cmd_unack.py
@@ -4,7 +4,7 @@
 
 
 @click.command('unack', short_help='Un-acknowledge alerts')
-@click.option('--ids', '-i', metavar='UUID', multiple=True, help='List of alert IDs (can use short 8-char id)')
+@click.option('--ids', '-i', metavar='ID', multiple=True, help='List of alert IDs (can use short 8-char id)')
 @click.option('--query', '-q', 'query', metavar='QUERY', help='severity:"warning" AND resource:web')
 @click.option('--filter', '-f', 'filters', metavar='FILTER', multiple=True, help='KEY=VALUE eg. serverity=warning resource=web')
 @click.option('--text', help='Message associated with status change')
diff --git a/alertaclient/commands/cmd_unshelve.py b/alertaclient/commands/cmd_unshelve.py
@@ -4,7 +4,7 @@
 
 
 @click.command('unshelve', short_help='Un-shelve alerts')
-@click.option('--ids', '-i', metavar='UUID', multiple=True, help='List of alert IDs (can use short 8-char id)')
+@click.option('--ids', '-i', metavar='ID', multiple=True, help='List of alert IDs (can use short 8-char id)')
 @click.option('--query', '-q', 'query', metavar='QUERY', help='severity:"warning" AND resource:web')
 @click.option('--filter', '-f', 'filters', metavar='FILTER', multiple=True, help='KEY=VALUE eg. serverity=warning resource=web')
 @click.option('--text', help='Message associated with status change')
diff --git a/alertaclient/commands/cmd_untag.py b/alertaclient/commands/cmd_untag.py
@@ -4,7 +4,7 @@
 
 
 @click.command('untag', short_help='Untag alerts')
-@click.option('--ids', '-i', metavar='UUID', multiple=True, help='List of alert IDs (can use short 8-char id)')
+@click.option('--ids', '-i', metavar='ID', multiple=True, help='List of alert IDs (can use short 8-char id)')
 @click.option('--query', '-q', 'query', metavar='QUERY', help='severity:"warning" AND resource:web')
 @click.option('--filter', '-f', 'filters', metavar='FILTER', multiple=True, help='KEY=VALUE eg. serverity=warning resource=web')
 @click.option('--tag', '-T', 'tags', required=True, multiple=True, help='List of tags')
diff --git a/alertaclient/commands/cmd_update.py b/alertaclient/commands/cmd_update.py
@@ -4,7 +4,7 @@
 
 
 @click.command('update', short_help='Update alert attributes')
-@click.option('--ids', '-i', metavar='UUID', multiple=True, help='List of alert IDs (can use short 8-char id)')
+@click.option('--ids', '-i', metavar='ID', multiple=True, help='List of alert IDs (can use short 8-char id)')
 @click.option('--query', '-q', 'query', metavar='QUERY', help='severity:"warning" AND resource:web')
 @click.option('--filter', '-f', 'filters', metavar='FILTER', multiple=True, help='KEY=VALUE eg. serverity=warning resource=web')
 @click.option('--attributes', '-A', metavar='KEY=VALUE', multiple=True, required=True, help='List of attributes eg. priority=high')
diff --git a/alertaclient/commands/cmd_user.py b/alertaclient/commands/cmd_user.py
@@ -20,7 +20,7 @@ def parse_args(self, ctx, args):
 
 
 @click.command('user', cls=CommandWithOptionalPassword, short_help='Update user')
-@click.option('--id', '-i', metavar='UUID', help='User ID')
+@click.option('--id', '-i', metavar='ID', help='User ID')
 @click.option('--name', help='Name of user')
 @click.option('--email', help='Email address (login username)')
 @click.option('--password', help='Password (will prompt if not supplied)')
diff --git a/alertaclient/commands/cmd_watch.py b/alertaclient/commands/cmd_watch.py
@@ -7,7 +7,7 @@
 
 
 @click.command('watch', short_help='Watch alerts')
-@click.option('--ids', '-i', metavar='UUID', multiple=True, help='List of alert IDs (can use short 8-char id)')
+@click.option('--ids', '-i', metavar='ID', multiple=True, help='List of alert IDs (can use short 8-char id)')
 @click.option('--query', '-q', 'query', metavar='QUERY', help='severity:"warning" AND resource:web')
 @click.option('--filter', '-f', 'filters', metavar='FILTER', multiple=True, help='KEY=VALUE eg. serverity=warning resource=web')
 @click.option('--details', is_flag=True, help='Compact output with details')
