diff --git a/api-ref/source/v1/stack-events.inc b/api-ref/source/v1/stack-events.inc index ca01f8a0dc..b3578bb2a8 100644 --- a/api-ref/source/v1/stack-events.inc +++ b/api-ref/source/v1/stack-events.inc @@ -94,6 +94,7 @@ Request - marker: marker - sort_keys: sort_keys - sort_dir: sort_dir + - nested_depth: nested_depth diff --git a/releasenotes/notes/event-list-nested-depth-80081a2a8eefee1a.yaml b/releasenotes/notes/event-list-nested-depth-80081a2a8eefee1a.yaml new file mode 100644 index 0000000000..a393f8c5b3 --- /dev/null +++ b/releasenotes/notes/event-list-nested-depth-80081a2a8eefee1a.yaml @@ -0,0 +1,14 @@ +--- +prelude: > + Previously the event list REST API call only returned events for the + specified stack even when that stack contained nested stack resources. This + meant that fetching all nested events required an inefficient recursive + client-side implementation. +features: +- The event list GET REST API call now has a different behaviour when the + 'nested_depth' parameter is set to an integer greater than zero. The response + will contain all events down to the requested nested depth. +- When 'nested_depth' is set the response also includes an extra entry in the + 'links' list with 'rel' set to 'root_stack'. This can be used by client side + implementations to detect whether it is necessary to fall back to client-side + recurisive event fetching.