Correct project/user id descriptions for os-instance-actions

The 'user_id' and 'project_id' parameter descriptions for server actions imply that they are the value of the user/project that owns the server, but that is incorrect - they are the project/user id of whoever made the request/initiated the action. The existing project_id_instance_action parameter variable, which is only used by the os-cloudpipe reference, is renamed to avoid confusion with instance actions. Co-Authored-By: Brin Zhang <[email protected]> Closes-Bug: #1835063 Change-Id: I1c05d59ebf1fda6319df5ee305c2b8a6a9562242
Centrinix · Jul 22, 2019 · 6b3aa31 · 6b3aa31
1 parent 93cae75
commit 6b3aa31
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 7 deletions.
diff --git a/api-ref/source/os-cloudpipe.inc b/api-ref/source/os-cloudpipe.inc
@@ -33,7 +33,7 @@ Response
   - created_at: created
   - instance_id: instance_id_cloudpipe
   - internal_ip: fixed_ip
-  - project_id: project_id_instance_action
+  - project_id: project_id_server
   - public_ip: vpn_public_ip_resp
   - public_port: vpn_public_port_resp
   - state: vpn_state

diff --git a/api-ref/source/os-instance-actions.inc b/api-ref/source/os-instance-actions.inc
@@ -46,10 +46,10 @@ Response
   - action: action
   - instance_uuid: instance_id_body
   - message: message
-  - project_id: project_id_instance_action
+  - project_id: project_id_server_action
   - request_id: request_id_body
   - start_time: start_time
-  - user_id: user_id
+  - user_id: user_id_server_action
   - updated_at: updated_instance_action
   - links: instance_actions_next_links
 
@@ -101,10 +101,10 @@ Response
   - action: action
   - instance_uuid: instance_id_body
   - message: message
-  - project_id: project_id_instance_action
+  - project_id: project_id_server_action
   - request_id: request_id_body
   - start_time: start_time
-  - user_id: user_id
+  - user_id: user_id_server_action
   - events: instance_action_events_2_50
   - events: instance_action_events_2_51
   - events.event: event

diff --git a/api-ref/source/parameters.yaml b/api-ref/source/parameters.yaml
@@ -5480,9 +5480,15 @@ project_id:
   in: body
   required: false
   type: string
-project_id_instance_action:
+project_id_server:
   description: |
-    The UUID of the project that this server belongs to.
+    The ID of the project that this server belongs to.
+  in: body
+  required: true
+  type: string
+project_id_server_action:
+  description: |
+    The ID of the project which initiated the server action.
   in: body
   required: true
   type: string
@@ -6727,6 +6733,12 @@ user_id:
   in: body
   required: true
   type: string
+user_id_server_action:
+  description: |
+    The ID of the user which initiated the server action.
+  in: body
+  required: true
+  type: string
 user_id_server_group:
   description: |
     The user ID who owns the server group.