You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: openapi.yml
+20-17Lines changed: 20 additions & 17 deletions
Original file line number
Diff line number
Diff line change
@@ -2562,6 +2562,10 @@ components:
2562
2562
type: string
2563
2563
description: >
2564
2564
Name of a field in another collection that should be linked to this collection so that it can be joined during query.
2565
+
async_reference:
2566
+
type: boolean
2567
+
description: >
2568
+
Allow documents to be indexed successfully even when the referenced document doesn't exist yet.
2565
2569
num_dim:
2566
2570
type: integer
2567
2571
example: 256
@@ -3287,7 +3291,7 @@ components:
3287
3291
filter_curated_hits:
3288
3292
type: boolean
3289
3293
description: >
3290
-
Whether the filter_by condition of the search query should be applicable to curated results (override definitions, pinned hits, hidden hits, etc.). Default: false
3294
+
Whether the filter_by condition of the search query should be applicable to curated results (curation definitions, pinned hits, hidden hits, etc.). Default: false
3291
3295
enable_synonyms:
3292
3296
type: boolean
3293
3297
description: >
@@ -3310,8 +3314,8 @@ components:
3310
3314
at Position 1 and another record with ID 456 at Position 5,
3311
3315
you'd specify `123:1,456:5`.
3312
3316
3313
-
You could also use the Overrides feature to override search results based
3314
-
on rules. Overrides are applied first, followed by `pinned_hits` and
3317
+
You could also use the Curation feature to override search results based
3318
+
on rules. Curations are applied first, followed by `pinned_hits` and
3315
3319
finally `hidden_hits`.
3316
3320
type: string
3317
3321
@@ -3321,12 +3325,12 @@ components:
3321
3325
A list of `record_id`s to hide. Eg: to hide records with IDs 123 and 456,
3322
3326
you'd specify `123,456`.
3323
3327
3324
-
You could also use the Overrides feature to override search results based
3325
-
on rules. Overrides are applied first, followed by `pinned_hits` and
3328
+
You could also use the Curation feature to override search results based
3329
+
on rules. Curations are applied first, followed by `pinned_hits` and
3326
3330
finally `hidden_hits`.
3327
3331
type: string
3328
3332
3329
-
override_tags:
3333
+
curation_tags:
3330
3334
description: Comma separated list of tags to trigger the curations rules that match the tags.
3331
3335
type: string
3332
3336
@@ -3359,9 +3363,9 @@ components:
3359
3363
the name of the existing Preset.
3360
3364
type: string
3361
3365
3362
-
enable_overrides:
3366
+
enable_curations:
3363
3367
description: >
3364
-
If you have some overrides defined but want to disable all of them during
3368
+
If you have some curation sets defined but want to disable all of them during
3365
3369
query time, you can do that by setting this parameter to false
3366
3370
type: boolean
3367
3371
default: false
@@ -3664,7 +3668,7 @@ components:
3664
3668
filter_curated_hits:
3665
3669
type: boolean
3666
3670
description: >
3667
-
Whether the filter_by condition of the search query should be applicable to curated results (override definitions, pinned hits, hidden hits, etc.). Default: false
3671
+
Whether the filter_by condition of the search query should be applicable to curated results (curation definitions, pinned hits, hidden hits, etc.). Default: false
3668
3672
enable_synonyms:
3669
3673
type: boolean
3670
3674
description: >
@@ -3695,8 +3699,8 @@ components:
3695
3699
at Position 1 and another record with ID 456 at Position 5,
3696
3700
you'd specify `123:1,456:5`.
3697
3701
3698
-
You could also use the Overrides feature to override search results based
3699
-
on rules. Overrides are applied first, followed by `pinned_hits` and
3702
+
You could also use the Curation feature to override search results based
3703
+
on rules. Curations are applied first, followed by `pinned_hits` and
3700
3704
finally `hidden_hits`.
3701
3705
type: string
3702
3706
@@ -3706,12 +3710,12 @@ components:
3706
3710
A list of `record_id`s to hide. Eg: to hide records with IDs 123 and 456,
3707
3711
you'd specify `123,456`.
3708
3712
3709
-
You could also use the Overrides feature to override search results based
3710
-
on rules. Overrides are applied first, followed by `pinned_hits` and
3713
+
You could also use the Curation feature to override search results based
3714
+
on rules. Curations are applied first, followed by `pinned_hits` and
3711
3715
finally `hidden_hits`.
3712
3716
type: string
3713
3717
3714
-
override_tags:
3718
+
curation_tags:
3715
3719
description: Comma separated list of tags to trigger the curations rules that match the tags.
3716
3720
type: string
3717
3721
@@ -3737,9 +3741,9 @@ components:
3737
3741
the name of the existing Preset.
3738
3742
type: string
3739
3743
3740
-
enable_overrides:
3744
+
enable_curations:
3741
3745
description: >
3742
-
If you have some overrides defined but want to disable all of them during
3746
+
If you have some curation sets defined but want to disable all of them during
3743
3747
query time, you can do that by setting this parameter to false
Copy file name to clipboardExpand all lines: preprocessed_openapi.yml
+28-24Lines changed: 28 additions & 24 deletions
Original file line number
Diff line number
Diff line change
@@ -634,7 +634,7 @@ paths:
634
634
schema:
635
635
type: boolean
636
636
description: |
637
-
Whether the filter_by condition of the search query should be applicable to curated results (override definitions, pinned hits, hidden hits, etc.). Default: false
637
+
Whether the filter_by condition of the search query should be applicable to curated results (curation definitions, pinned hits, hidden hits, etc.). Default: false
638
638
- name: enable_synonyms
639
639
in: query
640
640
schema:
@@ -659,15 +659,15 @@ paths:
659
659
type: string
660
660
description: |
661
661
A list of records to unconditionally include in the search results at specific positions. An example use case would be to feature or promote certain items on the top of search results. A list of `record_id:hit_position`. Eg: to include a record with ID 123 at Position 1 and another record with ID 456 at Position 5, you'd specify `123:1,456:5`.
662
-
You could also use the Overrides feature to override search results based on rules. Overrides are applied first, followed by `pinned_hits` and finally `hidden_hits`.
662
+
You could also use the Curation feature to override search results based on rules. Curations are applied first, followed by `pinned_hits` and finally `hidden_hits`.
663
663
- name: hidden_hits
664
664
in: query
665
665
schema:
666
666
type: string
667
667
description: |
668
668
A list of records to unconditionally hide from search results. A list of `record_id`s to hide. Eg: to hide records with IDs 123 and 456, you'd specify `123,456`.
669
-
You could also use the Overrides feature to override search results based on rules. Overrides are applied first, followed by `pinned_hits` and finally `hidden_hits`.
670
-
- name: override_tags
669
+
You could also use the Curation feature to override search results based on rules. Curations are applied first, followed by `pinned_hits` and finally `hidden_hits`.
670
+
- name: curation_tags
671
671
in: query
672
672
schema:
673
673
type: string
@@ -697,13 +697,13 @@ paths:
697
697
type: string
698
698
description: |
699
699
Search using a bunch of search parameters by setting this parameter to the name of the existing Preset.
700
-
- name: enable_overrides
700
+
- name: enable_curations
701
701
in: query
702
702
schema:
703
703
type: boolean
704
704
default: false
705
705
description: |
706
-
If you have some overrides defined but want to disable all of them during query time, you can do that by setting this parameter to false
706
+
If you have some curation sets defined but want to disable all of them during query time, you can do that by setting this parameter to false
707
707
- name: prioritize_exact_match
708
708
in: query
709
709
schema:
@@ -2239,7 +2239,7 @@ paths:
2239
2239
schema:
2240
2240
type: boolean
2241
2241
description: |
2242
-
Whether the filter_by condition of the search query should be applicable to curated results (override definitions, pinned hits, hidden hits, etc.). Default: false
2242
+
Whether the filter_by condition of the search query should be applicable to curated results (curation definitions, pinned hits, hidden hits, etc.). Default: false
2243
2243
- name: enable_synonyms
2244
2244
in: query
2245
2245
schema:
@@ -2271,15 +2271,15 @@ paths:
2271
2271
type: string
2272
2272
description: |
2273
2273
A list of records to unconditionally include in the search results at specific positions. An example use case would be to feature or promote certain items on the top of search results. A list of `record_id:hit_position`. Eg: to include a record with ID 123 at Position 1 and another record with ID 456 at Position 5, you'd specify `123:1,456:5`.
2274
-
You could also use the Overrides feature to override search results based on rules. Overrides are applied first, followed by `pinned_hits` and finally `hidden_hits`.
2274
+
You could also use the Curation feature to override search results based on rules. Curations are applied first, followed by `pinned_hits` and finally `hidden_hits`.
2275
2275
- name: hidden_hits
2276
2276
in: query
2277
2277
schema:
2278
2278
type: string
2279
2279
description: |
2280
2280
A list of records to unconditionally hide from search results. A list of `record_id`s to hide. Eg: to hide records with IDs 123 and 456, you'd specify `123,456`.
2281
-
You could also use the Overrides feature to override search results based on rules. Overrides are applied first, followed by `pinned_hits` and finally `hidden_hits`.
2282
-
- name: override_tags
2281
+
You could also use the Curation feature to override search results based on rules. Curations are applied first, followed by `pinned_hits` and finally `hidden_hits`.
2282
+
- name: curation_tags
2283
2283
in: query
2284
2284
schema:
2285
2285
type: string
@@ -2304,13 +2304,13 @@ paths:
2304
2304
type: string
2305
2305
description: |
2306
2306
Search using a bunch of search parameters by setting this parameter to the name of the existing Preset.
2307
-
- name: enable_overrides
2307
+
- name: enable_curations
2308
2308
in: query
2309
2309
schema:
2310
2310
type: boolean
2311
2311
default: false
2312
2312
description: |
2313
-
If you have some overrides defined but want to disable all of them during query time, you can do that by setting this parameter to false
2313
+
If you have some curation sets defined but want to disable all of them during query time, you can do that by setting this parameter to false
2314
2314
- name: prioritize_exact_match
2315
2315
in: query
2316
2316
schema:
@@ -3353,6 +3353,10 @@ components:
3353
3353
type: string
3354
3354
description: |
3355
3355
Name of a field in another collection that should be linked to this collection so that it can be joined during query.
3356
+
async_reference:
3357
+
type: boolean
3358
+
description: |
3359
+
Allow documents to be indexed successfully even when the referenced document doesn't exist yet.
3356
3360
num_dim:
3357
3361
type: integer
3358
3362
example: 256
@@ -3988,7 +3992,7 @@ components:
3988
3992
filter_curated_hits:
3989
3993
type: boolean
3990
3994
description: |
3991
-
Whether the filter_by condition of the search query should be applicable to curated results (override definitions, pinned hits, hidden hits, etc.). Default: false
3995
+
Whether the filter_by condition of the search query should be applicable to curated results (curation definitions, pinned hits, hidden hits, etc.). Default: false
3992
3996
enable_synonyms:
3993
3997
type: boolean
3994
3998
description: |
@@ -4005,13 +4009,13 @@ components:
4005
4009
type: string
4006
4010
description: |
4007
4011
A list of records to unconditionally include in the search results at specific positions. An example use case would be to feature or promote certain items on the top of search results. A list of `record_id:hit_position`. Eg: to include a record with ID 123 at Position 1 and another record with ID 456 at Position 5, you'd specify `123:1,456:5`.
4008
-
You could also use the Overrides feature to override search results based on rules. Overrides are applied first, followed by `pinned_hits` and finally `hidden_hits`.
4012
+
You could also use the Curation feature to override search results based on rules. Curations are applied first, followed by `pinned_hits` and finally `hidden_hits`.
4009
4013
hidden_hits:
4010
4014
type: string
4011
4015
description: |
4012
4016
A list of records to unconditionally hide from search results. A list of `record_id`s to hide. Eg: to hide records with IDs 123 and 456, you'd specify `123,456`.
4013
-
You could also use the Overrides feature to override search results based on rules. Overrides are applied first, followed by `pinned_hits` and finally `hidden_hits`.
4014
-
override_tags:
4017
+
You could also use the Curation feature to override search results based on rules. Curations are applied first, followed by `pinned_hits` and finally `hidden_hits`.
4018
+
curation_tags:
4015
4019
type: string
4016
4020
description: Comma separated list of tags to trigger the curations rules that match the tags.
4017
4021
highlight_fields:
@@ -4031,11 +4035,11 @@ components:
4031
4035
type: string
4032
4036
description: |
4033
4037
Search using a bunch of search parameters by setting this parameter to the name of the existing Preset.
4034
-
enable_overrides:
4038
+
enable_curations:
4035
4039
type: boolean
4036
4040
default: false
4037
4041
description: |
4038
-
If you have some overrides defined but want to disable all of them during query time, you can do that by setting this parameter to false
4042
+
If you have some curation sets defined but want to disable all of them during query time, you can do that by setting this parameter to false
4039
4043
prioritize_exact_match:
4040
4044
type: boolean
4041
4045
default: true
@@ -4241,7 +4245,7 @@ components:
4241
4245
filter_curated_hits:
4242
4246
type: boolean
4243
4247
description: |
4244
-
Whether the filter_by condition of the search query should be applicable to curated results (override definitions, pinned hits, hidden hits, etc.). Default: false
4248
+
Whether the filter_by condition of the search query should be applicable to curated results (curation definitions, pinned hits, hidden hits, etc.). Default: false
4245
4249
enable_synonyms:
4246
4250
type: boolean
4247
4251
description: |
@@ -4263,13 +4267,13 @@ components:
4263
4267
type: string
4264
4268
description: |
4265
4269
A list of records to unconditionally include in the search results at specific positions. An example use case would be to feature or promote certain items on the top of search results. A list of `record_id:hit_position`. Eg: to include a record with ID 123 at Position 1 and another record with ID 456 at Position 5, you'd specify `123:1,456:5`.
4266
-
You could also use the Overrides feature to override search results based on rules. Overrides are applied first, followed by `pinned_hits` and finally `hidden_hits`.
4270
+
You could also use the Curation feature to override search results based on rules. Curations are applied first, followed by `pinned_hits` and finally `hidden_hits`.
4267
4271
hidden_hits:
4268
4272
type: string
4269
4273
description: |
4270
4274
A list of records to unconditionally hide from search results. A list of `record_id`s to hide. Eg: to hide records with IDs 123 and 456, you'd specify `123,456`.
4271
-
You could also use the Overrides feature to override search results based on rules. Overrides are applied first, followed by `pinned_hits` and finally `hidden_hits`.
4272
-
override_tags:
4275
+
You could also use the Curation feature to override search results based on rules. Curations are applied first, followed by `pinned_hits` and finally `hidden_hits`.
4276
+
curation_tags:
4273
4277
type: string
4274
4278
description: Comma separated list of tags to trigger the curations rules that match the tags.
4275
4279
highlight_fields:
@@ -4286,11 +4290,11 @@ components:
4286
4290
type: string
4287
4291
description: |
4288
4292
Search using a bunch of search parameters by setting this parameter to the name of the existing Preset.
4289
-
enable_overrides:
4293
+
enable_curations:
4290
4294
type: boolean
4291
4295
default: false
4292
4296
description: |
4293
-
If you have some overrides defined but want to disable all of them during query time, you can do that by setting this parameter to false
4297
+
If you have some curation sets defined but want to disable all of them during query time, you can do that by setting this parameter to false
0 commit comments