fix(specs): analytics paths and params (#73)

Author: shortcuts

clients/algoliasearch-client-javascript/client-analytics/src/analyticsApi.ts

@@ -7,14 +7,6 @@ Attribute:
   schema:
     type: string
 
-Search:
-  in: path
-  name: search
-  description: The query term. Must match the exact user input.
-  required: true
-  schema:
-    type: string
-
 # query
 OrderBy:
   in: query
@@ -50,11 +42,10 @@ Limit:
     type: integer
     default: 10
 
-SearchInQuery:
-  in: path
+Search:
+  in: query
   name: search
-  description: The query term. Must match the exact user input.
-  required: true
+  description: The query term to search for. Must match the exact user input.
   schema:
     type: string
 

specs/analytics/paths/common/parameters.yml

@@ -6,6 +6,7 @@ get:
   summary: Returns top filter attributes.
   parameters:
     - $ref: '../../../common/parameters.yml#/Index'
+    - $ref: '../common/parameters.yml#/Search'
     - $ref: '../../../common/parameters.yml#/StartDate'
     - $ref: '../../../common/parameters.yml#/EndDate'
     - $ref: '../common/parameters.yml#/Limit'

specs/analytics/paths/search/getSearchAttributesTopFilters.yml

@@ -7,6 +7,7 @@ get:
   parameters:
     - $ref: '../common/parameters.yml#/Attribute'
     - $ref: '../../../common/parameters.yml#/Index'
+    - $ref: '../common/parameters.yml#/Search'
     - $ref: '../../../common/parameters.yml#/StartDate'
     - $ref: '../../../common/parameters.yml#/EndDate'
     - $ref: '../common/parameters.yml#/Limit'

specs/analytics/paths/search/getTopFilterAttributes.yml

@@ -6,6 +6,7 @@ get:
   summary: Returns top filters with no results.
   parameters:
     - $ref: '../../../common/parameters.yml#/Index'
+    - $ref: '../common/parameters.yml#/Search'
     - $ref: '../../../common/parameters.yml#/StartDate'
     - $ref: '../../../common/parameters.yml#/EndDate'
     - $ref: '../common/parameters.yml#/Limit'

specs/analytics/paths/search/getTopFilterAttributesForSearch.yml

@@ -6,6 +6,7 @@ get:
   summary: Returns top hits.
   parameters:
     - $ref: '../../../common/parameters.yml#/Index'
+    - $ref: '../common/parameters.yml#/Search'
     - $ref: '../common/parameters.yml#/ClickAnalytics'
     - $ref: '../../../common/parameters.yml#/StartDate'
     - $ref: '../../../common/parameters.yml#/EndDate'

specs/analytics/paths/search/getTopFilterForAttribute.yml

@@ -30,22 +30,14 @@ paths:
     $ref: paths/search/getNoClickRate.yml
   /2/hits:
     $ref: paths/search/getTopHits.yml
-  /2/hits?search={search}:
-    $ref: paths/search/getTopHitsForSearch.yml
   /2/users/count:
     $ref: paths/search/getUsersCount.yml
   /2/filters:
     $ref: paths/search/getTopFilterAttributes.yml
   /2/filters/{attribute}:
     $ref: paths/search/getTopFilterForAttribute.yml
-  /2/filters?search={search}:
-    $ref: paths/search/getTopFilterAttributesForSearch.yml
   /2/filters/noResults:
     $ref: paths/search/getTopFiltersNoResults.yml
-  /2/filters/noResults?search={search}:
-    $ref: paths/search/getTopFiltersNoResultsForSearch.yml
-  /2/filters/{attributes}?search={search}:
-    $ref: paths/search/getTopFiltersForAttributesSearch.yml
   /2/countries:
     $ref: paths/search/getTopCountries.yml
 

specs/analytics/paths/search/getTopFiltersForAttributesSearch.yml

@@ -32,15 +32,17 @@ StartDate:
   description: The lower bound timestamp (a date, a string like "2006-01-02") of the period to analyze.
   schema:
     type: string
-    format: date-time
+    example: 1999-09-19
+    pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])$
 
 EndDate:
   in: query
   name: endDate
   description: The upper bound timestamp (a date, a string like "2006-01-02") of the period to analyze.
   schema:
     type: string
-    format: date-time
+    example: 2000-01-21
+    pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])$
 
 ForwardToReplicas:
   in: query

specs/analytics/paths/search/getTopFiltersNoResults.yml

@@ -15,6 +15,7 @@
     "testName": "get getTopFilterAttributes with all parameters",
     "parameters": {
       "index": "index",
+      "search": "mySearch",
       "startDate": "1999-09-19",
       "endDate": "2001-01-01",
       "limit": 21,
@@ -26,6 +27,7 @@
       "method": "GET",
       "searchParams": {
         "index": "index",
+        "search": "mySearch",
         "startDate": "1999-09-19",
         "endDate": "2001-01-01",
         "limit": "21",