From 717fdc551e771ad10bdd274ed63020219c7dae86 Mon Sep 17 00:00:00 2001 From: Ifat Afek Date: Tue, 23 Jan 2018 13:30:35 +0000 Subject: [PATCH] Fixed the Vitrage CLI help Change-Id: If4d0c7982fdbef7c51ace840be414ada8fc9ca16 --- vitrageclient/v1/cli/alarm.py | 2 +- vitrageclient/v1/cli/event.py | 2 +- vitrageclient/v1/cli/rca.py | 2 +- vitrageclient/v1/cli/template.py | 9 +++++---- vitrageclient/v1/cli/webhook.py | 4 ++-- 5 files changed, 10 insertions(+), 9 deletions(-) diff --git a/vitrageclient/v1/cli/alarm.py b/vitrageclient/v1/cli/alarm.py index be9a2cb..4eb3f23 100755 --- a/vitrageclient/v1/cli/alarm.py +++ b/vitrageclient/v1/cli/alarm.py @@ -17,7 +17,7 @@ from vitrageclient.common import utils class AlarmList(lister.Lister): - """List alarms on entity""" + """List all alarms""" def get_parser(self, prog_name): parser = super(AlarmList, self).get_parser(prog_name) diff --git a/vitrageclient/v1/cli/event.py b/vitrageclient/v1/cli/event.py index 4da067c..9e6d2ec 100644 --- a/vitrageclient/v1/cli/event.py +++ b/vitrageclient/v1/cli/event.py @@ -23,7 +23,7 @@ from iso8601 import ParseError # noinspection PyAbstractClass class EventPost(command.Command): - """Show the event of the system""" + """Post an event to Vitrage""" @staticmethod def iso8601(argument_value): diff --git a/vitrageclient/v1/cli/rca.py b/vitrageclient/v1/cli/rca.py index 9e289ec..5af143e 100644 --- a/vitrageclient/v1/cli/rca.py +++ b/vitrageclient/v1/cli/rca.py @@ -16,7 +16,7 @@ from vitrageclient.common import utils # noinspection PyAbstractClass class RcaShow(show.ShowOne): - """Show an RCA""" + """Show the Root Cause Analysis for a certain alarm""" def get_parser(self, prog_name): parser = super(RcaShow, self).get_parser(prog_name) diff --git a/vitrageclient/v1/cli/template.py b/vitrageclient/v1/cli/template.py index d0683e7..cd7e6e9 100644 --- a/vitrageclient/v1/cli/template.py +++ b/vitrageclient/v1/cli/template.py @@ -21,6 +21,7 @@ from vitrageclient.common import utils # noinspection PyAbstractClass class TemplateValidate(show.ShowOne): + """Validate a template file""" def get_parser(self, prog_name): parser = super(TemplateValidate, self).get_parser(prog_name) @@ -48,7 +49,7 @@ class TemplateValidate(show.ShowOne): class TemplateList(lister.Lister): - """Template list""" + """List all templates""" def get_parser(self, prog_name): parser = super(TemplateList, self).get_parser(prog_name) @@ -68,7 +69,7 @@ class TemplateList(lister.Lister): class TemplateShow(show.ShowOne): - """Template show""" + """Show a template""" def get_parser(self, prog_name): parser = super(TemplateShow, self).get_parser(prog_name) @@ -86,7 +87,7 @@ class TemplateShow(show.ShowOne): class TemplateAdd(lister.Lister): - """Template add + """Add a template support 3 types of templates: standard, definition, equivalence @@ -121,7 +122,7 @@ class TemplateAdd(lister.Lister): class TemplateDelete(command.Command): - """Template delete""" + """Delete a template""" def get_parser(self, prog_name): parser = super(TemplateDelete, self).get_parser(prog_name) diff --git a/vitrageclient/v1/cli/webhook.py b/vitrageclient/v1/cli/webhook.py index 238d5da..c2753c8 100644 --- a/vitrageclient/v1/cli/webhook.py +++ b/vitrageclient/v1/cli/webhook.py @@ -32,7 +32,7 @@ class WebhookShow(show.ShowOne): class WebhookList(lister.Lister): - """List all webhooks in DB""" + """List all webhooks in the database""" POST_PROPS = \ ( @@ -61,7 +61,7 @@ class WebhookList(lister.Lister): class WebhookAdd(show.ShowOne): - """Add a new webhook to DB""" + """Add a new webhook to the database""" def get_parser(self, prog_name): parser = super(WebhookAdd, self).get_parser(prog_name) parser.add_argument('--url',