starlingx/config
Code Issues Proposed changes

API documentation error for Ceph Storage Functions

Browse Source 
An error occurred when using the Ceph Storage Functions part
of the API documentation (POST  /v1/ihosts/​{host_id}​/istors).
After analyzing the code, I found that the URLs set
 in the code are /v1/istors.
This is inconsistent with the API documentation,
so update the partitions
section of the API documentation.
And I found that the request parameters are mandatory
rather than optional.

Closes-Bug: #1897252
Change-Id: I672735a9d1fa30894dfc0a9b2c12888a1e6b6271
Signed-off-by: YuehuiLei<leiyuehui@inspur.com>
This commit is contained in:
YuehuiLei 2020-12-31 17:24:39 +08:00
parent 341f2594f8
commit 4674064471
1 changed files with 4 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -2137,7 +2137,7 @@ This operation does not accept a request body.
Creates a Ceph storage function on a specific host
****************************************************
.. rest_method:: POST /v1/ihosts/​{host_id}​/istors
.. rest_method:: POST /v1/istors
PREREQUISITES: A 'ceph' storage backend must be configured in the
system. If multiple storage tiers are defined then a tier_uuid must be
@ -2157,10 +2157,9 @@ badMediaType (415)
:header: "Parameter", "Style", "Type", "Description"
:widths: 20, 20, 20, 60
"host_id", "URI", "csapi:UUID", "The unique identifier of an existing host."
"function (Optional)", "plain", "xsd:string", "This parameter specifies the Ceph storage function. Valid values are (is): ``osd`` or ``journal``."
"ihost_uuid (Optional)", "plain", "csapi:UUID", "This parameter specifies the storage host uuid."
"idisk_uuid (Optional)", "plain", "csapi:UUID", "This parameter specifies the storage disk uuid."
"function", "plain", "xsd:string", "This parameter specifies the Ceph storage function. Valid values are (is): ``osd`` or ``journal``."
"ihost_uuid", "plain", "csapi:UUID", "This parameter specifies the storage host uuid."
"idisk_uuid", "plain", "csapi:UUID", "This parameter specifies the storage disk uuid."
"journal_location (Optional)", "plain", "csapi:UUID", "This parameter specifies the uuid of the journal stor on which the stor's journal will reside. Needed only for ""osd"" functions."
"journal_size_mib (Optional)", "plain", "xsd:integer", "This parameter specifies the size of the journal. Needed only for ""osd"" functions."