Merge "add search params api inc file and parameters"

api-ref/source/v1/parameters.yaml

@@ -1 +1,23 @@
-ADD INPUT PARAMETERS HERE
+# variables in header
+
+# variables in path
+
+# variables in query
+param_type:
+  description: |
+    the type of parameter, such as host_name, level, program_name, module_name
+  in: query
+  required: true
+  type: string
+module_name:
+  description: |
+    the module name.
+  in: query
+  required: false
+  type: string
+index_type:
+  description: |
+    the type of elasticsearch index, flog:Openstack log, slog:the host OS log
+  in: query
+  required: false
+  type: string

api-ref/source/v1/search-params.inc

@@ -0,0 +1,40 @@
+.. -*- rst -*-
+
+Search Params
+=============
+
+Get Search Params
+~~~~~~~~~~~~~~~~~
+
+.. rest_method:: GET /v1/search/params
+
+Get the value list of one search parameter.
+
+Response codes
+--------------
+
+.. rest_status_code:: success ../status.yaml
+
+   - 0
+
+.. rest_status_code:: error ../status.yaml
+
+   - -1
+
+Request
+-------
+
+.. rest_parameters:: parameters.yaml
+
+   - type: param_type
+   - module_name: module_name
+   - index_type: index_type
+
+Response
+--------
+
+**Example: JSON request**
+
+
+.. literalinclude:: ./samples/search-log/search-params-show-response.json.json
+   :language: javascript