starlingx/config
Code Issues Proposed changes

API documentation error for partitions

Browse Source 
An error occurred when using the partitions part
of the API documentation
(POST /v1/ihosts/​{host_id}​/partitions). After analyzing the
code, I found that the URLs set in the code are /v1/partitions.
This is inconsistent with the API documentation,
so update the partitions section of the API documentation.

Closes-Bug: #1897231

Change-Id: I9fc61b86bdfc4cb12acfd4f4cd8ecf8853ab338e
Signed-off-by: YuehuiLei<leiyuehui@inspur.com>
This commit is contained in:
YuehuiLei
2020-12-31 16:32:25 +08:00
parent 341f2594f8
commit 596742595f
1 changed files with 2 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
api-ref/source/api-ref-sysinv-v1-config.rst
View File

@@ -1044,7 +1044,7 @@ This operation does not accept a request body.
Creates a partition on a specific disk of a host
**************************************************
.. rest_method:: POST /v1/ihosts/​{host_id}​/partitions
.. rest_method:: POST /v1/partitions
**Normal response codes**
@@ -1060,8 +1060,8 @@ badMediaType (415)
:header: "Parameter", "Style", "Type", "Description"
:widths: 20, 20, 20, 60
"host_id", "URI", "csapi:UUID", "The unique identifier of an existing host."
"ihost_uuid (Optional)", "plain", "csapi:UUID", "This parameter specifies the partition host uuid."
"forihostid (Optional)", "plain", "xsd:string", "The ID of the host of this interface."
"type_guid (Optional)", "plain", "csapi:UUID", "This parameter specifies the partition type guid."
"idisk_uuid (Optional)", "plain", "csapi:UUID", "This parameter specifies the partition disk uuid."
"size_mib (Optional)", "plain", "xsd:integer", "This parameter specifies the size of the partition."