openstack/nova
Code Issues Proposed changes

api-ref: document the power_state enum values

Browse Source 
The OS-EXT-STS:power_state attribute in a server GET response
is enum values which are meaningless unless you look at the
nova/compute/power_states.py code. This change adds a mapping
to the description on that field in the api-ref.

Note there are gaps in the sequence, those are for unused values
as seen in the nova.objects.fields.InstancePowerState class.

Change-Id: I2ef9f493e66ab04b13f439e73247dc306a1514b4
This commit is contained in:
Matt Riedemann 2016-11-01 17:39:17 -04:00
parent 691bfb0d00
commit c175c8d579
1 changed files with 8 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
api-ref/source/parameters.yaml
View File

@ -3158,7 +3158,14 @@ OS-EXT-SRV-ATTR:instance_name:
type: string
OS-EXT-STS:power_state:
description: |
The power state of the instance.
The power state of the instance. This is an enum value that is mapped as::
0: NOSTATE
1: RUNNING
3: PAUSED
4: SHUTDOWN
6: CRASHED
7: SUSPENDED
in: body
required: true
type: integer