diff options
| author | ricolin <rico.lin.guanyu@gmail.com> | 2019-08-03 00:42:19 +0800 |
|---|---|---|
| committer | ricolin <rico.lin.guanyu@gmail.com> | 2019-08-03 00:42:19 +0800 |
| commit | 82c842f3d95583a54f3fb919cbc95cbb0e60a62f (patch) | |
| tree | f683e3789938a07606af5cfac34b694dcddfe4ad /heatclient/v1/events.py | |
| parent | 9e59121af2d53b13b15ef4f46591be5e00d43662 (diff) | |
| download | python-heatclient-82c842f3d95583a54f3fb919cbc95cbb0e60a62f.tar.gz | |
Update stack_id clearify for heat client functions
most of our client major function require stack_id. We should
provide more specific information (at lest in function description)
to clearify that it's allowed to feed in stack name to `stack_id`
too. For example, both `heat.stacks.get($Stack_UUID)` and
`heat.stacks.get($Stack_Name)` works.
Change-Id: I4428097140e0391a77679f5c69e00966f249efd7
Diffstat (limited to 'heatclient/v1/events.py')
| -rw-r--r-- | heatclient/v1/events.py | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/heatclient/v1/events.py b/heatclient/v1/events.py index 651ce9f..f86549d 100644 --- a/heatclient/v1/events.py +++ b/heatclient/v1/events.py @@ -44,7 +44,7 @@ class EventManager(stacks.StackChildManager): def list(self, stack_id, resource_name=None, **kwargs): """Get a list of events. - :param stack_id: ID of stack the events belong to + :param stack_id: ID or name of stack the events belong to :param resource_name: Optional name of resources to filter events by :rtype: list of :class:`Event` """ @@ -74,7 +74,7 @@ class EventManager(stacks.StackChildManager): def get(self, stack_id, resource_name, event_id): """Get the details for a specific event. - :param stack_id: ID of stack containing the event + :param stack_id: ID or name of stack containing the event :param resource_name: ID of resource the event belongs to :param event_id: ID of event to get the details for """ |