From 3dbb0c4c574f3f4408c98a41f75668f7a604d7d8 Mon Sep 17 00:00:00 2001 From: Matt Riedemann Date: Wed, 3 Apr 2019 18:03:28 -0400 Subject: [PATCH] api-ref: document ordering for instance actions and events Whenever I use the os-instance-actions API I have to look at the DB API source code to figure out the sort order of the resulting instanceActions and each action's events, which is desc(created_at) in both cases (and desc(id) but that should not matter here since the id is not exposed in the API). This change mentions the resulting sort order of those fields in the API reference so I can stop looking at source code. [1] https://github.com/openstack/nova/blob/e7ae6c65c/nova/db/sqlalchemy/api.py#L5149 [2] https://github.com/openstack/nova/blob/e7ae6c65c/nova/db/sqlalchemy/api.py#L5289 Change-Id: Ib5758bc21296e8b6c041198661c147b8e99d57e5 --- api-ref/source/parameters.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/api-ref/source/parameters.yaml b/api-ref/source/parameters.yaml index 58d2288f4a70..0fbdd28dccfc 100644 --- a/api-ref/source/parameters.yaml +++ b/api-ref/source/parameters.yaml @@ -3876,7 +3876,7 @@ injectNetworkInfo: type: none instance_action_events_2_50: description: | - The events which occurred in this action. + The events which occurred in this action in descending order of creation. Policy defaults enable only users with the administrative role to see instance action event information. Cloud providers can change these @@ -3887,7 +3887,7 @@ instance_action_events_2_50: max_version: 2.50 instance_action_events_2_51: description: | - The events which occurred in this action. + The events which occurred in this action in descending order of creation. Policy defaults enable only users with the administrative role or the owner of the server to see instance action event information. Cloud providers can @@ -3958,7 +3958,7 @@ instanceAction: type: object instanceActions: description: | - List of the actions for the given instance. + List of the actions for the given instance in descending order of creation. in: body required: true type: array