← Back to team overview

yahoo-eng-team team mailing list archive

[Bug 1702573] [NEW] api-ref: GET /servers/{server_id}/os-instance-actions/{request_id} does not list 'events' response key as optional

 

Public bug reported:

The API reference for "GET /servers/{server_id}/os-instance-
actions/{request_id}" does not list the "events" key in the response
body as optional:

https://developer.openstack.org/api-ref/compute/?expanded=show-server-
action-details-detail,list-actions-for-server-detail

However, based on the API code it is:

https://github.com/openstack/nova/blob/635e29433cdadd3d1b664ea2354f049125c393fe/nova/api/openstack/compute/instance_actions.py#L83

By default policy rules, the event details are only shown for admin
users:

https://github.com/openstack/nova/blob/635e29433cdadd3d1b664ea2354f049125c393fe/nova/policies/instance_actions.py#L25

Using the os_compute_api:os-instance-actions:events policy rule.

The API reference should be updated to reflect this.

** Affects: nova
     Importance: Medium
     Assignee: Matt Riedemann (mriedem)
         Status: Triaged


** Tags: api-ref

** Changed in: nova
     Assignee: (unassigned) => Matt Riedemann (mriedem)

** Changed in: nova
   Importance: Undecided => Medium

** Changed in: nova
       Status: New => Triaged

-- 
You received this bug notification because you are a member of Yahoo!
Engineering Team, which is subscribed to OpenStack Compute (nova).
https://bugs.launchpad.net/bugs/1702573

Title:
  api-ref: GET /servers/{server_id}/os-instance-actions/{request_id}
  does not list 'events' response key as optional

Status in OpenStack Compute (nova):
  Triaged

Bug description:
  The API reference for "GET /servers/{server_id}/os-instance-
  actions/{request_id}" does not list the "events" key in the response
  body as optional:

  https://developer.openstack.org/api-ref/compute/?expanded=show-server-
  action-details-detail,list-actions-for-server-detail

  However, based on the API code it is:

  https://github.com/openstack/nova/blob/635e29433cdadd3d1b664ea2354f049125c393fe/nova/api/openstack/compute/instance_actions.py#L83

  By default policy rules, the event details are only shown for admin
  users:

  https://github.com/openstack/nova/blob/635e29433cdadd3d1b664ea2354f049125c393fe/nova/policies/instance_actions.py#L25

  Using the os_compute_api:os-instance-actions:events policy rule.

  The API reference should be updated to reflect this.

To manage notifications about this bug go to:
https://bugs.launchpad.net/nova/+bug/1702573/+subscriptions


Follow ups