kasakrisz commented on a change in pull request #54: AMBARI-23456. Add mkdocs 
support & markdown skeletons
URL: https://github.com/apache/ambari-logsearch/pull/54#discussion_r239061724
 
 

 ##########
 File path: 
ambari-logsearch-config-json/src/main/java/org/apache/ambari/logsearch/config/json/model/inputconfig/impl/InputConfigImpl.java
 ##########
 @@ -39,15 +39,17 @@
   @ShipperConfigElementDescription(
     path = "/input",
     type = "list of json objects",
-    description = "A list of input descriptions"
+    description = "A list of input descriptions",
+    examples = {"{\"input\" : [ {\"type\": \"myinput_service_type\"}] }"}
   )
   @Expose
   private List<InputDescriptorImpl> input;
 
   @ShipperConfigElementDescription(
     path = "/filter",
     type = "list of json objects",
-    description = "A list of filter descriptions"
+    description = "A list of filter descriptions",
+    examples = {"{\"filter\" : [ {\"filter\": \"json\", \"conditions\": 
{\"fields\": { \"type\": [\"mytype1\", \"mytype2\"]} } } ]}"}
 
 Review comment:
   Same as above (line 43). Giving a concrete example could be useful.
   ```
     "filter":[
       {
         "filter":"json",
         "conditions":{
           "fields":{
             "type":[
               "logsearch_app",
               "logsearch_feeder",
               "logsearch_perf"
             ]
           }
         }
       }
     ]
   
   ```

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org


With regards,
Apache Git Services

Reply via email to