diff options
| author | Bob Fournier <bfournie@redhat.com> | 2021-06-01 11:00:24 -0400 |
|---|---|---|
| committer | Bob Fournier <bfournie@redhat.com> | 2021-07-13 21:56:57 -0400 |
| commit | 58ca01c22ab3b33609ca1e98bd2489d871792f34 (patch) | |
| tree | b6265e81522abeb04f998ec319a8facdab66fcb9 /api-ref | |
| parent | e15440370cca1f1a998d3607910697c3129d040a (diff) | |
| download | ironic-58ca01c22ab3b33609ca1e98bd2489d871792f34.tar.gz | |
Add a section to redfish doc for BIOS registry fields
Move the descriptions of the BIOS registry fields in the API to
a new section in the Redfish documentation.
Change-Id: Ifedb4526113bb84ccc598e13f5767b71a60f5532
Diffstat (limited to 'api-ref')
| -rw-r--r-- | api-ref/source/parameters.yaml | 21 |
1 files changed, 7 insertions, 14 deletions
diff --git a/api-ref/source/parameters.yaml b/api-ref/source/parameters.yaml index ef9b1b975..240aed15d 100644 --- a/api-ref/source/parameters.yaml +++ b/api-ref/source/parameters.yaml @@ -507,36 +507,31 @@ bios_interface: type: string bios_setting_allowable_values: description: | - A list of allowable values when the attribute_type is "Enumeration", - otherwise None. + A list of allowable values, otherwise ``null``. in: body required: true type: array bios_setting_attribute_type: description: | - A string describing the type of the Bios setting - "Enumeration", - "Integer", "String", "Boolean", or "Password". May be None. + A string describing the type of the Bios setting. May be ``null``. in: body required: true type: string bios_setting_lower_bound: description: | - The lowest allowed value when attribute_type is "Integer". - May be None. + The lowest allowed integer value. May be ``null``. in: body required: true type: integer bios_setting_max_length: description: | - The maximum length when attribute_type is "String". - May be None. + The maximum string length of the value. May be ``null``. in: body required: true type: integer bios_setting_min_length: description: | - The minimum length when attribute_type is "String". - May be None. + The minimum string length of the value. May be ``null``. in: body required: true type: integer @@ -562,15 +557,13 @@ bios_setting_reset_required: type: boolean bios_setting_unique: description: | - This Bios setting is unique to this node. - May be None. + This Bios setting is unique to this node. May be ``null``. in: body required: true type: boolean bios_setting_upper_bound: description: | - The lowest allowed value when attribute_type is "Integer". - May be None. + The highest allowed integer value. May be ``null``. in: body required: true type: integer |