From 0bae8ba663892f3ddd513f812c0a424609c86638 Mon Sep 17 00:00:00 2001 From: huangtianhua Date: Wed, 23 Jul 2014 16:31:34 +0800 Subject: [PATCH] Document orchestration event list API This change adds API documetation for event list, also this change that as part of blueprint events-pagination. Change-Id: I2a8e9f1bc29b8d5a6a4533d24e1a2cd324461e35 Closes-Bug: #1347442 --- .../src/v1/orchestration-api.wadl | 194 +++++++++++++++++- .../src/v1/samples/event_list_resp.json | 46 +++++ 2 files changed, 238 insertions(+), 2 deletions(-) create mode 100644 api-ref/src/wadls/orchestration-api/src/v1/samples/event_list_resp.json diff --git a/api-ref/src/wadls/orchestration-api/src/v1/orchestration-api.wadl b/api-ref/src/wadls/orchestration-api/src/v1/orchestration-api.wadl index 0ca04142a..39de7dcf3 100644 --- a/api-ref/src/wadls/orchestration-api/src/v1/orchestration-api.wadl +++ b/api-ref/src/wadls/orchestration-api/src/v1/orchestration-api.wadl @@ -846,7 +846,102 @@ Lists events for a specified stack. - + + + + + Filters the event list by the specified + resource_action. You can use this filter multiple + times to filter by multiple + resource actions: + CREATE, DELETE, + UPDATE, ROLLBACK, + SUSPEND, RESUME or + ADOPT. + + + + + Filters the event list by the specified + resource_status. You can use this filter multiple + times to filter by multiple + resource statuses: + IN_PROGRESS, COMPLETE or + FAILED. + + + + + Filters the event list by the specified + resource_name. You can use this filter multiple + times to filter by multiple + resource names. + + + + + Filters the event list by the specified + resource_type. You can use this filter multiple + times to filter by multiple + resource types: + OS::Nova::Server, + OS::Cinder::Volume, + OS::Neutron::Port, and so on. + + + + + Limits the number of events that appear + on a page to this value. The typical + pattern of limit and marker is to make an + initial limited request and then to use + the ID of the last event from the response + as the marker parameter in a subsequent + limited request. + + + + + Specifies the ID of the last-seen event. + The typical pattern of limit and marker is + to make an initial limited request and + then to use the ID of the last event from + the response as the marker parameter in a + subsequent limited request. + + + + + Sorts the event list by: + resource_type or + created_at. + + + + + The sort direction of the event list. + Which is asc (ascending) or + desc (descending). + + + + + + + + + + + Lists events for a specified stack resource. - + + + + + Filters the event list by the specified + resource_action. You can use this filter multiple + times to filter by multiple + resource actions: + CREATE, DELETE, + UPDATE, ROLLBACK, + SUSPEND, RESUME or + ADOPT. + + + + + Filters the event list by the specified + resource_status. You can use this filter multiple + times to filter by multiple + resource statuses: + IN_PROGRESS, COMPLETE or + FAILED. + + + + + Filters the event list by the specified + resource_name. You can use this filter multiple + times to filter by multiple + resource names. + + + + + Filters the event list by the specified + resource_type. You can use this filter multiple + times to filter by multiple + resource types: + OS::Nova::Server, + OS::Cinder::Volume, + OS::Neutron::Port, and so on. + + + + + Limits the number of events that appear + on a page to this value. The typical + pattern of limit and marker is to make an + initial limited request and then to use + the ID of the last event from the response + as the marker parameter in a subsequent + limited request. + + + + + Specifies the ID of the last-seen event. + The typical pattern of limit and marker is + to make an initial limited request and + then to use the ID of the last event from + the response as the marker parameter in a + subsequent limited request. + + + + + Sorts the event list by: + resource_type or + created_at. + + + + + The sort direction of the event list. + Which is asc (ascending) or + desc (descending). + + + + + + + + + + +