Unify interface description

Change-Id: I70662a6a4873539a6229d3b53ae04da8b04fd733
This commit is contained in:
howardlee 2023-08-22 10:51:12 +08:00
parent 3797372740
commit 14928a697d
4 changed files with 8 additions and 8 deletions

View File

@ -6,7 +6,7 @@ Anomaly Detect
Users can add, delete, modify and query anomaly rules, query and delete anomaly records. Users can add, delete, modify and query anomaly rules, query and delete anomaly records.
Get Anomaly Rule Get anomaly rule
~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~
.. rest_method:: GET /v1/anomaly/rule/{id} .. rest_method:: GET /v1/anomaly/rule/{id}
@ -41,7 +41,7 @@ Response
:language: javascript :language: javascript
Update Anomaly Rule Update anomaly rule
~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~
.. rest_method:: POST /v1/anomaly/rule/{id} .. rest_method:: POST /v1/anomaly/rule/{id}

View File

@ -1,9 +1,9 @@
.. -*- rst -*- .. -*- rst -*-
API versions API Versions
============ ============
List Api Versions List api versions
~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~
.. rest_method:: GET / .. rest_method:: GET /

View File

@ -5,7 +5,7 @@ Custom Config
Users can customize some important configurations, such as the retention days of ElasticSearch index. Users can customize some important configurations, such as the retention days of ElasticSearch index.
Get Custom Config Get custom config
~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~
.. rest_method:: GET /v1/custom_config .. rest_method:: GET /v1/custom_config
@ -33,7 +33,7 @@ Response
:language: javascript :language: javascript
Set Custom Config Set custom config
~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~
.. rest_method:: POST /v1/custom_config .. rest_method:: POST /v1/custom_config

View File

@ -5,7 +5,7 @@ Search API
Users can search, download and analyze logs, instance callchain. Users can search, download and analyze logs, instance callchain.
Get Search Params Get search params
~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~
.. rest_method:: GET /v1/search/params .. rest_method:: GET /v1/search/params
@ -91,7 +91,7 @@ Response
.. -*- rst -*- .. -*- rst -*-
Download Logs Download logs
~~~~~~~~~~~~~ ~~~~~~~~~~~~~
.. rest_method:: GET /v1/search/logs/download .. rest_method:: GET /v1/search/logs/download