starlingx
/
config
Code Issues Proposed changes

Update API documentation 

An error occurred when using the profile part of the API documentation
(/v1/iprofiles and /v1/iprofiles/{profile_id}). After analyzing the code,
I found that the URLs set in the code are /v1/profile and
/v1/iprofile/{profile_id}. This is inconsistent with the API documentation,
so update the profile section of the API documentation.

Closes-Bug: #1887209

Change-Id: Id1222178ad0364ff712121566481448e873c5245
Signed-off-by: Xinxin Shen <shenxinxin@inspur.com>
This commit is contained in:
XinxinShen 2020-07-10 17:51:23 +08:00
parent 36f23cb2e0
commit 9c80bd9dfa
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -3598,7 +3598,7 @@ profiles.
Lists all profiles
********************
.. rest_method:: GET /v1/iprofiles
.. rest_method:: GET /v1/iprofile
**Normal response codes**
@ -3703,7 +3703,7 @@ This operation does not accept a request body.
Shows information about a specific profile
********************************************
.. rest_method:: GET /v1/iprofiles/​{profile_id}​
.. rest_method:: GET /v1/iprofile/​{profile_id}​
**Normal response codes**
@ -3858,7 +3858,7 @@ This operation does not accept a request body.
Creates a profile
*******************
.. rest_method:: POST /v1/iprofiles
.. rest_method:: POST /v1/iprofile
**Normal response codes**
@ -4020,7 +4020,7 @@ badMediaType (415)
Deletes a specific profile
****************************
.. rest_method:: DELETE /v1/iprofiles/​{profile_id}​
.. rest_method:: DELETE /v1/iprofile/​{profile_id}​
**Normal response codes**