Skip to content

Commit e515478

Browse files
committed
fix: no autoformat for real
1 parent 1744717 commit e515478

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

specs/common/schemas/SearchParams.yml

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,22 +2,26 @@ searchParams:
22
oneOf:
33
- $ref: '#/searchParamsString'
44
- $ref: '#/searchParamsObject'
5+
56
searchParamsObject:
67
title: Search parameters as object
78
description: Each parameter value, including the `query` must not be larger than 512 bytes.
89
allOf:
910
- $ref: '#/baseSearchParams'
1011
- $ref: '../../common/schemas/IndexSettings.yml#/indexSettingsAsSearchParams'
12+
1113
baseSearchParams:
1214
allOf:
1315
- $ref: '#/searchParamsQuery'
1416
- $ref: '#/baseSearchParamsWithoutQuery'
17+
1518
searchParamsQuery:
1619
type: object
1720
additionalProperties: false
1821
properties:
1922
query:
2023
$ref: '#/query'
24+
2125
baseSearchParamsWithoutQuery:
2226
type: object
2327
additionalProperties: false
@@ -214,6 +218,7 @@ baseSearchParamsWithoutQuery:
214218
default: true
215219
x-categories:
216220
- Advanced
221+
217222
searchParamsString:
218223
type: object
219224
title: Search parameters as query string.
@@ -224,11 +229,13 @@ searchParamsString:
224229
properties:
225230
params:
226231
$ref: '#/paramsAsString'
232+
227233
paramsAsString:
228234
description: Search parameters as a URL-encoded query string.
229235
example: 'hitsPerPage=2&getRankingInfo=1'
230236
type: string
231237
default: ''
238+
232239
userToken:
233240
type: string
234241
description: |
@@ -239,19 +246,22 @@ userToken:
239246
example: test-user-123
240247
x-categories:
241248
- Personalization
249+
242250
query:
243251
type: string
244252
description: Search query.
245253
default: ''
246254
x-categories:
247255
- Search
256+
248257
page:
249258
type: integer
250259
description: Page of search results to retrieve.
251260
default: 0
252261
minimum: 0
253262
x-categories:
254263
- Pagination
264+
255265
aroundRadius:
256266
description: |
257267
Maximum radius for a search around a central location.
@@ -266,6 +276,7 @@ aroundRadius:
266276
- $ref: '#/aroundRadiusAll'
267277
x-categories:
268278
- Geo-Search
279+
269280
aroundPrecision:
270281
description: |
271282
Precision of a coordinate-based search in meters to group results with similar distances.
@@ -282,6 +293,7 @@ aroundPrecision:
282293
- $ref: '#/aroundPrecisionFromValue'
283294
x-categories:
284295
- Geo-Search
296+
285297
aroundPrecisionFromValue:
286298
title: range objects
287299
type: array
@@ -297,11 +309,13 @@ aroundPrecisionFromValue:
297309
value:
298310
type: integer
299311
description: Upper boundary of a range in meters. The Geo ranking criterion considers all records within the range to be equal.
312+
300313
aroundRadiusAll:
301314
title: all
302315
type: string
303316
description: Return all records with a valid `_geoloc` attribute. Don't filter by distance.
304317
enum: [all]
318+
305319
aroundLatLng:
306320
type: string
307321
description: |
@@ -314,17 +328,20 @@ aroundLatLng:
314328
default: ''
315329
x-categories:
316330
- Geo-Search
331+
317332
aroundLatLngViaIP:
318333
type: boolean
319334
description: Whether to obtain the coordinates from the request's IP address.
320335
default: false
321336
x-categories:
322337
- Geo-Search
338+
323339
insideBoundingBox:
324340
oneOf:
325341
- type: string
326342
- type: 'null'
327343
- $ref: '#/insideBoundingBoxArray'
344+
328345
insideBoundingBoxArray:
329346
type: array
330347
items:
@@ -346,6 +363,7 @@ insideBoundingBoxArray:
346363
- [40.9234, 2.1185, 38.6430, 1.9916]
347364
x-categories:
348365
- Geo-Search
366+
349367
insidePolygon:
350368
type: array
351369
items:
@@ -367,6 +385,7 @@ insidePolygon:
367385
- [40.9234, 2.1185, 38.6430, 1.9916, 39.2587, 2.0104]
368386
x-categories:
369387
- Geo-Search
388+
370389
filters:
371390
type: string
372391
description: |
@@ -396,6 +415,7 @@ filters:
396415
example: '(category:Book OR category:Ebook) AND _tags:published'
397416
x-categories:
398417
- Filtering
418+
399419
facetFilters:
400420
description: |
401421
Filter the search by facet values, so that only records with the same facet values are retrieved.
@@ -416,6 +436,7 @@ facetFilters:
416436
- type: string
417437
x-categories:
418438
- Filtering
439+
419440
tagFilters:
420441
description: |
421442
Filter the search by values of the special `_tags` attribute.
@@ -433,6 +454,7 @@ tagFilters:
433454
- type: string
434455
x-categories:
435456
- Filtering
457+
436458
numericFilters:
437459
description: |
438460
Filter by numeric facets.
@@ -451,6 +473,7 @@ numericFilters:
451473
- type: string
452474
x-categories:
453475
- Filtering
476+
454477
optionalFilters:
455478
description: |
456479
Filters to promote or demote records in the search results.
@@ -463,6 +486,7 @@ optionalFilters:
463486
- Optional filters are applied _after_ sort-by attributes.
464487
- Optional filters are applied _before_ custom ranking attributes (in the default [ranking](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/)).
465488
- Optional filters don't work with numeric attributes.
489+
466490
example: ['category:Book', 'author:John Doe']
467491
oneOf:
468492
- type: array

0 commit comments

Comments
 (0)