openstack/venus
Code Issues Proposed changes

sort api in index.rst & fix status code & add response json of two apis

Browse Source 
Change-Id: Iba1ed8ab01bb0a148e78beb388bccb3cacd93f1c
This commit is contained in:
inspurericzhang 2022-09-14 04:09:06 +00:00
parent 3720f31587
commit 3be9f638f7
10 changed files with 32 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
api-ref/source/status.yaml
View File

@ -1,7 +1,7 @@
0:
1:
default: |
Request was successful.
1:
0:
default: |
Request was successful, but no data caused by some reasons.
-1:

2
api-ref/source/v1/api-versions.inc
View File

@ -15,7 +15,7 @@ Response codes
.. rest_status_code:: success ../status.yaml
- 0
- 1
.. rest_status_code:: error ../status.yaml

2
api-ref/source/v1/custom-config.inc
View File

@ -18,7 +18,7 @@ Response codes
.. rest_status_code:: success ../status.yaml
- 0
- 1
.. rest_status_code:: error ../status.yaml

4
api-ref/source/v1/index.rst
View File

@ -15,8 +15,8 @@ OpenStack Log API V1 (CURRENT)
.. search log document.
.. include:: search-params.inc
.. include:: search-logs.inc
.. include:: search-analyse-logs.inc
.. include:: search-logs-download.inc
.. include:: search-instance-callchain.inc
.. include:: search-analyse-logs.inc
.. include:: search-typical-logs.inc
.. include:: search-instance-requestids.inc
.. include:: search-instance-callchain.inc

5
api-ref/source/v1/search-analyse-logs.inc
View File

@ -13,16 +13,13 @@ Search host_name, module_name,program_name,level more informations for all Venus
Response codes
--------------
.. rest_status_code:: success ../status.yaml
- 0
.. rest_status_code:: success ../status.yaml
- 1
.. rest_status_code:: error ../status.yaml
- 0
- -1
Response

5
api-ref/source/v1/search-instance-callchain.inc
View File

@ -13,16 +13,13 @@ Search nova-api, nova-conductor, nova-scheduler and nova-compute informations fo
Response codes
--------------
.. rest_status_code:: success ../status.yaml
- 0
.. rest_status_code:: success ../status.yaml
- 1
.. rest_status_code:: error ../status.yaml
- 0
- -1
Response

12
api-ref/source/v1/search-instance-requestids.inc
View File

@ -15,8 +15,18 @@ Response codes
.. rest_status_code:: success ../status.yaml
- 0
- 1
.. rest_status_code:: error ../status.yaml
- 0
- -1
Response
--------
**Example: JSON request**
.. literalinclude:: ./samples/search-log/search-instance-request-ids-show-response.json
:language: javascript

5
api-ref/source/v1/search-logs-download.inc
View File

@ -13,16 +13,13 @@ Download the search logs of all Venus modules.
Response codes
--------------
.. rest_status_code:: success ../status.yaml
- 0
.. rest_status_code:: success ../status.yaml
- 1
.. rest_status_code:: error ../status.yaml
- 0
- -1
Response

5
api-ref/source/v1/search-logs.inc
View File

@ -13,16 +13,13 @@ List host_name, module_name,program_name,level more informations for all Venus m
Response codes
--------------
.. rest_status_code:: success ../status.yaml
- 0
.. rest_status_code:: success ../status.yaml
- 1
.. rest_status_code:: error ../status.yaml
- 0
- -1
Response

12
api-ref/source/v1/search-typical-logs.inc
View File

@ -15,8 +15,18 @@ Response codes
.. rest_status_code:: success ../status.yaml
- 0
- 1
.. rest_status_code:: error ../status.yaml
- 0
- -1
Response
--------
**Example: JSON request**
.. literalinclude:: ./samples/search-log/search-typical-logs-show-response.json
:language: javascript