forked from opensearch-project/opensearch-api-specification
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathindices._common.yaml
1018 lines (1018 loc) · 33.6 KB
/
indices._common.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.1.0
info:
title: Schemas of indices._common category
description: Schemas of indices._common category
version: 1.0.0
paths: {}
components:
schemas:
IndexSettings:
type: object
description: The index settings to be updated.
properties:
index:
$ref: '#/components/schemas/IndexSettings'
mode:
type: string
routing_path:
oneOf:
- type: string
- type: array
items:
type: string
soft_deletes:
$ref: '#/components/schemas/SoftDeletes'
soft_deletes.retention_lease.period:
$ref: '_common.yaml#/components/schemas/Duration'
sort:
$ref: '#/components/schemas/IndexSegmentSort'
number_of_shards:
oneOf:
- type: integer
- type: string
number_of_replicas:
oneOf:
- type: integer
- type: string
number_of_routing_shards:
type: integer
check_on_startup:
$ref: '#/components/schemas/IndexCheckOnStartup'
codec:
type: string
routing_partition_size:
$ref: '_common.yaml#/components/schemas/Stringifiedinteger'
load_fixed_bitset_filters_eagerly:
type: boolean
hidden:
$ref: '_common.yaml#/components/schemas/Stringifiedboolean'
auto_expand_replicas:
type: string
merge:
$ref: '#/components/schemas/IndexSettingsMerge'
merge.scheduler.max_thread_count:
$ref: '_common.yaml#/components/schemas/Stringifiedinteger'
search:
$ref: '#/components/schemas/IndexSettingsSearch'
search.idle.after:
$ref: '_common.yaml#/components/schemas/Duration'
refresh_interval:
$ref: '_common.yaml#/components/schemas/Duration'
max_result_window:
type: integer
max_inner_result_window:
type: integer
max_rescore_window:
type: integer
max_docvalue_fields_search:
type: integer
max_script_fields:
type: integer
max_ngram_diff:
type: integer
max_shingle_diff:
type: integer
blocks:
$ref: '#/components/schemas/IndexSettingBlocks'
blocks.read_only:
$ref: '_common.yaml#/components/schemas/Stringifiedboolean'
blocks.read_only_allow_delete:
$ref: '_common.yaml#/components/schemas/Stringifiedboolean'
blocks.read:
$ref: '_common.yaml#/components/schemas/Stringifiedboolean'
blocks.write:
$ref: '_common.yaml#/components/schemas/Stringifiedboolean'
blocks.metadata:
$ref: '_common.yaml#/components/schemas/Stringifiedboolean'
max_refresh_listeners:
type: integer
analyze:
$ref: '#/components/schemas/IndexSettingsAnalyze'
analyze.max_token_count:
$ref: '_common.yaml#/components/schemas/Stringifiedinteger'
highlight:
$ref: '#/components/schemas/IndexSettingsHighlight'
highlight.max_analyzed_offset:
type: integer
max_terms_count:
type: integer
max_regex_length:
type: integer
routing:
$ref: '#/components/schemas/IndexRouting'
gc_deletes:
$ref: '_common.yaml#/components/schemas/Duration'
default_pipeline:
$ref: '_common.yaml#/components/schemas/PipelineName'
final_pipeline:
$ref: '_common.yaml#/components/schemas/PipelineName'
lifecycle:
$ref: '#/components/schemas/IndexSettingsLifecycle'
lifecycle.name:
$ref: '_common.yaml#/components/schemas/Name'
provided_name:
$ref: '_common.yaml#/components/schemas/Name'
creation_date:
$ref: '_common.yaml#/components/schemas/StringifiedEpochTimeUnitMillis'
creation_date_string:
$ref: '_common.yaml#/components/schemas/DateTime'
uuid:
$ref: '_common.yaml#/components/schemas/Uuid'
version:
$ref: '#/components/schemas/IndexVersioning'
verified_before_close:
$ref: '_common.yaml#/components/schemas/Stringifiedboolean'
format:
oneOf:
- type: string
- type: number
max_slices_per_scroll:
type: integer
translog:
$ref: '#/components/schemas/Translog'
translog.durability:
$ref: '#/components/schemas/TranslogDurability'
translog.flush_threshold_size:
$ref: '_common.yaml#/components/schemas/HumanReadableByteCount'
query_string:
$ref: '#/components/schemas/IndexSettingsQueryString'
query_string.lenient:
$ref: '_common.yaml#/components/schemas/Stringifiedboolean'
priority:
oneOf:
- type: number
- type: string
top_metrics_max_size:
type: integer
analysis:
$ref: '#/components/schemas/IndexSettingsAnalysis'
settings:
$ref: '#/components/schemas/IndexSettings'
time_series:
$ref: '#/components/schemas/IndexSettingsTimeSeries'
queries:
$ref: '#/components/schemas/IndexSettingsQueries'
similarity:
$ref: '#/components/schemas/IndexSettingsSimilarity'
mapping:
$ref: '#/components/schemas/IndexSettingsMapping'
indexing:
$ref: '#/components/schemas/IndexSettingsIndexing'
indexing_pressure:
$ref: '#/components/schemas/IndexingPressure'
store:
$ref: '#/components/schemas/IndexSettingsStore'
knn:
type: boolean
knn.algo_param.ef_search:
type: integer
additionalProperties:
title: custom_settings
IndexSettingsIndexing:
type: object
properties:
slowlog:
$ref: '#/components/schemas/IndexingSlowlog'
SoftDeletes:
type: object
properties:
enabled:
description: Indicates whether soft deletes are enabled on the index.
type: boolean
retention_lease:
$ref: '#/components/schemas/RetentionLease'
RetentionLease:
type: object
properties:
period:
$ref: '_common.yaml#/components/schemas/Duration'
required:
- period
IndexSegmentSort:
type: object
properties:
field:
$ref: '_common.yaml#/components/schemas/Fields'
order:
oneOf:
- $ref: '#/components/schemas/SegmentSortOrder'
- type: array
items:
$ref: '#/components/schemas/SegmentSortOrder'
mode:
oneOf:
- $ref: '#/components/schemas/SegmentSortMode'
- type: array
items:
$ref: '#/components/schemas/SegmentSortMode'
missing:
oneOf:
- $ref: '#/components/schemas/SegmentSortMissing'
- type: array
items:
$ref: '#/components/schemas/SegmentSortMissing'
SegmentSortOrder:
type: string
enum:
- asc
- desc
SegmentSortMode:
type: string
enum:
- max
- min
SegmentSortMissing:
type: string
enum:
- _first
- _last
IndexCheckOnStartup:
type: string
enum:
- checksum
- 'false'
- 'true'
IndexSettingsMerge:
type: object
properties:
scheduler:
$ref: '#/components/schemas/IndexSettingsMergeScheduler'
IndexSettingsMergeScheduler:
type: object
properties:
max_thread_count:
$ref: '_common.yaml#/components/schemas/Stringifiedinteger'
max_merge_count:
$ref: '_common.yaml#/components/schemas/Stringifiedinteger'
IndexSettingsSearch:
type: object
properties:
idle:
$ref: '#/components/schemas/SearchIdle'
slowlog:
$ref: '#/components/schemas/SearchSlowlog'
SearchIdle:
type: object
properties:
after:
$ref: '_common.yaml#/components/schemas/Duration'
SearchSlowlog:
type: object
properties:
level:
type: string
reformat:
type: boolean
threshold:
$ref: '#/components/schemas/SearchSlowlogThresholds'
SearchSlowlogThresholds:
type: object
properties:
query:
$ref: '#/components/schemas/SlowlogThresholdLevels'
fetch:
$ref: '#/components/schemas/SlowlogThresholdLevels'
SlowlogThresholdLevels:
type: object
properties:
warn:
$ref: '_common.yaml#/components/schemas/Duration'
info:
$ref: '_common.yaml#/components/schemas/Duration'
debug:
$ref: '_common.yaml#/components/schemas/Duration'
trace:
$ref: '_common.yaml#/components/schemas/Duration'
IndexSettingBlocks:
type: object
properties:
read_only:
$ref: '_common.yaml#/components/schemas/Stringifiedboolean'
read_only_allow_delete:
$ref: '_common.yaml#/components/schemas/Stringifiedboolean'
read:
$ref: '_common.yaml#/components/schemas/Stringifiedboolean'
write:
$ref: '_common.yaml#/components/schemas/Stringifiedboolean'
metadata:
$ref: '_common.yaml#/components/schemas/Stringifiedboolean'
IndexSettingsAnalyze:
type: object
properties:
max_token_count:
$ref: '_common.yaml#/components/schemas/Stringifiedinteger'
IndexSettingsHighlight:
type: object
properties:
max_analyzed_offset:
type: integer
IndexRouting:
type: object
properties:
allocation:
$ref: '#/components/schemas/IndexRoutingAllocation'
rebalance:
$ref: '#/components/schemas/IndexRoutingRebalance'
IndexRoutingAllocation:
type: object
properties:
enable:
$ref: '#/components/schemas/IndexRoutingAllocationOptions'
include:
$ref: '#/components/schemas/IndexRoutingAllocationInclude'
initial_recovery:
$ref: '#/components/schemas/IndexRoutingAllocationInitialRecovery'
disk:
$ref: '#/components/schemas/IndexRoutingAllocationDisk'
IndexRoutingAllocationOptions:
type: string
enum:
- all
- new_primaries
- none
- primaries
IndexRoutingAllocationInclude:
type: object
properties:
_tier_preference:
type: string
_id:
$ref: '_common.yaml#/components/schemas/Id'
IndexRoutingAllocationInitialRecovery:
type: object
properties:
_id:
$ref: '_common.yaml#/components/schemas/Id'
IndexRoutingAllocationDisk:
type: object
properties:
threshold_enabled:
$ref: '_common.yaml#/components/schemas/Stringifiedboolean'
IndexRoutingRebalance:
type: object
properties:
enable:
$ref: '#/components/schemas/IndexRoutingRebalanceOptions'
required:
- enable
IndexRoutingRebalanceOptions:
type: string
enum:
- all
- none
- primaries
- replicas
IndexSettingsLifecycle:
type: object
properties:
name:
$ref: '_common.yaml#/components/schemas/Name'
indexing_complete:
$ref: '_common.yaml#/components/schemas/Stringifiedboolean'
origination_date:
description: |-
If specified, this is the timestamp used to calculate the index age for its phase transitions. Use this setting
if you create a new index that contains old data and want to use the original creation date to calculate the index
age. Specified as a Unix epoch value in milliseconds.
$ref: '_common.yaml#/components/schemas/StringifiedEpochTimeUnitMillis'
parse_origination_date:
description: |-
Set to true to parse the origination date from the index name. This origination date is used to calculate the index age
for its phase transitions. The index name must match the pattern ^.*-{date_format}-\\d+, where the date_format is
yyyy.MM.dd and the trailing digits are optional. An index that was rolled over would normally match the full format,
for example logs-2016.10.31-000002). If the index name doesn't match the pattern, index creation fails.
type: boolean
step:
$ref: '#/components/schemas/IndexSettingsLifecycleStep'
rollover_alias:
description: |-
The index alias to update when the index rolls over. Specify when using a policy that contains a rollover action.
When the index rolls over, the alias is updated to reflect that the index is no longer the write index. For more
information about rolling indices, see Rollover.
type: string
required:
- name
IndexSettingsLifecycleStep:
type: object
properties:
wait_time_threshold:
$ref: '_common.yaml#/components/schemas/Duration'
IndexVersioning:
type: object
properties:
created:
$ref: '_common.yaml#/components/schemas/VersionString'
created_string:
type: string
Translog:
type: object
properties:
sync_interval:
$ref: '_common.yaml#/components/schemas/Duration'
durability:
$ref: '#/components/schemas/TranslogDurability'
flush_threshold_size:
$ref: '_common.yaml#/components/schemas/HumanReadableByteCount'
retention:
$ref: '#/components/schemas/TranslogRetention'
TranslogDurability:
type: string
enum:
- ASYNC
- REQUEST
- async
- request
TranslogRetention:
type: object
properties:
size:
$ref: '_common.yaml#/components/schemas/HumanReadableByteCount'
age:
$ref: '_common.yaml#/components/schemas/Duration'
IndexSettingsQueryString:
type: object
properties:
lenient:
$ref: '_common.yaml#/components/schemas/Stringifiedboolean'
IndexSettingsAnalysis:
type: object
properties:
analyzer:
type: object
additionalProperties:
$ref: '_common.analysis.yaml#/components/schemas/Analyzer'
char_filter:
type: object
additionalProperties:
$ref: '_common.analysis.yaml#/components/schemas/CharFilter'
filter:
type: object
additionalProperties:
$ref: '_common.analysis.yaml#/components/schemas/TokenFilter'
normalizer:
type: object
additionalProperties:
$ref: '_common.analysis.yaml#/components/schemas/Normalizer'
tokenizer:
type: object
additionalProperties:
$ref: '_common.analysis.yaml#/components/schemas/Tokenizer'
IndexSettingsTimeSeries:
type: object
properties:
end_time:
$ref: '_common.yaml#/components/schemas/DateTime'
start_time:
$ref: '_common.yaml#/components/schemas/DateTime'
IndexSettingsQueries:
type: object
properties:
cache:
$ref: '#/components/schemas/IndexSettingsQueriesCache'
IndexSettingsQueriesCache:
type: object
properties:
enabled:
type: boolean
required:
- enabled
IndexSettingsSimilarity:
type: object
properties:
bm25:
$ref: '#/components/schemas/IndexSettingsSimilarityBm25'
dfi:
$ref: '#/components/schemas/IndexSettingsSimilarityDfi'
dfr:
$ref: '#/components/schemas/IndexSettingsSimilarityDfr'
ib:
$ref: '#/components/schemas/IndexSettingsSimilarityIb'
lmd:
$ref: '#/components/schemas/IndexSettingsSimilarityLmd'
lmj:
$ref: '#/components/schemas/IndexSettingsSimilarityLmj'
scripted_tfidf:
$ref: '#/components/schemas/IndexSettingsSimilarityScriptedTfidf'
IndexSettingsSimilarityBm25:
type: object
properties:
b:
type: number
format: float
discount_overlaps:
type: boolean
k1:
type: number
format: float
type:
type: string
enum:
- BM25
required:
- b
- discount_overlaps
- k1
- type
IndexSettingsSimilarityDfi:
type: object
properties:
independence_measure:
$ref: '_common.yaml#/components/schemas/DFIIndependenceMeasure'
type:
type: string
enum:
- DFI
required:
- independence_measure
- type
IndexSettingsSimilarityDfr:
type: object
properties:
after_effect:
$ref: '_common.yaml#/components/schemas/DFRAfterEffect'
basic_model:
$ref: '_common.yaml#/components/schemas/DFRBasicModel'
normalization:
$ref: '_common.yaml#/components/schemas/TermFrequencyNormalization'
type:
type: string
enum:
- DFR
required:
- after_effect
- basic_model
- normalization
- type
IndexSettingsSimilarityIb:
type: object
properties:
distribution:
$ref: '_common.yaml#/components/schemas/IBDistribution'
lambda:
$ref: '_common.yaml#/components/schemas/IBLambda'
normalization:
$ref: '_common.yaml#/components/schemas/TermFrequencyNormalization'
type:
type: string
enum:
- IB
required:
- distribution
- lambda
- normalization
- type
IndexSettingsSimilarityLmd:
type: object
properties:
mu:
type: number
format: float
type:
type: string
enum:
- LMDirichlet
required:
- mu
- type
IndexSettingsSimilarityLmj:
type: object
properties:
lambda:
type: number
format: float
type:
type: string
enum:
- LMJelinekMercer
required:
- lambda
- type
IndexSettingsSimilarityScriptedTfidf:
type: object
properties:
script:
$ref: '_common.yaml#/components/schemas/Script'
type:
type: string
enum:
- scripted
required:
- script
- type
IndexSettingsMapping:
type: object
properties:
coerce:
type: boolean
total_fields:
$ref: '#/components/schemas/IndexSettingsMappingLimitTotalFields'
depth:
$ref: '#/components/schemas/IndexSettingsMappingLimitDepth'
nested_fields:
$ref: '#/components/schemas/IndexSettingsMappingLimitNestedFields'
nested_objects:
$ref: '#/components/schemas/IndexSettingsMappingLimitNestedObjects'
field_name_length:
$ref: '#/components/schemas/IndexSettingsMappingLimitFieldNameLength'
dimension_fields:
$ref: '#/components/schemas/IndexSettingsMappingLimitDimensionFields'
ignore_malformed:
type: boolean
IndexSettingsMappingLimitTotalFields:
type: object
properties:
limit:
description: |-
The maximum number of fields in an index. Field and object mappings, as well as field aliases count towards this limit.
The limit is in place to prevent mappings and searches from becoming too large. Higher values can lead to performance
degradations and memory issues, especially in clusters with a high load or few resources.
type: integer
format: int64
IndexSettingsMappingLimitDepth:
type: object
properties:
limit:
description: |-
The maximum depth for a field, which is measured as the number of inner objects. For instance, if all fields are defined
at the root object level, then the depth is 1. If there is one object mapping, then the depth is 2, etc.
type: integer
format: int64
IndexSettingsMappingLimitNestedFields:
type: object
properties:
limit:
description: |-
The maximum number of distinct nested mappings in an index. The nested type should only be used in special cases, when
arrays of objects need to be queried independently of each other. To safeguard against poorly designed mappings, this
setting limits the number of unique nested types per index.
type: integer
format: int64
IndexSettingsMappingLimitNestedObjects:
type: object
properties:
limit:
description: |-
The maximum number of nested JSON objects that a single document can contain across all nested types. This limit helps
to prevent out of memory errors when a document contains too many nested objects.
type: integer
format: int64
IndexSettingsMappingLimitFieldNameLength:
type: object
properties:
limit:
description: |-
Setting for the maximum length of a field name. This setting isn't really something that addresses mappings explosion but
might still be useful if you want to limit the field length. It usually shouldn't be necessary to set this setting. The
default is okay unless a user starts to add a huge number of fields with really long names. Default is `Long.MAX_VALUE` (no limit).
type: integer
format: int64
IndexSettingsMappingLimitDimensionFields:
type: object
properties:
limit:
description: |-
[preview] This functionality is in technical preview and may be changed or removed in a future release.
OpenSearch will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
type: integer
format: int64
IndexingSlowlog:
type: object
properties:
level:
type: string
source:
type: integer
reformat:
type: boolean
threshold:
$ref: '#/components/schemas/IndexingSlowlogThresholds'
IndexingSlowlogThresholds:
type: object
properties:
index:
$ref: '#/components/schemas/SlowlogThresholdLevels'
IndexingPressure:
type: object
properties:
memory:
$ref: '#/components/schemas/IndexingPressureMemory'
required:
- memory
IndexingPressureMemory:
type: object
properties:
limit:
description: |-
Number of outstanding bytes that may be consumed by indexing requests. When this limit is reached or exceeded,
the node will reject new coordinating and primary operations. When replica operations consume 1.5x this limit,
the node will reject new replica operations. Defaults to 10% of the heap.
oneOf:
- type: string
- type: integer
format: int64
IndexSettingsStore:
type: object
properties:
type:
$ref: '#/components/schemas/StorageType'
allow_mmap:
description: |-
You can restrict the use of the mmapfs and the related hybridfs store type via the setting node.store.allow_mmap.
This is a boolean setting indicating whether or not memory-mapping is allowed. The default is to allow it. This
setting is useful, for example, if you are in an environment where you can not control the ability to create a lot
of memory maps so you need disable the ability to use memory-mapping.
type: boolean
required:
- type
StorageType:
type: string
enum:
- fs
- hybridfs
- mmapfs
- niofs
NumericFielddata:
type: object
properties:
format:
$ref: '#/components/schemas/NumericFielddataFormat'
required:
- format
NumericFielddataFormat:
type: string
enum:
- array
- disabled
FielddataFrequencyFilter:
type: object
properties:
max:
type: number
format: double
min:
type: number
format: double
min_segment_size:
type: integer
required:
- max
- min
- min_segment_size
AliasDefinition:
type: object
properties:
filter:
$ref: '_common.query_dsl.yaml#/components/schemas/QueryContainer'
index_routing:
description: |-
Value used to route indexing operations to a specific shard.
If specified, this overwrites the `routing` value for indexing operations.
type: string
is_write_index:
description: If `true`, the index is the write index for the alias.
type: boolean
routing:
description: Value used to route indexing and search operations to a specific shard.
type: string
search_routing:
description: |-
Value used to route search operations to a specific shard.
If specified, this overwrites the `routing` value for search operations.
type: string
is_hidden:
description: |-
If `true`, the alias is hidden.
All indices for the alias must have the same `is_hidden` value.
type: boolean
IndexState:
type: object
properties:
aliases:
type: object
additionalProperties:
$ref: '#/components/schemas/Alias'
mappings:
$ref: '_common.mapping.yaml#/components/schemas/TypeMapping'
settings:
$ref: '#/components/schemas/IndexSettings'
defaults:
$ref: '#/components/schemas/IndexSettings'
data_stream:
$ref: '_common.yaml#/components/schemas/DataStreamName'
Alias:
type: object
properties:
filter:
$ref: '_common.query_dsl.yaml#/components/schemas/QueryContainer'
index_routing:
$ref: '_common.yaml#/components/schemas/Routing'
is_hidden:
description: |-
If `true`, the alias is hidden.
All indices for the alias must have the same `is_hidden` value.
type: boolean
is_write_index:
description: If `true`, the index is the write index for the alias.
type: boolean
routing:
$ref: '_common.yaml#/components/schemas/Routing'
search_routing:
$ref: '_common.yaml#/components/schemas/Routing'
DataStream:
type: object
properties:
_meta:
$ref: '_common.yaml#/components/schemas/Metadata'
allow_custom_routing:
description: If `true`, the data stream allows custom routing on write request.
type: boolean
generation:
description: Current generation for the data stream. This number acts as a cumulative count of the stream's rollovers, starting at 1.
type: number
hidden:
description: If `true`, the data stream is hidden.
type: boolean
ilm_policy:
$ref: '_common.yaml#/components/schemas/Name'
next_generation_managed_by:
$ref: '#/components/schemas/ManagedBy'
prefer_ilm:
description: Indicates if ILM should take precedence over DSL in case both are configured to managed this data stream.
type: boolean
indices:
description: |-
Array of objects containing information about the data stream's backing indices.
The last item in this array contains information about the stream's current write index.
type: array
items:
$ref: '#/components/schemas/DataStreamIndex'
name:
$ref: '_common.yaml#/components/schemas/DataStreamName'
replicated:
description: If `true`, the data stream is created and managed by cross-cluster replication and the local cluster can not write into this data stream or change its mappings.
type: boolean
status:
$ref: '_common.yaml#/components/schemas/HealthStatusCapitalized'
system:
description: If `true`, the data stream is created and managed by an OpenSearch stack component and cannot be modified through normal user interaction.
type: boolean
template:
$ref: '_common.yaml#/components/schemas/Name'
timestamp_field:
$ref: '#/components/schemas/DataStreamTimestampField'
required:
- generation
- indices
- name
- status
- template
- timestamp_field
ManagedBy:
type: string
enum:
- Data stream lifecycle
- Index Lifecycle Management
- Unmanaged
DataStreamIndex:
type: object
properties:
index_name:
$ref: '_common.yaml#/components/schemas/IndexName'
index_uuid:
$ref: '_common.yaml#/components/schemas/Uuid'
ilm_policy:
$ref: '_common.yaml#/components/schemas/Name'
managed_by:
$ref: '#/components/schemas/ManagedBy'
prefer_ilm:
description: Indicates if ILM should take precedence over DSL in case both are configured to manage this index.
type: boolean
required:
- index_name
- index_uuid
DataStreamTimestampField:
type: object
properties:
name:
$ref: '_common.yaml#/components/schemas/Field'
required:
- name
IndexTemplate:
type: object
properties:
index_patterns:
$ref: '_common.yaml#/components/schemas/Names'
composed_of:
description: |-
An ordered list of component template names.
Component templates are merged in the order specified, meaning that the last component template specified has the highest precedence.
type: array
items:
$ref: '_common.yaml#/components/schemas/Name'
template:
$ref: '#/components/schemas/IndexTemplateSummary'
version:
$ref: '_common.yaml#/components/schemas/VersionNumber'
priority:
description: |-
Priority to determine index template precedence when a new data stream or index is created.
The index template with the highest priority is chosen.
If no priority is specified the template is treated as though it is of priority 0 (lowest priority).
This number is not automatically generated by OpenSearch.
type: number
_meta:
$ref: '_common.yaml#/components/schemas/Metadata'
allow_auto_create:
type: boolean
data_stream:
$ref: '#/components/schemas/IndexTemplateDataStreamConfiguration'
required:
- index_patterns
description: New index template definition to be simulated, if no index template name is specified.
IndexTemplateSummary:
type: object
properties:
aliases:
description: |-
Aliases to add.
If the index template includes a `data_stream` object, these are data stream aliases.
Otherwise, these are index aliases.
Data stream aliases ignore the `index_routing`, `routing`, and `search_routing` options.
type: object
additionalProperties:
$ref: '#/components/schemas/Alias'
mappings:
$ref: '_common.mapping.yaml#/components/schemas/TypeMapping'
settings:
$ref: '#/components/schemas/IndexSettings'
IndexTemplateDataStreamConfiguration:
type: object
properties:
hidden:
description: If true, the data stream is hidden.
type: boolean
allow_custom_routing:
description: If true, the data stream supports custom routing.
type: boolean
timestamp_field:
$ref: '#/components/schemas/DataStreamTimestampField'
TemplateMapping:
type: object
properties:
aliases:
type: object
additionalProperties:
$ref: '#/components/schemas/Alias'
index_patterns:
type: array
items:
$ref: '_common.yaml#/components/schemas/Name'
mappings:
$ref: '_common.mapping.yaml#/components/schemas/TypeMapping'
order:
type: number
settings:
type: object
additionalProperties:
type: object
version:
$ref: '_common.yaml#/components/schemas/VersionNumber'
required:
- aliases
- index_patterns
- mappings
- order
- settings
IndexError:
type: object
properties:
error:
$ref: '#/components/schemas/IndexErrorCause'
status:
type: number
IndexErrorCause:
type: object
properties:
type:
description: The type of error
type: string
reason:
description: A human-readable explanation of the error, in english