From 5aff51da23fe816ed1d7d4949664e69d98106b2a Mon Sep 17 00:00:00 2001 From: inspurericzhang Date: Mon, 12 Sep 2022 09:20:15 +0000 Subject: [PATCH] add search param in index.rst & fix json file name & sore params Change-Id: Ic22fccab511e49995386208232cf4975e25c1f78 --- api-ref/source/v1/index.rst | 3 +++ api-ref/source/v1/parameters.yaml | 12 ++++++------ api-ref/source/v1/search-params.inc | 2 +- 3 files changed, 10 insertions(+), 7 deletions(-) diff --git a/api-ref/source/v1/index.rst b/api-ref/source/v1/index.rst index e74d703..40b4de3 100644 --- a/api-ref/source/v1/index.rst +++ b/api-ref/source/v1/index.rst @@ -12,4 +12,7 @@ OpenStack Log API V1 (CURRENT) .. custom config document. .. include:: custom-config.inc +.. search log document. +.. include:: search-params.inc + diff --git a/api-ref/source/v1/parameters.yaml b/api-ref/source/v1/parameters.yaml index 9dd01a2..e57c43d 100644 --- a/api-ref/source/v1/parameters.yaml +++ b/api-ref/source/v1/parameters.yaml @@ -3,11 +3,11 @@ # variables in path # variables in query -param_type: +index_type: description: | - the type of parameter, such as host_name, level, program_name, module_name + the type of elasticsearch index, flog:Openstack log, slog:the host OS log in: query - required: true + required: false type: string module_name: description: | @@ -15,9 +15,9 @@ module_name: in: query required: false type: string -index_type: +param_type: description: | - the type of elasticsearch index, flog:Openstack log, slog:the host OS log + the type of parameter, such as host_name, level, program_name, module_name in: query - required: false + required: true type: string diff --git a/api-ref/source/v1/search-params.inc b/api-ref/source/v1/search-params.inc index 01b3d0f..1e6f48d 100644 --- a/api-ref/source/v1/search-params.inc +++ b/api-ref/source/v1/search-params.inc @@ -36,5 +36,5 @@ Response **Example: JSON request** -.. literalinclude:: ./samples/search-log/search-params-show-response.json.json +.. literalinclude:: ./samples/search-log/search-params-show-response.json :language: javascript