Socorro/ElasticSearch API: Difference between revisions

Socorro/ElasticSearch API (view source)

Revision as of 17:34, 20 May 2011

185 bytes removed , 20 May 2011

→‎API Spec: All parameters are now optional except the first.

Adrigau

Confirmed users

245

edits

@@ Line 57: / Line 57: @@
 HTTP request: '''GET'''<br>
-URI: '''/search/(''types'')/for/(''terms'')/product/(''product'')/from/(''from_date'')/to/(''to_date'')/(''optional_parameters'')'''
+URI: '''/search/(''types'')/(''optional_parameters'')'''
 * <tt>types</tt>: Type of data we are looking into. Can be set to <tt>_all</tt> to search into all types. Several types can be specified, separated by a + symbol.
-* <tt>terms</tt>: Terms we are search for. Each term must be URL encoded. Several terms can be specified, separated by a + symbol.
-* <tt>product</tt>: The product we are interested in. (e.g. Firefox, Fennec, Thunderbird... )
-* <tt>from_date</tt>: Search for crashes that happened after this date.
-* <tt>to_date</tt>: Search for crashes that happened before this date.
-<u>'''Order:'''</u>
-Parameters, except for the first one (search/(type)/), can be set in any order. Optional and mandatory parameters can be mixed. (See the example below. )
 <u>'''Optional parameters:'''</u>
-This request has some optional parameters that can be omitted. Any omitted parameter has a default value or is not used while querying ES. You can use only some of those parameters or all of them.
+Except for the first one, every parameter can be omitted. Any omitted parameter has a default value or is not used while querying ES. You can use only some of those parameters or all of them. The order of parameters doesn't matter except for the first one (types).
 The complete URI is as follow:
-/search/(''types'')/for/(''terms'')/product/(''product'')/from/(''from_date'')/to/(''to_date'')/'''in/(''fields'')/version/(''version'')/os/(''os_name'')/branches/(''branches'')/search_mode/(''search_mode'')/reason/(''crash_reason'')/build/(''build_id'')/report_process/(''report_process'')/report_type/(''report_type'')/plugin_in/(''plugin_in'')/plugin_search_mode/(''plugin_search_mode'')/plugin_term/(''plugin_term'')'''
+/search/(''types'')/'''for/(''terms'')/product/(''product'')/from/(''from_date'')/to/(''to_date'')/in/(''fields'')/version/(''version'')/os/(''os_name'')/branches/(''branches'')/search_mode/(''search_mode'')/reason/(''crash_reason'')/build/(''build_id'')/report_process/(''report_process'')/report_type/(''report_type'')/plugin_in/(''plugin_in'')/plugin_search_mode/(''plugin_search_mode'')/plugin_term/(''plugin_term'')'''
+* <tt>terms</tt>: Terms we are search for. Each term must be URL encoded. Several terms can be specified, separated by a + symbol.
+* <tt>product</tt>: The product we are interested in. (e.g. Firefox, Fennec, Thunderbird... )
+* <tt>from_date</tt>: Search for crashes that happened after this date.
+* <tt>to_date</tt>: Search for crashes that happened before this date.
 * <tt>fields</tt>: Fields we are searching in. Several fields can be specified, separated by a + symbol. Default value is search in all fields.
 * <tt>version</tt>: Version of the product. Can be set to <tt>_all</tt> to search into all versions. Default value is search in all versions.
@@ Line 87: / Line 83: @@
 * <tt>plugin_in</tt>: Search for a plugin in this field. <tt>report_process</tt> has to be set to <tt>plugin</tt>. Default value is empty.
 * <tt>plugin_search_mode</tt>: How to search for this plugin. <tt>report_process</tt> has to be set to <tt>plugin</tt>. Default value is empty.
 * <tt>plugin_term</tt>: Terms to search for. Several terms can be specified, separated by a + symbol. <tt>report_process</tt> has to be set to <tt>plugin</tt>. Default value is empty.
 === Return value ===