From f6ef9b4b2843580452bc1e258281f2e0896e472b Mon Sep 17 00:00:00 2001 From: Kevin_Zheng Date: Wed, 6 Jul 2016 11:42:41 +0800 Subject: [PATCH] Parameter verification of os-instance-actions.inc This patch verifies the parameters of os-instance-actions.inc part of bp:api-ref-in-rst Change-Id: I45f0aae2bdeea7603f8b7dce206bfdb1c4c38ccc --- api-ref/source/os-instance-actions.inc | 36 +++++++- api-ref/source/parameters.yaml | 111 +++++++++++++++++++++++++ 2 files changed, 144 insertions(+), 3 deletions(-) diff --git a/api-ref/source/os-instance-actions.inc b/api-ref/source/os-instance-actions.inc index 20ac6b75dffa..2d59bcda6eb1 100644 --- a/api-ref/source/os-instance-actions.inc +++ b/api-ref/source/os-instance-actions.inc @@ -1,5 +1,4 @@ .. -*- rst -*- -.. needs:parameter_verification .. needs:example_verification .. needs:body_verification @@ -30,11 +29,23 @@ Request .. rest_parameters:: parameters.yaml - - server_id: server_id + - server_id: server_id_path Response -------- +.. rest_parameters:: parameters.yaml + + + - instanceActions: instanceActions + - action: action + - instance_uuid: instance_id_body + - message: message + - project_id: project_id_instance_action + - request_id: request_id_body + - start_time: start_time + - user_id: user_id + **Example List Actions For Server: JSON response** .. literalinclude:: ../../doc/api_samples/os-instance-actions/instance-actions-list-resp.json @@ -60,12 +71,31 @@ Request .. rest_parameters:: parameters.yaml - - server_id: server_id + - server_id: server_id_path - request_id: request_id Response -------- + +.. rest_parameters:: parameters.yaml + + + - instanceAction: instanceAction + - action: action + - instance_uuid: instance_id_body + - message: message + - project_id: project_id_instance_action + - request_id: request_id_body + - start_time: start_time + - user_id: user_id + - events: instance_action_events + - events.event: event + - events.start_time: event_start_time + - events.finish_time: event_finish_time + - events.result: event_result + - events.traceback: event_traceback + **Example Show Server Action Details: JSON response** .. literalinclude:: ../../doc/api_samples/os-instance-actions/instance-action-get-resp.json diff --git a/api-ref/source/parameters.yaml b/api-ref/source/parameters.yaml index 95e5d93633e6..0dfa542e2312 100644 --- a/api-ref/source/parameters.yaml +++ b/api-ref/source/parameters.yaml @@ -687,6 +687,12 @@ accessIPv6_in: type: string description: | IPv6 address that should be used to access this server. +action: + description: | + The name of the action. + in: body + required: true + type: string action_reserve: description: | The attribute to reserve an IP with a value of ``null``. @@ -1386,6 +1392,27 @@ evacuate: in: body required: true type: string +event: + description: | + The name of the event. + in: body + required: true + type: string +event_finish_time: + description: | + The date and time when the event was finished. The date and time + stamp format is `ISO 8601 `_ + + :: + + CCYY-MM-DDThh:mm:ss±hh:mm + + For example, ``2015-08-27T09:49:58-05:00``. The ``±hh:mm`` + value, if included, is the time zone as an offset from UTC. In + the previous example, the offset value is ``-05:00``. + in: body + required: true + type: string event_name: description: | The event name. A valid value is ``network-changed``, ``network-vif-plugged``, @@ -1393,6 +1420,27 @@ event_name: in: body required: true type: string +event_result: + description: | + The result of the event. + in: body + required: true + type: string +event_start_time: + description: | + The date and time when the event was started. The date and time + stamp format is `ISO 8601 `_ + + :: + + CCYY-MM-DDThh:mm:ss±hh:mm + + For example, ``2015-08-27T09:49:58-05:00``. The ``±hh:mm`` + value, if included, is the time zone as an offset from UTC. In + the previous example, the offset value is ``-05:00``. + in: body + required: true + type: string event_status: description: | The event status. A valid value is ``failed``, ``completed``, or ``in-progress``. @@ -1406,6 +1454,12 @@ event_tag: in: body required: false type: string +event_traceback: + description: | + The traceback stack if error occurred in this event. + in: body + required: true + type: string events: description: | The action. @@ -2180,6 +2234,18 @@ injectNetworkInfo: in: body required: true type: string +instance_action_events: + description: | + The events occurred in this action. + in: body + required: true + type: array +instance_id_body: + description: | + The UUID of the server. + in: body + required: true + type: string instance_name: description: | The name of the instance. @@ -2211,6 +2277,18 @@ instance_usage_audit_task_state: in: body required: true type: string +instanceAction: + description: | + The instance action object. + in: body + required: true + type: object +instanceActions: + description: | + List of the actions for the given instance. + in: body + required: true + type: array instances: description: | The number of allowed instances for each tenant. @@ -2502,6 +2580,12 @@ memory_mb_used: in: body required: true type: integer +message: + description: | + The error message message about this action when error occurred. + in: body + required: true + type: string meta: description: | The object of detailed key metadata items. @@ -3091,6 +3175,12 @@ project_id: in: body required: false type: string +project_id_instance_action: + description: | + The UUID of the project that this server belongs to. + in: body + required: ture + type: string project_id_server_group: description: | The project ID who owns the server group. @@ -3165,6 +3255,12 @@ removeTenantAccess: in: body required: true type: string +request_id_body: + description: | + The request id generated when execute the API of this action. + in: body + required: true + type: string rescue: description: | The action. @@ -3581,6 +3677,21 @@ source_type: in: body required: true type: string +start_time: + description: | + The date and time when the action was started. The date and time + stamp format is `ISO 8601 `_ + + :: + + CCYY-MM-DDThh:mm:ss±hh:mm + + For example, ``2015-08-27T09:49:58-05:00``. The ``±hh:mm`` + value, if included, is the time zone as an offset from UTC. In + the previous example, the offset value is ``-05:00``. + in: body + required: true + type: string subnet_id: description: | The UUID of the subnet.