npm - @elastic/schemas - Versions diffs - 0.7.2 → 0.7.3 - Mend

@elastic/schemas 0.7.2 → 0.7.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (144) hide show

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@elastic/schemas",
-  "version": "0.7.2",
+  "version": "0.7.3",
   "description": "Request and response schemas for all Elastic APIs",
   "main": "lib/cjs/index.js",
   "scripts": {

package/src/es/json/cat._types.json CHANGED Viewed

	@@ -1 +1 @@
1	- {"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"cat._types__CatAliasesColumns":{"anyOf":[{"$ref":"./cat._types.json#/$defs/cat._types__CatAliasesColumn"},{"type":"array","items":{"$ref":"./cat._types.json#/$defs/cat._types__CatAliasesColumn"}}]},"cat._types__CatAliasesColumn":{"anyOf":[{"enum":["alias","index","filter","routing.index","routing.search","is_write_index"]},{"type":"string"}]},"cat._types__CatAllocationColumns":{"anyOf":[{"$ref":"./cat._types.json#/$defs/cat._types__CatAllocationColumn"},{"type":"array","items":{"$ref":"./cat._types.json#/$defs/cat._types__CatAllocationColumn"}}]},"cat._types__CatAllocationColumn":{"anyOf":[{"enum":["shards","shards.undesired","write_load.forecast","disk.indices.forecast","disk.indices","disk.used","disk.avail","disk.total","disk.percent","host","ip","node","node.role"]},{"type":"string"}]},"cat._types__CatCircuitBreakerColumns":{"anyOf":[{"$ref":"./cat._types.json#/$defs/cat._types__CatCircuitBreakerColumn"},{"type":"array","items":{"$ref":"./cat._types.json#/$defs/cat._types__CatCircuitBreakerColumn"}}]},"cat._types__CatCircuitBreakerColumn":{"anyOf":[{"enum":["node_id","node_name","breaker","limit","limit_bytes","estimated","estimated_bytes","tripped","overhead"]},{"type":"string"}]},"cat._types__CatComponentColumns":{"anyOf":[{"$ref":"./cat._types.json#/$defs/cat._types__CatComponentColumn"},{"type":"array","items":{"$ref":"./cat._types.json#/$defs/cat._types__CatComponentColumn"}}]},"cat._types__CatComponentColumn":{"anyOf":[{"enum":["name","version","alias_count","mapping_count","settings_count","metadata_count","included_in"]},{"type":"string"}]},"cat._types__CatCountColumns":{"anyOf":[{"$ref":"./cat._types.json#/$defs/cat._types__CatCountColumn"},{"type":"array","items":{"$ref":"./cat._types.json#/$defs/cat._types__CatCountColumn"}}]},"cat._types__CatCountColumn":{"anyOf":[{"enum":["epoch","timestamp","count"]},{"type":"string"}]},"cat._types__CatFieldDataColumns":{"anyOf":[{"$ref":"./cat._types.json#/$defs/cat._types__CatFieldDataColumn"},{"type":"array","items":{"$ref":"./cat._types.json#/$defs/cat._types__CatFieldDataColumn"}}]},"cat._types__CatFieldDataColumn":{"anyOf":[{"enum":["id","host","ip","node","field","size"]},{"type":"string"}]},"cat._types__CatHealthColumns":{"anyOf":[{"$ref":"./cat._types.json#/$defs/cat._types__CatHealthColumn"},{"type":"array","items":{"$ref":"./cat._types.json#/$defs/cat._types__CatHealthColumn"}}]},"cat._types__CatHealthColumn":{"anyOf":[{"enum":["epoch","timestamp","cluster","status","node.total","node.data","shards","pri","relo","init","unassign","unassign.pri","pending_tasks","max_task_wait_time","active_shards_percent"]},{"type":"string"}]},"cat._types__CatIndicesColumns":{"anyOf":[{"$ref":"./cat._types.json#/$defs/cat._types__CatIndicesColumn"},{"type":"array","items":{"$ref":"./cat._types.json#/$defs/cat._types__CatIndicesColumn"}}]},"cat._types__CatIndicesColumn":{"anyOf":[{"enum":["health","status","index","uuid","pri","rep","docs.count","docs.deleted","creation.date","creation.date.string","store.size","pri.store.size","dataset.size","completion.size","pri.completion.size","fielddata.memory_size","pri.fielddata.memory_size","fielddata.evictions","pri.fielddata.evictions","query_cache.memory_size","pri.query_cache.memory_size","query_cache.evictions","pri.query_cache.evictions","request_cache.memory_size","pri.request_cache.memory_size","request_cache.evictions","pri.request_cache.evictions","request_cache.hit_count","pri.request_cache.hit_count","request_cache.miss_count","pri.request_cache.miss_count","flush.total","pri.flush.total","flush.total_time","pri.flush.total_time","get.current","pri.get.current","get.time","pri.get.time","get.total","pri.get.total","get.exists_time","pri.get.exists_time","get.exists_total","pri.get.exists_total","get.missing_time","pri.get.missing_time","get.missing_total","pri.get.missing_total","indexing.delete_current","pri.indexing.delete_current","indexing.delete_time","pri.indexing.delete_time","indexing.delete_total","pri.indexing.delete_total","indexing.index_current","pri.indexing.index_current","indexing.index_time","pri.indexing.index_time","indexing.index_total","pri.indexing.index_total","indexing.index_failed","pri.indexing.index_failed","indexing.index_failed_due_to_version_conflict","pri.indexing.index_failed_due_to_version_conflict","merges.current","pri.merges.current","merges.current_docs","pri.merges.current_docs","merges.current_size","pri.merges.current_size","merges.total","pri.merges.total","merges.total_docs","pri.merges.total_docs","merges.total_size","pri.merges.total_size","merges.total_time","pri.merges.total_time","refresh.total","pri.refresh.total","refresh.time","pri.refresh.time","refresh.external_total","pri.refresh.external_total","refresh.external_time","pri.refresh.external_time","refresh.listeners","pri.refresh.listeners","search.fetch_current","pri.search.fetch_current","search.fetch_time","pri.search.fetch_time","search.fetch_total","pri.search.fetch_total","search.open_contexts","pri.search.open_contexts","search.query_current","pri.search.query_current","search.query_time","pri.search.query_time","search.query_total","pri.search.query_total","search.scroll_current","pri.search.scroll_current","search.scroll_time","pri.search.scroll_time","search.scroll_total","pri.search.scroll_total","segments.count","pri.segments.count","segments.memory","pri.segments.memory","segments.index_writer_memory","pri.segments.index_writer_memory","segments.version_map_memory","pri.segments.version_map_memory","segments.fixed_bitset_memory","pri.segments.fixed_bitset_memory","warmer.current","pri.warmer.current","warmer.total","pri.warmer.total","warmer.total_time","pri.warmer.total_time","suggest.current","pri.suggest.current","suggest.time","pri.suggest.time","suggest.total","pri.suggest.total","memory.total","pri.memory.total","bulk.total_operations","pri.bulk.total_operations","bulk.total_time","pri.bulk.total_time","bulk.total_size_in_bytes","pri.bulk.total_size_in_bytes","bulk.avg_time","pri.bulk.avg_time","bulk.avg_size_in_bytes","pri.bulk.avg_size_in_bytes","dense_vector.value_count","pri.dense_vector.value_count","sparse_vector.value_count","pri.sparse_vector.value_count"]},{"type":"string"}]},"cat._types__CatMasterColumns":{"anyOf":[{"$ref":"./cat._types.json#/$defs/cat._types__CatMasterColumn"},{"type":"array","items":{"$ref":"./cat._types.json#/$defs/cat._types__CatMasterColumn"}}]},"cat._types__CatMasterColumn":{"anyOf":[{"enum":["id","host","ip","node"]},{"type":"string"}]},"cat._types__CatDfaColumns":{"anyOf":[{"$ref":"./cat._types.json#/$defs/cat._types__CatDfaColumn"},{"type":"array","items":{"$ref":"./cat._types.json#/$defs/cat._types__CatDfaColumn"}}]},"cat._types__CatDfaColumn":{"enum":["assignment_explanation","create_time","description","dest_index","failure_reason","id","model_memory_limit","node.address","node.ephemeral_id","node.id","node.name","progress","source_index","state","type","version"]},"cat._types__CatDatafeedColumns":{"anyOf":[{"$ref":"./cat._types.json#/$defs/cat._types__CatDatafeedColumn"},{"type":"array","items":{"$ref":"./cat._types.json#/$defs/cat._types__CatDatafeedColumn"}}]},"cat._types__CatDatafeedColumn":{"enum":["ae","bc","id","na","ne","ni","nn","sba","sc","seah","st","s"]},"cat._types__CatAnomalyDetectorColumns":{"anyOf":[{"$ref":"./cat._types.json#/$defs/cat._types__CatAnomalyDetectorColumn"},{"type":"array","items":{"$ref":"./cat._types.json#/$defs/cat._types__CatAnomalyDetectorColumn"}}]},"cat._types__CatAnomalyDetectorColumn":{"enum":["assignment_explanation","buckets.count","buckets.time.exp_avg","buckets.time.exp_avg_hour","buckets.time.max","buckets.time.min","buckets.time.total","data.buckets","data.earliest_record","data.empty_buckets","data.input_bytes","data.input_fields","data.input_records","data.invalid_dates","data.last","data.last_empty_bucket","data.last_sparse_bucket","data.latest_record","data.missing_fields","data.out_of_order_timestamps","data.processed_fields","data.processed_records","data.sparse_buckets","forecasts.memory.avg","forecasts.memory.max","forecasts.memory.min","forecasts.memory.total","forecasts.records.avg","forecasts.records.max","forecasts.records.min","forecasts.records.total","forecasts.time.avg","forecasts.time.max","forecasts.time.min","forecasts.time.total","forecasts.total","id","model.bucket_allocation_failures","model.by_fields","model.bytes","model.bytes_exceeded","model.categorization_status","model.categorized_doc_count","model.dead_category_count","model.failed_category_count","model.frequent_category_count","model.log_time","model.memory_limit","model.memory_status","model.over_fields","model.partition_fields","model.rare_category_count","model.timestamp","model.total_category_count","node.address","node.ephemeral_id","node.id","node.name","opened_time","state"]},"cat._types__CatTrainedModelsColumns":{"anyOf":[{"$ref":"./cat._types.json#/$defs/cat._types__CatTrainedModelsColumn"},{"type":"array","items":{"$ref":"./cat._types.json#/$defs/cat._types__CatTrainedModelsColumn"}}]},"cat._types__CatTrainedModelsColumn":{"enum":["create_time","created_by","data_frame_analytics_id","description","heap_size","id","ingest.count","ingest.current","ingest.failed","ingest.pipelines","ingest.time","license","operations","version"]},"cat._types__CatNodeattrsColumns":{"anyOf":[{"$ref":"./cat._types.json#/$defs/cat._types__CatNodeattrsColumn"},{"type":"array","items":{"$ref":"./cat._types.json#/$defs/cat._types__CatNodeattrsColumn"}}]},"cat._types__CatNodeattrsColumn":{"anyOf":[{"enum":["node","id","pid","host","ip","port","attr","value"]},{"type":"string"}]},"cat._types__CatNodeColumns":{"anyOf":[{"$ref":"./cat._types.json#/$defs/cat._types__CatNodeColumn"},{"type":"array","items":{"$ref":"./cat._types.json#/$defs/cat._types__CatNodeColumn"}}]},"cat._types__CatNodeColumn":{"anyOf":[{"enum":["build","completion.size","cpu","disk.avail","disk.total","disk.used","disk.used_percent","fielddata.evictions","fielddata.memory_size","file_desc.current","file_desc.max","file_desc.percent","flush.total","flush.total_time","get.current","get.exists_time","get.exists_total","get.missing_time","get.missing_total","get.time","get.total","heap.current","heap.max","heap.percent","http_address","id","indexing.delete_current","indexing.delete_time","indexing.delete_total","indexing.index_current","indexing.index_failed","indexing.index_failed_due_to_version_conflict","indexing.index_time","indexing.index_total","ip","jdk","load_1m","load_5m","load_15m","available_processors","mappings.total_count","mappings.total_estimated_overhead_in_bytes","master","merges.current","merges.current_docs","merges.current_size","merges.total","merges.total_docs","merges.total_size","merges.total_time","name","node.role","pid","port","query_cache.memory_size","query_cache.evictions","query_cache.hit_count","query_cache.miss_count","ram.current","ram.max","ram.percent","refresh.total","refresh.time","request_cache.memory_size","request_cache.evictions","request_cache.hit_count","request_cache.miss_count","script.compilations","script.cache_evictions","search.fetch_current","search.fetch_time","search.fetch_total","search.open_contexts","search.query_current","search.query_time","search.query_total","search.scroll_current","search.scroll_time","search.scroll_total","segments.count","segments.fixed_bitset_memory","segments.index_writer_memory","segments.memory","segments.version_map_memory","shard_stats.total_count","suggest.current","suggest.time","suggest.total","uptime","version"]},{"type":"string"}]},"cat._types__CatPendingTasksColumns":{"anyOf":[{"$ref":"./cat._types.json#/$defs/cat._types__CatPendingTasksColumn"},{"type":"array","items":{"$ref":"./cat._types.json#/$defs/cat._types__CatPendingTasksColumn"}}]},"cat._types__CatPendingTasksColumn":{"anyOf":[{"enum":["insertOrder","timeInQueue","priority","source"]},{"type":"string"}]},"cat._types__CatPluginsColumns":{"anyOf":[{"$ref":"./cat._types.json#/$defs/cat._types__CatPluginsColumn"},{"type":"array","items":{"$ref":"./cat._types.json#/$defs/cat._types__CatPluginsColumn"}}]},"cat._types__CatPluginsColumn":{"anyOf":[{"enum":["id","name","component","version","description"]},{"type":"string"}]},"cat._types__CatRecoveryColumns":{"anyOf":[{"$ref":"./cat._types.json#/$defs/cat._types__CatRecoveryColumn"},{"type":"array","items":{"$ref":"./cat._types.json#/$defs/cat._types__CatRecoveryColumn"}}]},"cat._types__CatRecoveryColumn":{"anyOf":[{"enum":["index","shard","start_time","start_time_millis","stop_time","stop_time_millis","time","type","stage","priority","source_host","source_node","target_host","target_node","repository","snapshot","files","files_recovered","files_percent","files_total","bytes","bytes_recovered","bytes_percent","bytes_total","translog_ops","translog_ops_recovered","translog_ops_percent"]},{"type":"string"}]},"cat._types__CatSegmentsColumns":{"anyOf":[{"$ref":"./cat._types.json#/$defs/cat._types__CatSegmentsColumn"},{"type":"array","items":{"$ref":"./cat._types.json#/$defs/cat._types__CatSegmentsColumn"}}]},"cat._types__CatSegmentsColumn":{"anyOf":[{"enum":["index","shard","prirep","ip","segment","generation","docs.count","docs.deleted","size","size.memory","committed","searchable","version","compound","id"]},{"type":"string"}]},"cat._types__CatShardColumns":{"anyOf":[{"$ref":"./cat._types.json#/$defs/cat._types__CatShardColumn"},{"type":"array","items":{"$ref":"./cat._types.json#/$defs/cat._types__CatShardColumn"}}]},"cat._types__CatShardColumn":{"anyOf":[{"enum":["completion.size","dataset.size","dense_vector.value_count","docs","fielddata.evictions","fielddata.memory_size","flush.total","flush.total_time","get.current","get.exists_time","get.exists_total","get.missing_time","get.missing_total","get.time","get.total","id","index","indexing.delete_current","indexing.delete_time","indexing.delete_total","indexing.index_current","indexing.index_failed_due_to_version_conflict","indexing.index_failed","indexing.index_time","indexing.index_total","ip","merges.current","merges.current_docs","merges.current_size","merges.total","merges.total_docs","merges.total_size","merges.total_time","node","prirep","query_cache.evictions","query_cache.memory_size","recoverysource.type","refresh.time","refresh.total","search.fetch_current","search.fetch_time","search.fetch_total","search.open_contexts","search.query_current","search.query_time","search.query_total","search.scroll_current","search.scroll_time","search.scroll_total","segments.count","segments.fixed_bitset_memory","segments.index_writer_memory","segments.memory","segments.version_map_memory","seq_no.global_checkpoint","seq_no.local_checkpoint","seq_no.max","shard","dsparse_vector.value_count","state","store","suggest.current","suggest.time","suggest.total","sync_id","unassigned.at","unassigned.details","unassigned.for","unassigned.reason"]},{"type":"string"}]},"cat._types__CatSnapshotsColumns":{"anyOf":[{"$ref":"./cat._types.json#/$defs/cat._types__CatSnapshotsColumn"},{"type":"array","items":{"$ref":"./cat._types.json#/$defs/cat._types__CatSnapshotsColumn"}}]},"cat._types__CatSnapshotsColumn":{"anyOf":[{"enum":["id","repository","status","start_epoch","start_time","end_epoch","end_time","duration","indices","successful_shards","failed_shards","total_shards","reason"]},{"type":"string"}]},"cat._types__CatTasksColumns":{"anyOf":[{"$ref":"./cat._types.json#/$defs/cat._types__CatTasksColumn"},{"type":"array","items":{"$ref":"./cat._types.json#/$defs/cat._types__CatTasksColumn"}}]},"cat._types__CatTasksColumn":{"anyOf":[{"enum":["id","action","task_id","parent_task_id","type","start_time","timestamp","running_time_ns","running_time","node_id","ip","port","node","version","x_opaque_id"]},{"type":"string"}]},"cat._types__CatTemplatesColumns":{"anyOf":[{"$ref":"./cat._types.json#/$defs/cat._types__CatTemplatesColumn"},{"type":"array","items":{"$ref":"./cat._types.json#/$defs/cat._types__CatTemplatesColumn"}}]},"cat._types__CatTemplatesColumn":{"anyOf":[{"enum":["name","index_patterns","order","version","composed_of"]},{"type":"string"}]},"cat._types__CatThreadPoolColumns":{"anyOf":[{"$ref":"./cat._types.json#/$defs/cat._types__CatThreadPoolColumn"},{"type":"array","items":{"$ref":"./cat._types.json#/$defs/cat._types__CatThreadPoolColumn"}}]},"cat._types__CatThreadPoolColumn":{"anyOf":[{"enum":["active","completed","core","ephemeral_id","host","ip","keep_alive","largest","max","name","node_id","node_name","pid","pool_size","port","queue","queue_size","rejected","size","type"]},{"type":"string"}]},"cat._types__CatTransformColumns":{"anyOf":[{"$ref":"./cat._types.json#/$defs/cat._types__CatTransformColumn"},{"type":"array","items":{"$ref":"./cat._types.json#/$defs/cat._types__CatTransformColumn"}}]},"cat._types__CatTransformColumn":{"enum":["changes_last_detection_time","checkpoint","checkpoint_duration_time_exp_avg","checkpoint_progress","create_time","delete_time","description","dest_index","documents_deleted","documents_indexed","docs_per_second","documents_processed","frequency","id","index_failure","index_time","index_total","indexed_documents_exp_avg","last_search_time","max_page_search_size","pages_processed","pipeline","processed_documents_exp_avg","processing_time","project_routing","reason","search_failure","search_time","search_total","source_index","state","transform_type","trigger_count","version"]}}}
1	+ {"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"cat._types__CatAliasesColumns":{"anyOf":[{"$ref":"./cat._types.json#/$defs/cat._types__CatAliasesColumn"},{"type":"array","items":{"$ref":"./cat._types.json#/$defs/cat._types__CatAliasesColumn"}}]},"cat._types__CatAliasesColumn":{"anyOf":[{"enum":["alias","index","filter","routing.index","routing.search","is_write_index"]},{"type":"string"}]},"cat._types__CatAllocationColumns":{"anyOf":[{"$ref":"./cat._types.json#/$defs/cat._types__CatAllocationColumn"},{"type":"array","items":{"$ref":"./cat._types.json#/$defs/cat._types__CatAllocationColumn"}}]},"cat._types__CatAllocationColumn":{"anyOf":[{"enum":["shards","shards.undesired","write_load.forecast","disk.indices.forecast","disk.indices","disk.used","disk.avail","disk.total","disk.percent","host","ip","node","node.role"]},{"type":"string"}]},"cat._types__CatCircuitBreakerColumns":{"anyOf":[{"$ref":"./cat._types.json#/$defs/cat._types__CatCircuitBreakerColumn"},{"type":"array","items":{"$ref":"./cat._types.json#/$defs/cat._types__CatCircuitBreakerColumn"}}]},"cat._types__CatCircuitBreakerColumn":{"anyOf":[{"enum":["node_id","node_name","breaker","limit","limit_bytes","estimated","estimated_bytes","tripped","overhead"]},{"type":"string"}]},"cat._types__CatComponentColumns":{"anyOf":[{"$ref":"./cat._types.json#/$defs/cat._types__CatComponentColumn"},{"type":"array","items":{"$ref":"./cat._types.json#/$defs/cat._types__CatComponentColumn"}}]},"cat._types__CatComponentColumn":{"anyOf":[{"enum":["name","version","alias_count","mapping_count","settings_count","metadata_count","included_in"]},{"type":"string"}]},"cat._types__CatCountColumns":{"anyOf":[{"$ref":"./cat._types.json#/$defs/cat._types__CatCountColumn"},{"type":"array","items":{"$ref":"./cat._types.json#/$defs/cat._types__CatCountColumn"}}]},"cat._types__CatCountColumn":{"anyOf":[{"enum":["epoch","timestamp","count"]},{"type":"string"}]},"cat._types__CatFieldDataColumns":{"anyOf":[{"$ref":"./cat._types.json#/$defs/cat._types__CatFieldDataColumn"},{"type":"array","items":{"$ref":"./cat._types.json#/$defs/cat._types__CatFieldDataColumn"}}]},"cat._types__CatFieldDataColumn":{"anyOf":[{"enum":["id","host","ip","node","field","size"]},{"type":"string"}]},"cat._types__CatHealthColumns":{"anyOf":[{"$ref":"./cat._types.json#/$defs/cat._types__CatHealthColumn"},{"type":"array","items":{"$ref":"./cat._types.json#/$defs/cat._types__CatHealthColumn"}}]},"cat._types__CatHealthColumn":{"anyOf":[{"enum":["epoch","timestamp","cluster","status","node.total","node.data","shards","pri","relo","init","unassign","unassign.pri","pending_tasks","max_task_wait_time","active_shards_percent"]},{"type":"string"}]},"cat._types__CatIndicesColumns":{"anyOf":[{"$ref":"./cat._types.json#/$defs/cat._types__CatIndicesColumn"},{"type":"array","items":{"$ref":"./cat._types.json#/$defs/cat._types__CatIndicesColumn"}}]},"cat._types__CatIndicesColumn":{"anyOf":[{"enum":["health","status","index","uuid","pri","rep","docs.count","docs.deleted","creation.date","creation.date.string","store.size","pri.store.size","dataset.size","completion.size","pri.completion.size","fielddata.memory_size","pri.fielddata.memory_size","fielddata.evictions","pri.fielddata.evictions","query_cache.memory_size","pri.query_cache.memory_size","query_cache.evictions","pri.query_cache.evictions","request_cache.memory_size","pri.request_cache.memory_size","request_cache.evictions","pri.request_cache.evictions","request_cache.hit_count","pri.request_cache.hit_count","request_cache.miss_count","pri.request_cache.miss_count","flush.total","pri.flush.total","flush.total_time","pri.flush.total_time","get.current","pri.get.current","get.time","pri.get.time","get.total","pri.get.total","get.exists_time","pri.get.exists_time","get.exists_total","pri.get.exists_total","get.missing_time","pri.get.missing_time","get.missing_total","pri.get.missing_total","indexing.delete_current","pri.indexing.delete_current","indexing.delete_time","pri.indexing.delete_time","indexing.delete_total","pri.indexing.delete_total","indexing.index_current","pri.indexing.index_current","indexing.index_time","pri.indexing.index_time","indexing.index_total","pri.indexing.index_total","indexing.index_failed","pri.indexing.index_failed","indexing.index_failed_due_to_version_conflict","pri.indexing.index_failed_due_to_version_conflict","merges.current","pri.merges.current","merges.current_docs","pri.merges.current_docs","merges.current_size","pri.merges.current_size","merges.total","pri.merges.total","merges.total_docs","pri.merges.total_docs","merges.total_size","pri.merges.total_size","merges.total_time","pri.merges.total_time","refresh.total","pri.refresh.total","refresh.time","pri.refresh.time","refresh.external_total","pri.refresh.external_total","refresh.external_time","pri.refresh.external_time","refresh.listeners","pri.refresh.listeners","search.fetch_current","pri.search.fetch_current","search.fetch_time","pri.search.fetch_time","search.fetch_total","pri.search.fetch_total","search.open_contexts","pri.search.open_contexts","search.query_current","pri.search.query_current","search.query_time","pri.search.query_time","search.query_total","pri.search.query_total","search.scroll_current","pri.search.scroll_current","search.scroll_time","pri.search.scroll_time","search.scroll_total","pri.search.scroll_total","segments.count","pri.segments.count","segments.memory","pri.segments.memory","segments.index_writer_memory","pri.segments.index_writer_memory","segments.version_map_memory","pri.segments.version_map_memory","segments.fixed_bitset_memory","pri.segments.fixed_bitset_memory","warmer.current","pri.warmer.current","warmer.total","pri.warmer.total","warmer.total_time","pri.warmer.total_time","suggest.current","pri.suggest.current","suggest.time","pri.suggest.time","suggest.total","pri.suggest.total","memory.total","pri.memory.total","bulk.total_operations","pri.bulk.total_operations","bulk.total_time","pri.bulk.total_time","bulk.total_size_in_bytes","pri.bulk.total_size_in_bytes","bulk.avg_time","pri.bulk.avg_time","bulk.avg_size_in_bytes","pri.bulk.avg_size_in_bytes","dense_vector.value_count","pri.dense_vector.value_count","sparse_vector.value_count","pri.sparse_vector.value_count"]},{"type":"string"}]},"cat._types__CatMasterColumns":{"anyOf":[{"$ref":"./cat._types.json#/$defs/cat._types__CatMasterColumn"},{"type":"array","items":{"$ref":"./cat._types.json#/$defs/cat._types__CatMasterColumn"}}]},"cat._types__CatMasterColumn":{"anyOf":[{"enum":["id","host","ip","node"]},{"type":"string"}]},"cat._types__CatDfaColumns":{"anyOf":[{"$ref":"./cat._types.json#/$defs/cat._types__CatDfaColumn"},{"type":"array","items":{"$ref":"./cat._types.json#/$defs/cat._types__CatDfaColumn"}}]},"cat._types__CatDfaColumn":{"enum":["assignment_explanation","create_time","description","dest_index","failure_reason","id","model_memory_limit","node.address","node.ephemeral_id","node.id","node.name","progress","source_index","state","type","version"]},"cat._types__CatDatafeedColumns":{"anyOf":[{"$ref":"./cat._types.json#/$defs/cat._types__CatDatafeedColumn"},{"type":"array","items":{"$ref":"./cat._types.json#/$defs/cat._types__CatDatafeedColumn"}}]},"cat._types__CatDatafeedColumn":{"enum":["ae","bc","id","na","ne","ni","nn","sba","sc","seah","st","s"]},"cat._types__CatAnomalyDetectorColumns":{"anyOf":[{"$ref":"./cat._types.json#/$defs/cat._types__CatAnomalyDetectorColumn"},{"type":"array","items":{"$ref":"./cat._types.json#/$defs/cat._types__CatAnomalyDetectorColumn"}}]},"cat._types__CatAnomalyDetectorColumn":{"enum":["assignment_explanation","buckets.count","buckets.time.exp_avg","buckets.time.exp_avg_hour","buckets.time.max","buckets.time.min","buckets.time.total","data.buckets","data.earliest_record","data.empty_buckets","data.input_bytes","data.input_fields","data.input_records","data.invalid_dates","data.last","data.last_empty_bucket","data.last_sparse_bucket","data.latest_record","data.missing_fields","data.out_of_order_timestamps","data.processed_fields","data.processed_records","data.sparse_buckets","forecasts.memory.avg","forecasts.memory.max","forecasts.memory.min","forecasts.memory.total","forecasts.records.avg","forecasts.records.max","forecasts.records.min","forecasts.records.total","forecasts.time.avg","forecasts.time.max","forecasts.time.min","forecasts.time.total","forecasts.total","id","model.bucket_allocation_failures","model.by_fields","model.bytes","model.bytes_exceeded","model.categorization_status","model.categorized_doc_count","model.dead_category_count","model.failed_category_count","model.frequent_category_count","model.log_time","model.memory_limit","model.memory_status","model.over_fields","model.partition_fields","model.rare_category_count","model.timestamp","model.total_category_count","node.address","node.ephemeral_id","node.id","node.name","opened_time","state"]},"cat._types__CatTrainedModelsColumns":{"anyOf":[{"$ref":"./cat._types.json#/$defs/cat._types__CatTrainedModelsColumn"},{"type":"array","items":{"$ref":"./cat._types.json#/$defs/cat._types__CatTrainedModelsColumn"}}]},"cat._types__CatTrainedModelsColumn":{"enum":["create_time","created_by","data_frame_analytics_id","description","heap_size","id","ingest.count","ingest.current","ingest.failed","ingest.pipelines","ingest.time","license","operations","version"]},"cat._types__CatNodeattrsColumns":{"anyOf":[{"$ref":"./cat._types.json#/$defs/cat._types__CatNodeattrsColumn"},{"type":"array","items":{"$ref":"./cat._types.json#/$defs/cat._types__CatNodeattrsColumn"}}]},"cat._types__CatNodeattrsColumn":{"anyOf":[{"enum":["node","id","pid","host","ip","port","attr","value"]},{"type":"string"}]},"cat._types__CatNodeColumns":{"anyOf":[{"$ref":"./cat._types.json#/$defs/cat._types__CatNodeColumn"},{"type":"array","items":{"$ref":"./cat._types.json#/$defs/cat._types__CatNodeColumn"}}]},"cat._types__CatNodeColumn":{"anyOf":[{"enum":["build","completion.size","cpu","disk.avail","disk.total","disk.used","disk.used_percent","fielddata.evictions","fielddata.memory_size","file_desc.current","file_desc.max","file_desc.percent","flush.total","flush.total_time","get.current","get.exists_time","get.exists_total","get.missing_time","get.missing_total","get.time","get.total","heap.current","heap.max","heap.percent","http_address","id","indexing.delete_current","indexing.delete_time","indexing.delete_total","indexing.index_current","indexing.index_failed","indexing.index_failed_due_to_version_conflict","indexing.index_time","indexing.index_total","ip","jdk","load_1m","load_5m","load_15m","available_processors","mappings.total_count","mappings.total_estimated_overhead_in_bytes","master","merges.current","merges.current_docs","merges.current_size","merges.total","merges.total_docs","merges.total_size","merges.total_time","name","node.role","pid","port","query_cache.memory_size","query_cache.evictions","query_cache.hit_count","query_cache.miss_count","ram.current","ram.max","ram.percent","refresh.total","refresh.time","request_cache.memory_size","request_cache.evictions","request_cache.hit_count","request_cache.miss_count","script.compilations","script.cache_evictions","search.fetch_current","search.fetch_time","search.fetch_total","search.open_contexts","search.query_current","search.query_time","search.query_total","search.scroll_current","search.scroll_time","search.scroll_total","segments.count","segments.fixed_bitset_memory","segments.index_writer_memory","segments.memory","segments.version_map_memory","shard_stats.total_count","suggest.current","suggest.time","suggest.total","uptime","version"]},{"type":"string"}]},"cat._types__CatPendingTasksColumns":{"anyOf":[{"$ref":"./cat._types.json#/$defs/cat._types__CatPendingTasksColumn"},{"type":"array","items":{"$ref":"./cat._types.json#/$defs/cat._types__CatPendingTasksColumn"}}]},"cat._types__CatPendingTasksColumn":{"anyOf":[{"enum":["insertOrder","timeInQueue","priority","source"]},{"type":"string"}]},"cat._types__CatPluginsColumns":{"anyOf":[{"$ref":"./cat._types.json#/$defs/cat._types__CatPluginsColumn"},{"type":"array","items":{"$ref":"./cat._types.json#/$defs/cat._types__CatPluginsColumn"}}]},"cat._types__CatPluginsColumn":{"anyOf":[{"enum":["id","name","component","version","description"]},{"type":"string"}]},"cat._types__CatRecoveryColumns":{"anyOf":[{"$ref":"./cat._types.json#/$defs/cat._types__CatRecoveryColumn"},{"type":"array","items":{"$ref":"./cat._types.json#/$defs/cat._types__CatRecoveryColumn"}}]},"cat._types__CatRecoveryColumn":{"anyOf":[{"enum":["index","shard","start_time","start_time_millis","stop_time","stop_time_millis","time","type","stage","local_retries","priority","source_host","source_node","target_host","target_node","repository","snapshot","files","files_recovered","files_percent","files_total","bytes","bytes_recovered","bytes_percent","bytes_total","translog_ops","translog_ops_recovered","translog_ops_percent"]},{"type":"string"}]},"cat._types__CatSegmentsColumns":{"anyOf":[{"$ref":"./cat._types.json#/$defs/cat._types__CatSegmentsColumn"},{"type":"array","items":{"$ref":"./cat._types.json#/$defs/cat._types__CatSegmentsColumn"}}]},"cat._types__CatSegmentsColumn":{"anyOf":[{"enum":["index","shard","prirep","ip","segment","generation","docs.count","docs.deleted","size","size.memory","committed","searchable","version","compound","id"]},{"type":"string"}]},"cat._types__CatShardColumns":{"anyOf":[{"$ref":"./cat._types.json#/$defs/cat._types__CatShardColumn"},{"type":"array","items":{"$ref":"./cat._types.json#/$defs/cat._types__CatShardColumn"}}]},"cat._types__CatShardColumn":{"anyOf":[{"enum":["completion.size","dataset.size","dense_vector.value_count","docs","fielddata.evictions","fielddata.memory_size","flush.total","flush.total_time","get.current","get.exists_time","get.exists_total","get.missing_time","get.missing_total","get.time","get.total","id","index","indexing.delete_current","indexing.delete_time","indexing.delete_total","indexing.index_current","indexing.index_failed_due_to_version_conflict","indexing.index_failed","indexing.index_time","indexing.index_total","ip","merges.current","merges.current_docs","merges.current_size","merges.total","merges.total_docs","merges.total_size","merges.total_time","node","prirep","query_cache.evictions","query_cache.memory_size","recoverysource.type","refresh.time","refresh.total","search.fetch_current","search.fetch_time","search.fetch_total","search.open_contexts","search.query_current","search.query_time","search.query_total","search.scroll_current","search.scroll_time","search.scroll_total","segments.count","segments.fixed_bitset_memory","segments.index_writer_memory","segments.memory","segments.version_map_memory","seq_no.global_checkpoint","seq_no.local_checkpoint","seq_no.max","shard","dsparse_vector.value_count","state","store","suggest.current","suggest.time","suggest.total","sync_id","unassigned.at","unassigned.details","unassigned.for","unassigned.reason"]},{"type":"string"}]},"cat._types__CatSnapshotsColumns":{"anyOf":[{"$ref":"./cat._types.json#/$defs/cat._types__CatSnapshotsColumn"},{"type":"array","items":{"$ref":"./cat._types.json#/$defs/cat._types__CatSnapshotsColumn"}}]},"cat._types__CatSnapshotsColumn":{"anyOf":[{"enum":["id","repository","status","start_epoch","start_time","end_epoch","end_time","duration","indices","successful_shards","failed_shards","total_shards","reason"]},{"type":"string"}]},"cat._types__CatTasksColumns":{"anyOf":[{"$ref":"./cat._types.json#/$defs/cat._types__CatTasksColumn"},{"type":"array","items":{"$ref":"./cat._types.json#/$defs/cat._types__CatTasksColumn"}}]},"cat._types__CatTasksColumn":{"anyOf":[{"enum":["id","action","task_id","parent_task_id","type","start_time","timestamp","running_time_ns","running_time","node_id","ip","port","node","version","x_opaque_id"]},{"type":"string"}]},"cat._types__CatTemplatesColumns":{"anyOf":[{"$ref":"./cat._types.json#/$defs/cat._types__CatTemplatesColumn"},{"type":"array","items":{"$ref":"./cat._types.json#/$defs/cat._types__CatTemplatesColumn"}}]},"cat._types__CatTemplatesColumn":{"anyOf":[{"enum":["name","index_patterns","order","version","composed_of"]},{"type":"string"}]},"cat._types__CatThreadPoolColumns":{"anyOf":[{"$ref":"./cat._types.json#/$defs/cat._types__CatThreadPoolColumn"},{"type":"array","items":{"$ref":"./cat._types.json#/$defs/cat._types__CatThreadPoolColumn"}}]},"cat._types__CatThreadPoolColumn":{"anyOf":[{"enum":["active","completed","core","ephemeral_id","host","ip","keep_alive","largest","max","name","node_id","node_name","pid","pool_size","port","queue","queue_size","rejected","size","type"]},{"type":"string"}]},"cat._types__CatTransformColumns":{"anyOf":[{"$ref":"./cat._types.json#/$defs/cat._types__CatTransformColumn"},{"type":"array","items":{"$ref":"./cat._types.json#/$defs/cat._types__CatTransformColumn"}}]},"cat._types__CatTransformColumn":{"enum":["changes_last_detection_time","checkpoint","checkpoint_duration_time_exp_avg","checkpoint_progress","create_time","delete_time","description","dest_index","documents_deleted","documents_indexed","docs_per_second","documents_processed","frequency","id","index_failure","index_time","index_total","indexed_documents_exp_avg","last_search_time","max_page_search_size","pages_processed","pipeline","processed_documents_exp_avg","processing_time","project_routing","reason","search_failure","search_time","search_total","source_index","state","transform_type","trigger_count","version"]}}}

package/src/es/json/cat.recovery.json CHANGED Viewed

	@@ -1 +1 @@
1	- {"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"cat.recovery__RecoveryRecord":{"type":"object","properties":{"index":{"type":"string","description":"The index name."},"shard":{"type":"string","description":"The shard name."},"start_time":{"$ref":"./_types.json#/$defs/_types__DateTime","description":"The recovery start time.\nFor recoveries in the `created` stage (not yet started), this value is the Unix epoch (1970-01-01T00:00:00.000Z)."},"start_time_millis":{"description":"The recovery start time in epoch milliseconds.\nFor recoveries in the `created` stage (not yet started), this value is 0."},"stop_time":{"$ref":"./_types.json#/$defs/_types__DateTime","description":"The recovery stop time.\nFor recoveries that have not yet completed, this value is the Unix epoch (1970-01-01T00:00:00.000Z)."},"stop_time_millis":{"description":"The recovery stop time in epoch milliseconds.\nFor recoveries that have not yet completed, this value is 0."},"time":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The recovery time.\nFor recoveries in the `created` stage (not yet started), this value is 0."},"type":{"type":"string","description":"The recovery type."},"stage":{"type":"string","description":"The recovery stage."},"priority":{"type":"string","description":"The recovery priority.","x-availability":{"stack":{"since":"9.6.0"},"serverless":{}}},"source_host":{"type":"string","description":"The source host."},"source_node":{"type":"string","description":"The source node name."},"target_host":{"type":"string","description":"The target host."},"target_node":{"type":"string","description":"The target node name."},"repository":{"type":"string","description":"The repository name."},"snapshot":{"type":"string","description":"The snapshot name."},"files":{"type":"string","description":"The number of files to recover."},"files_recovered":{"type":"string","description":"The files recovered."},"files_percent":{"$ref":"./_types.json#/$defs/_types__Percentage","description":"The ratio of files recovered."},"files_total":{"type":"string","description":"The total number of files."},"bytes":{"type":"string","description":"The number of bytes to recover."},"bytes_recovered":{"type":"string","description":"The bytes recovered."},"bytes_percent":{"$ref":"./_types.json#/$defs/_types__Percentage","description":"The ratio of bytes recovered."},"bytes_total":{"type":"string","description":"The total number of bytes."},"translog_ops":{"type":"string","description":"The number of translog operations to recover."},"translog_ops_recovered":{"type":"string","description":"The translog operations recovered."},"translog_ops_percent":{"$ref":"./_types.json#/$defs/_types__Percentage","description":"The ratio of translog operations recovered."}}}}}
1	+ {"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"cat.recovery__RecoveryRecord":{"type":"object","properties":{"index":{"type":"string","description":"The index name."},"shard":{"type":"string","description":"The shard name."},"start_time":{"$ref":"./_types.json#/$defs/_types__DateTime","description":"The recovery start time.\nFor recoveries in the `created` stage (not yet started), this value is the Unix epoch (1970-01-01T00:00:00.000Z)."},"start_time_millis":{"description":"The recovery start time in epoch milliseconds.\nFor recoveries in the `created` stage (not yet started), this value is 0."},"stop_time":{"$ref":"./_types.json#/$defs/_types__DateTime","description":"The recovery stop time.\nFor recoveries that have not yet completed, this value is the Unix epoch (1970-01-01T00:00:00.000Z)."},"stop_time_millis":{"description":"The recovery stop time in epoch milliseconds.\nFor recoveries that have not yet completed, this value is 0."},"time":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The recovery time.\nFor recoveries in the `created` stage (not yet started), this value is 0."},"type":{"type":"string","description":"The recovery type."},"stage":{"type":"string","description":"The recovery stage."},"local_retries":{"type":"number","description":"The number of times this recovery has failed in a way which is retried locally (i.e. on the data node).","x-availability":{"stack":{"since":"9.6.0"},"serverless":{}}},"priority":{"type":"string","description":"The recovery priority.","x-availability":{"stack":{"since":"9.6.0"},"serverless":{}}},"source_host":{"type":"string","description":"The source host."},"source_node":{"type":"string","description":"The source node name."},"target_host":{"type":"string","description":"The target host."},"target_node":{"type":"string","description":"The target node name."},"repository":{"type":"string","description":"The repository name."},"snapshot":{"type":"string","description":"The snapshot name."},"files":{"type":"string","description":"The number of files to recover."},"files_recovered":{"type":"string","description":"The files recovered."},"files_percent":{"$ref":"./_types.json#/$defs/_types__Percentage","description":"The ratio of files recovered."},"files_total":{"type":"string","description":"The total number of files."},"bytes":{"type":"string","description":"The number of bytes to recover."},"bytes_recovered":{"type":"string","description":"The bytes recovered."},"bytes_percent":{"$ref":"./_types.json#/$defs/_types__Percentage","description":"The ratio of bytes recovered."},"bytes_total":{"type":"string","description":"The total number of bytes."},"translog_ops":{"type":"string","description":"The number of translog operations to recover."},"translog_ops_recovered":{"type":"string","description":"The translog operations recovered."},"translog_ops_percent":{"$ref":"./_types.json#/$defs/_types__Percentage","description":"The ratio of translog operations recovered."}}}}}

package/src/es/json/indices.recovery.json CHANGED Viewed

	@@ -1 +1 @@
1	- {"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"indices.recovery__RecoveryStatus":{"type":"object","properties":{"shards":{"type":"array","items":{"$ref":"./indices.recovery.json#/$defs/indices.recovery__ShardRecovery"}}},"required":["shards"]},"indices.recovery__ShardRecovery":{"type":"object","properties":{"id":{"type":"number"},"index":{"$ref":"./indices.recovery.json#/$defs/indices.recovery__RecoveryIndexStatus"},"primary":{"type":"boolean"},"source":{"$ref":"./indices.recovery.json#/$defs/indices.recovery__RecoveryOrigin"},"stage":{"$ref":"./indices.recovery.json#/$defs/indices.recovery__RecoveryStage","description":"The recovery stage."},"priority":{"$ref":"./indices.recovery.json#/$defs/indices.recovery__RecoveryPriority","description":"The recovery priority.","x-availability":{"stack":{"since":"9.6.0"},"serverless":{}}},"start":{"$ref":"./indices.recovery.json#/$defs/indices.recovery__RecoveryStartStatus"},"start_time":{"$ref":"./_types.json#/$defs/_types__DateTime","description":"The time the recovery started.\nFor recoveries in the `CREATED` stage (not yet started), this value is the Unix epoch (1970-01-01T00:00:00.000Z)."},"start_time_in_millis":{"description":"The time the recovery started, in milliseconds since the Unix epoch.\nFor recoveries in the `CREATED` stage (not yet started), this value is 0."},"stop_time":{"$ref":"./_types.json#/$defs/_types__DateTime","description":"The time the recovery completed. Only present for completed recoveries (`DONE` stage)."},"stop_time_in_millis":{"description":"The time the recovery completed, in milliseconds since the Unix epoch.\nOnly present for completed recoveries (`DONE` stage)."},"target":{"$ref":"./indices.recovery.json#/$defs/indices.recovery__RecoveryOrigin"},"total_time":{"$ref":"./_types.json#/$defs/_types__Duration"},"total_time_in_millis":{"description":"The total elapsed recovery time in milliseconds.\nFor recoveries in the `CREATED` stage (not yet started), this value is 0."},"translog":{"$ref":"./indices.recovery.json#/$defs/indices.recovery__TranslogStatus"},"type":{"$ref":"./indices.recovery.json#/$defs/indices.recovery__RecoveryType","description":"The recovery source type."},"verify_index":{"$ref":"./indices.recovery.json#/$defs/indices.recovery__VerifyIndex"}},"required":["id","index","primary","source","stage","start_time_in_millis","target","total_time_in_millis","translog","type","verify_index"]},"indices.recovery__RecoveryIndexStatus":{"type":"object","properties":{"bytes":{"$ref":"./indices.recovery.json#/$defs/indices.recovery__RecoveryBytes"},"files":{"$ref":"./indices.recovery.json#/$defs/indices.recovery__RecoveryFiles"},"size":{"$ref":"./indices.recovery.json#/$defs/indices.recovery__RecoveryBytes"},"source_throttle_time":{"$ref":"./_types.json#/$defs/_types__Duration"},"source_throttle_time_in_millis":{},"target_throttle_time":{"$ref":"./_types.json#/$defs/_types__Duration"},"target_throttle_time_in_millis":{},"total_time":{"$ref":"./_types.json#/$defs/_types__Duration"},"total_time_in_millis":{}},"required":["files","size","source_throttle_time_in_millis","target_throttle_time_in_millis","total_time_in_millis"]},"indices.recovery__RecoveryBytes":{"type":"object","properties":{"percent":{"$ref":"./_types.json#/$defs/_types__Percentage"},"recovered":{"$ref":"./_types.json#/$defs/_types__ByteSize"},"recovered_in_bytes":{"$ref":"./_types.json#/$defs/_types__ByteSize"},"recovered_from_snapshot":{"$ref":"./_types.json#/$defs/_types__ByteSize"},"recovered_from_snapshot_in_bytes":{"$ref":"./_types.json#/$defs/_types__ByteSize"},"reused":{"$ref":"./_types.json#/$defs/_types__ByteSize"},"reused_in_bytes":{"$ref":"./_types.json#/$defs/_types__ByteSize"},"total":{"$ref":"./_types.json#/$defs/_types__ByteSize"},"total_in_bytes":{"$ref":"./_types.json#/$defs/_types__ByteSize"}},"required":["percent","recovered_in_bytes","reused_in_bytes","total_in_bytes"]},"indices.recovery__RecoveryFiles":{"type":"object","properties":{"details":{"type":"array","items":{"$ref":"./indices.recovery.json#/$defs/indices.recovery__FileDetails"}},"percent":{"$ref":"./_types.json#/$defs/_types__Percentage"},"recovered":{"type":"number"},"reused":{"type":"number"},"total":{"type":"number"}},"required":["percent","recovered","reused","total"]},"indices.recovery__FileDetails":{"type":"object","properties":{"length":{"type":"number"},"name":{"type":"string"},"recovered":{"type":"number"}},"required":["length","name","recovered"]},"indices.recovery__RecoveryOrigin":{"type":"object","properties":{"hostname":{"type":"string"},"host":{"type":"string"},"transport_address":{"type":"string"},"id":{"type":"string"},"ip":{"type":"string"},"name":{"type":"string"},"bootstrap_new_history_uuid":{"type":"boolean"},"repository":{"type":"string"},"snapshot":{"type":"string"},"version":{"type":"string"},"restoreUUID":{"type":"string"},"index":{"type":"string"}}},"indices.recovery__RecoveryStage":{"enum":["CREATED","INIT","INDEX","VERIFY_INDEX","TRANSLOG","FINALIZE","DONE"]},"indices.recovery__RecoveryPriority":{"enum":["UNASSIGNED_NEW_PRIMARY","UNASSIGNED_UNEXPECTED","UNASSIGNED_EXPECTED","RELOCATION_CAN_REMAIN_NO","RELOCATION_CAN_REMAIN_NOT_PREFERRED","RELOCATE_REBALANCING","UNKNOWN"]},"indices.recovery__RecoveryStartStatus":{"type":"object","properties":{"check_index_time":{"$ref":"./_types.json#/$defs/_types__Duration"},"check_index_time_in_millis":{},"total_time":{"$ref":"./_types.json#/$defs/_types__Duration"},"total_time_in_millis":{}},"required":["check_index_time_in_millis","total_time_in_millis"]},"indices.recovery__TranslogStatus":{"type":"object","properties":{"percent":{"$ref":"./_types.json#/$defs/_types__Percentage"},"recovered":{"type":"number"},"total":{"type":"number"},"total_on_start":{"type":"number"},"total_time":{"$ref":"./_types.json#/$defs/_types__Duration"},"total_time_in_millis":{}},"required":["percent","recovered","total","total_on_start","total_time_in_millis"]},"indices.recovery__RecoveryType":{"enum":["EMPTY_STORE","EXISTING_STORE","LOCAL_SHARDS","PEER","SNAPSHOT"]},"indices.recovery__VerifyIndex":{"type":"object","properties":{"check_index_time":{"$ref":"./_types.json#/$defs/_types__Duration"},"check_index_time_in_millis":{},"total_time":{"$ref":"./_types.json#/$defs/_types__Duration"},"total_time_in_millis":{}},"required":["check_index_time_in_millis","total_time_in_millis"]}}}
1	+ {"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"indices.recovery__RecoveryStatus":{"type":"object","properties":{"shards":{"type":"array","items":{"$ref":"./indices.recovery.json#/$defs/indices.recovery__ShardRecovery"}}},"required":["shards"]},"indices.recovery__ShardRecovery":{"type":"object","properties":{"id":{"type":"number"},"index":{"$ref":"./indices.recovery.json#/$defs/indices.recovery__RecoveryIndexStatus"},"primary":{"type":"boolean"},"source":{"$ref":"./indices.recovery.json#/$defs/indices.recovery__RecoveryOrigin"},"stage":{"$ref":"./indices.recovery.json#/$defs/indices.recovery__RecoveryStage","description":"The recovery stage."},"local_retries":{"type":"number","description":"The number of times this recovery has failed in a way which is retried locally (i.e. on the data node).","x-availability":{"stack":{"since":"9.6.0"},"serverless":{}}},"priority":{"$ref":"./indices.recovery.json#/$defs/indices.recovery__RecoveryPriority","description":"The recovery priority.","x-availability":{"stack":{"since":"9.6.0"},"serverless":{}}},"start":{"$ref":"./indices.recovery.json#/$defs/indices.recovery__RecoveryStartStatus"},"start_time":{"$ref":"./_types.json#/$defs/_types__DateTime","description":"The time the recovery started.\nFor recoveries in the `CREATED` stage (not yet started), this value is the Unix epoch (1970-01-01T00:00:00.000Z)."},"start_time_in_millis":{"description":"The time the recovery started, in milliseconds since the Unix epoch.\nFor recoveries in the `CREATED` stage (not yet started), this value is 0."},"stop_time":{"$ref":"./_types.json#/$defs/_types__DateTime","description":"The time the recovery completed. Only present for completed recoveries (`DONE` stage)."},"stop_time_in_millis":{"description":"The time the recovery completed, in milliseconds since the Unix epoch.\nOnly present for completed recoveries (`DONE` stage)."},"target":{"$ref":"./indices.recovery.json#/$defs/indices.recovery__RecoveryOrigin"},"total_time":{"$ref":"./_types.json#/$defs/_types__Duration"},"total_time_in_millis":{"description":"The total elapsed recovery time in milliseconds.\nFor recoveries in the `CREATED` stage (not yet started), this value is 0."},"translog":{"$ref":"./indices.recovery.json#/$defs/indices.recovery__TranslogStatus"},"type":{"$ref":"./indices.recovery.json#/$defs/indices.recovery__RecoveryType","description":"The recovery source type."},"verify_index":{"$ref":"./indices.recovery.json#/$defs/indices.recovery__VerifyIndex"}},"required":["id","index","primary","source","stage","start_time_in_millis","target","total_time_in_millis","translog","type","verify_index"]},"indices.recovery__RecoveryIndexStatus":{"type":"object","properties":{"bytes":{"$ref":"./indices.recovery.json#/$defs/indices.recovery__RecoveryBytes"},"files":{"$ref":"./indices.recovery.json#/$defs/indices.recovery__RecoveryFiles"},"size":{"$ref":"./indices.recovery.json#/$defs/indices.recovery__RecoveryBytes"},"source_throttle_time":{"$ref":"./_types.json#/$defs/_types__Duration"},"source_throttle_time_in_millis":{},"target_throttle_time":{"$ref":"./_types.json#/$defs/_types__Duration"},"target_throttle_time_in_millis":{},"total_time":{"$ref":"./_types.json#/$defs/_types__Duration"},"total_time_in_millis":{}},"required":["files","size","source_throttle_time_in_millis","target_throttle_time_in_millis","total_time_in_millis"]},"indices.recovery__RecoveryBytes":{"type":"object","properties":{"percent":{"$ref":"./_types.json#/$defs/_types__Percentage"},"recovered":{"$ref":"./_types.json#/$defs/_types__ByteSize"},"recovered_in_bytes":{"$ref":"./_types.json#/$defs/_types__ByteSize"},"recovered_from_snapshot":{"$ref":"./_types.json#/$defs/_types__ByteSize"},"recovered_from_snapshot_in_bytes":{"$ref":"./_types.json#/$defs/_types__ByteSize"},"reused":{"$ref":"./_types.json#/$defs/_types__ByteSize"},"reused_in_bytes":{"$ref":"./_types.json#/$defs/_types__ByteSize"},"total":{"$ref":"./_types.json#/$defs/_types__ByteSize"},"total_in_bytes":{"$ref":"./_types.json#/$defs/_types__ByteSize"}},"required":["percent","recovered_in_bytes","reused_in_bytes","total_in_bytes"]},"indices.recovery__RecoveryFiles":{"type":"object","properties":{"details":{"type":"array","items":{"$ref":"./indices.recovery.json#/$defs/indices.recovery__FileDetails"}},"percent":{"$ref":"./_types.json#/$defs/_types__Percentage"},"recovered":{"type":"number"},"reused":{"type":"number"},"total":{"type":"number"}},"required":["percent","recovered","reused","total"]},"indices.recovery__FileDetails":{"type":"object","properties":{"length":{"type":"number"},"name":{"type":"string"},"recovered":{"type":"number"}},"required":["length","name","recovered"]},"indices.recovery__RecoveryOrigin":{"type":"object","properties":{"hostname":{"type":"string"},"host":{"type":"string"},"transport_address":{"type":"string"},"id":{"type":"string"},"ip":{"type":"string"},"name":{"type":"string"},"bootstrap_new_history_uuid":{"type":"boolean"},"repository":{"type":"string"},"snapshot":{"type":"string"},"version":{"type":"string"},"restoreUUID":{"type":"string"},"index":{"type":"string"}}},"indices.recovery__RecoveryStage":{"enum":["CREATED","INIT","INDEX","VERIFY_INDEX","TRANSLOG","FINALIZE","DONE"]},"indices.recovery__RecoveryPriority":{"enum":["UNASSIGNED_NEW_PRIMARY","UNASSIGNED_UNEXPECTED","UNASSIGNED_EXPECTED","RELOCATION_CAN_REMAIN_NO","RELOCATION_CAN_REMAIN_NOT_PREFERRED","RELOCATE_REBALANCING","UNKNOWN"]},"indices.recovery__RecoveryStartStatus":{"type":"object","properties":{"check_index_time":{"$ref":"./_types.json#/$defs/_types__Duration"},"check_index_time_in_millis":{},"total_time":{"$ref":"./_types.json#/$defs/_types__Duration"},"total_time_in_millis":{}},"required":["check_index_time_in_millis","total_time_in_millis"]},"indices.recovery__TranslogStatus":{"type":"object","properties":{"percent":{"$ref":"./_types.json#/$defs/_types__Percentage"},"recovered":{"type":"number"},"total":{"type":"number"},"total_on_start":{"type":"number"},"total_time":{"$ref":"./_types.json#/$defs/_types__Duration"},"total_time_in_millis":{}},"required":["percent","recovered","total","total_on_start","total_time_in_millis"]},"indices.recovery__RecoveryType":{"enum":["EMPTY_STORE","EXISTING_STORE","LOCAL_SHARDS","PEER","SNAPSHOT"]},"indices.recovery__VerifyIndex":{"type":"object","properties":{"check_index_time":{"$ref":"./_types.json#/$defs/_types__Duration"},"check_index_time_in_millis":{},"total_time":{"$ref":"./_types.json#/$defs/_types__Duration"},"total_time_in_millis":{}},"required":["check_index_time_in_millis","total_time_in_millis"]}}}

package/src/es/json/security._types.json CHANGED Viewed

	@@ -1 +1 @@
1	- {"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"security._types__GrantType":{"enum":["password","access_token"]},"security._types__UserProfileWithMetadata":{"type":"object","properties":{"uid":{"type":"string"},"user":{"$ref":"./security._types.json#/$defs/security._types__UserProfileUser"},"data":{"type":"object","additionalProperties":{}},"labels":{"type":"object","additionalProperties":{}},"enabled":{"type":"boolean"},"last_synchronized":{"type":"number"},"_doc":{"$ref":"./security._types.json#/$defs/security._types__UserProfileHitMetadata"}},"required":["uid","user","data","labels","last_synchronized","_doc"]},"security._types__UserProfileUser":{"type":"object","properties":{"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"full_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"realm_name":{"type":"string"},"realm_domain":{"type":"string"},"roles":{"type":"array","items":{"type":"string"}},"username":{"type":"string"}},"required":["realm_name","roles","username"]},"security._types__UserProfileHitMetadata":{"type":"object","properties":{"_primary_term":{"type":"number"},"_seq_no":{"type":"number"}},"required":["_primary_term","_seq_no"]},"security._types__CredentialManagedBy":{"enum":["cloud","elasticsearch"]},"security._types__RealmInfo":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"}},"required":["name","type"]},"security._types__BulkError":{"type":"object","properties":{"count":{"type":"number","description":"The number of errors"},"details":{"type":"object","additionalProperties":{"$ref":"./_types.json#/$defs/_types__ErrorCause"},"description":"Details about the errors, keyed by role name"}},"required":["count","details"]},"security._types__RoleDescriptor":{"type":"object","properties":{"cluster":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__ClusterPrivilege"},"description":"A list of cluster privileges. These privileges define the cluster level actions that API keys are able to execute."},"indices":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__IndicesPrivileges"},"description":"A list of indices permissions entries."},"remote_indices":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__RemoteIndicesPrivileges"},"description":"A list of indices permissions for remote clusters.","x-availability":{"stack":{"since":"8.14.0"}}},"remote_cluster":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__RemoteClusterPrivileges"},"description":"A list of cluster permissions for remote clusters.\nNOTE: This is limited a subset of the cluster permissions.","x-availability":{"stack":{"since":"8.15.0"}}},"global":{"anyOf":[{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__GlobalPrivilege"}},{"$ref":"./security._types.json#/$defs/security._types__GlobalPrivilege"}],"description":"An object defining global privileges. A global privilege is a form of cluster privilege that is request-aware.","x-availability":{"stack":{}}},"applications":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__ApplicationPrivileges"},"description":"A list of application privilege entries"},"metadata":{"$ref":"./_types.json#/$defs/_types__Metadata","description":"Optional meta-data. Within the metadata object, keys that begin with `_` are reserved for system usage."},"run_as":{"type":"array","items":{"type":"string"},"description":"A list of users that the API keys can impersonate.\nNOTE: In Elastic Cloud Serverless, the run-as feature is disabled.\nFor API compatibility, you can still specify an empty `run_as` field, but a non-empty list will be rejected."},"description":{"type":"string","description":"Optional description of the role descriptor"},"restriction":{"$ref":"./security._types.json#/$defs/security._types__Restriction","description":"Restriction for when the role descriptor is allowed to be effective."},"transient_metadata":{"type":"object","additionalProperties":{}}}},"security._types__ClusterPrivilege":{"anyOf":[{"enum":["all","cancel_task","create_snapshot","cross_cluster_replication","cross_cluster_search","delegate_pki","grant_api_key","manage","manage_api_key","manage_autoscaling","manage_behavioral_analytics","manage_ccr","manage_data_frame_transforms","manage_data_stream_global_retention","manage_enrich","manage_esql","manage_ilm","manage_index_templates","manage_inference","manage_ingest_pipelines","manage_logstash_pipelines","manage_ml","manage_oidc","manage_own_api_key","manage_pipeline","manage_reindex","manage_rollup","manage_saml","manage_search_application","manage_search_query_rules","manage_search_synonyms","manage_security","manage_service_account","manage_slm","manage_token","manage_transform","manage_user_profile","manage_watcher","monitor","monitor_data_frame_transforms","monitor_data_stream_global_retention","monitor_enrich","monitor_esql","monitor_inference","monitor_ml","monitor_reindex","monitor_rollup","monitor_snapshot","monitor_stats","monitor_text_structure","monitor_transform","monitor_watcher","none","post_behavioral_analytics_event","read_ccr","read_fleet_secrets","read_ilm","read_pipeline","read_security","read_slm","transport_client","write_connector_secrets","write_fleet_secrets","read_project_routing","manage_project_routing"]},{"type":"string"}]},"security._types__IndicesPrivileges":{"type":"object","properties":{"field_security":{"$ref":"./security._types.json#/$defs/security._types__FieldSecurity","description":"The document fields that the owners of the role have read access to."},"names":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"A list of indices (or index name patterns) to which the permissions in this entry apply."},"privileges":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__IndexPrivilege"},"description":"The index level privileges that owners of the role have on the specified indices."},"query":{"$ref":"./security._types.json#/$defs/security._types__IndicesPrivilegesQuery","description":"A search query that defines the documents the owners of the role have access to. A document within the specified indices must match this query for it to be accessible by the owners of the role."},"allow_restricted_indices":{"type":"boolean","description":"Set to `true` if using wildcard or regular expressions for patterns that cover restricted indices. Implicitly, restricted indices have limited privileges that can cause pattern tests to fail. If restricted indices are explicitly included in the `names` list, Elasticsearch checks privileges against these indices regardless of the value set for `allow_restricted_indices`.","x-availability":{"stack":{}}}},"required":["names","privileges"]},"security._types__FieldSecurity":{"type":"object","properties":{"except":{"$ref":"./_types.json#/$defs/_types__Fields"},"grant":{"$ref":"./_types.json#/$defs/_types__Fields"}}},"security._types__IndexPrivilege":{"anyOf":[{"enum":["all","auto_configure","create","create_doc","create_index","create_view","cross_cluster_replication","cross_cluster_replication_internal","delete","delete_index","delete_view","index","maintenance","manage","manage_data_stream_lifecycle","manage_follow_index","manage_ilm","manage_leader_index","manage_view","monitor","none","read","read_cross_cluster","read_view_metadata","view_index_metadata","write"]},{"type":"string"}]},"security._types__IndicesPrivilegesQuery":{"anyOf":[{"type":"string"},{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer"},{"$ref":"./security._types.json#/$defs/security._types__RoleTemplateQuery"}],"description":"While creating or updating a role you can provide either a JSON structure or a string to the API.\nHowever, the response provided by Elasticsearch will only be string with a json-as-text content.\n\nSince this is embedded in `IndicesPrivileges`, the same structure is used for clarity in both contexts."},"security._types__RoleTemplateQuery":{"type":"object","properties":{"template":{"$ref":"./security._types.json#/$defs/security._types__RoleTemplateScript","description":"When you create a role, you can specify a query that defines the document level security permissions. You can optionally\nuse Mustache templates in the role query to insert the username of the current authenticated user into the role.\nLike other places in Elasticsearch that support templating or scripting, you can specify inline, stored, or file-based\ntemplates and define custom parameters. You access the details for the current authenticated user through the _user parameter."}}},"security._types__RoleTemplateScript":{"type":"object","properties":{"source":{"$ref":"./security._types.json#/$defs/security._types__RoleTemplateInlineQuery"},"id":{"type":"string","description":"The `id` for a stored script."},"params":{"type":"object","additionalProperties":{},"description":"Specifies any named parameters that are passed into the script as variables.\nUse parameters instead of hard-coded values to decrease compile time."},"lang":{"$ref":"./_types.json#/$defs/_types__ScriptLanguage","description":"Specifies the language the script is written in."},"options":{"type":"object","additionalProperties":{"type":"string"}}}},"security._types__RoleTemplateInlineQuery":{"anyOf":[{"type":"string"},{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer"}]},"security._types__RemoteIndicesPrivileges":{"type":"object","properties":{"clusters":{"$ref":"./_types.json#/$defs/_types__Names","description":"A list of cluster aliases to which the permissions in this entry apply."},"field_security":{"$ref":"./security._types.json#/$defs/security._types__FieldSecurity","description":"The document fields that the owners of the role have read access to."},"names":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"A list of indices (or index name patterns) to which the permissions in this entry apply."},"privileges":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__IndexPrivilege"},"description":"The index level privileges that owners of the role have on the specified indices."},"query":{"$ref":"./security._types.json#/$defs/security._types__IndicesPrivilegesQuery","description":"A search query that defines the documents the owners of the role have access to. A document within the specified indices must match this query for it to be accessible by the owners of the role."},"allow_restricted_indices":{"type":"boolean","description":"Set to `true` if using wildcard or regular expressions for patterns that cover restricted indices. Implicitly, restricted indices have limited privileges that can cause pattern tests to fail. If restricted indices are explicitly included in the `names` list, Elasticsearch checks privileges against these indices regardless of the value set for `allow_restricted_indices`.","x-availability":{"stack":{}}}},"required":["clusters","names","privileges"],"description":"The subset of index level privileges that can be defined for remote clusters."},"security._types__RemoteClusterPrivileges":{"type":"object","properties":{"clusters":{"$ref":"./_types.json#/$defs/_types__Names","description":"A list of cluster aliases to which the permissions in this entry apply."},"privileges":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__RemoteClusterPrivilege"},"description":"The cluster level privileges that owners of the role have on the remote cluster."}},"required":["clusters","privileges"],"description":"The subset of cluster level privileges that can be defined for remote clusters."},"security._types__RemoteClusterPrivilege":{"enum":["monitor_enrich","monitor_stats"]},"security._types__GlobalPrivilege":{"type":"object","properties":{"application":{"$ref":"./security._types.json#/$defs/security._types__ApplicationGlobalUserPrivileges"},"data_source":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__DataSourcePrivileges"},"description":"A list of data source privilege entries, used to grant access to ES\|QL data sources.","x-availability":{"stack":{"since":"9.5.0"}}}},"required":["application"]},"security._types__ApplicationGlobalUserPrivileges":{"type":"object","properties":{"manage":{"$ref":"./security._types.json#/$defs/security._types__ManageUserPrivileges"}},"required":["manage"]},"security._types__ManageUserPrivileges":{"type":"object","properties":{"applications":{"type":"array","items":{"type":"string"}}},"required":["applications"]},"security._types__DataSourcePrivileges":{"type":"object","properties":{"names":{"type":"array","items":{"type":"string"},"description":"A list of data source names or wildcard patterns to which the permissions in this entry apply."},"privileges":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__DataSourcePrivilege"},"description":"The data source privileges that owners of the role have for the specified data sources."}},"required":["names","privileges"]},"security._types__DataSourcePrivilege":{"anyOf":[{"enum":["create","delete","read_metadata","read","manage"]},{"type":"string"}]},"security._types__ApplicationPrivileges":{"type":"object","properties":{"application":{"type":"string","description":"The name of the application to which this entry applies."},"privileges":{"type":"array","items":{"type":"string"},"description":"A list of strings, where each element is the name of an application privilege or action."},"resources":{"type":"array","items":{"type":"string"},"description":"A list resources to which the privileges are applied."}},"required":["application","privileges","resources"]},"security._types__Restriction":{"type":"object","properties":{"workflows":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__RestrictionWorkflow"},"description":"A list of workflows to which the API key is restricted.\nNOTE: In order to use a role restriction, an API key must be created with a single role descriptor."}},"required":["workflows"]},"security._types__RestrictionWorkflow":{"anyOf":[{"enum":["search_application_query"]},{"type":"string"}]},"security._types__ClusterNode":{"type":"object","properties":{"name":{"type":"string"}},"required":["name"]},"security._types__Access":{"type":"object","properties":{"replication":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__ReplicationAccess"},"description":"A list of indices permission entries for cross-cluster replication."},"search":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__SearchAccess"},"description":"A list of indices permission entries for cross-cluster search."}}},"security._types__ReplicationAccess":{"type":"object","properties":{"names":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"A list of indices (or index name patterns) to which the permissions in this entry apply."},"allow_restricted_indices":{"type":"boolean","description":"This needs to be set to true if the patterns in the names field should cover system indices."}},"required":["names"]},"security._types__SearchAccess":{"type":"object","properties":{"field_security":{"$ref":"./security._types.json#/$defs/security._types__FieldSecurity","description":"The document fields that the owners of the role have read access to."},"names":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"A list of indices (or index name patterns) to which the permissions in this entry apply."},"query":{"$ref":"./security._types.json#/$defs/security._types__IndicesPrivilegesQuery","description":"A search query that defines the documents the owners of the role have access to. A document within the specified indices must match this query for it to be accessible by the owners of the role."},"allow_restricted_indices":{"type":"boolean","description":"Set to `true` if using wildcard or regular expressions for patterns that cover restricted indices. Implicitly, restricted indices have limited privileges that can cause pattern tests to fail. If restricted indices are explicitly included in the `names` list, Elasticsearch checks privileges against these indices regardless of the value set for `allow_restricted_indices`.","x-availability":{"stack":{}}}},"required":["names"]},"security._types__ApiKey":{"type":"object","properties":{"id":{"type":"string","description":"Id for the API key"},"name":{"type":"string","description":"Name of the API key."},"type":{"$ref":"./security._types.json#/$defs/security._types__ApiKeyType","description":"The type of the API key (e.g. `rest` or `cross_cluster`).","x-availability":{"stack":{"since":"8.10.0"},"serverless":{}}},"creation":{"description":"Creation time for the API key in milliseconds."},"expiration":{"description":"Expiration time for the API key in milliseconds."},"invalidated":{"type":"boolean","description":"Invalidation status for the API key.\nIf the key has been invalidated, it has a value of `true`. Otherwise, it is `false`."},"invalidation":{"description":"If the key has been invalidated, invalidation time in milliseconds.","x-availability":{"stack":{"since":"8.12.0"},"serverless":{}}},"username":{"type":"string","description":"Principal for which this API key was created"},"realm":{"type":"string","description":"Realm name of the principal for which this API key was created."},"realm_type":{"type":"string","description":"Realm type of the principal for which this API key was created","x-availability":{"stack":{"since":"8.14.0"},"serverless":{}}},"metadata":{"$ref":"./_types.json#/$defs/_types__Metadata","description":"Metadata of the API key","x-availability":{"stack":{"since":"7.13.0"},"serverless":{}}},"role_descriptors":{"type":"object","additionalProperties":{"$ref":"./security._types.json#/$defs/security._types__RoleDescriptor"},"description":"The role descriptors assigned to this API key when it was created or last updated.\nAn empty role descriptor means the API key inherits the owner user’s permissions."},"limited_by":{"type":"array","items":{"type":"object","additionalProperties":{"$ref":"./security._types.json#/$defs/security._types__RoleDescriptor"}},"description":"The owner user’s permissions associated with the API key.\nIt is a point-in-time snapshot captured at creation and subsequent updates.\nAn API key’s effective permissions are an intersection of its assigned privileges and the owner user’s permissions.","x-availability":{"stack":{"since":"8.5.0"},"serverless":{}}},"access":{"$ref":"./security._types.json#/$defs/security._types__Access","description":"The access granted to cross-cluster API keys.\nThe access is composed of permissions for cross cluster search and cross cluster replication.\nAt least one of them must be specified.\nWhen specified, the new access assignment fully replaces the previously assigned access.","x-availability":{"stack":{"since":"8.10.0"},"serverless":{}}},"certificate_identity":{"type":"string","description":"The certificate identity associated with a cross-cluster API key.\nRestricts the API key to connections authenticated by a specific TLS certificate.\nOnly applicable to cross-cluster API keys.","x-availability":{"stack":{"since":"9.3.0"}}},"profile_uid":{"type":"string","description":"The profile uid for the API key owner principal, if requested and if it exists","x-availability":{"stack":{"since":"8.14.0"},"serverless":{}}},"_sort":{"$ref":"./_types.json#/$defs/_types__SortResults","description":"Sorting values when using the `sort` parameter with the `security.query_api_keys` API."}},"required":["id","name","type","creation","invalidated","username","realm","metadata"]},"security._types__ApiKeyType":{"enum":["rest","cross_cluster"]},"security._types__RoleTemplate":{"type":"object","properties":{"format":{"$ref":"./security._types.json#/$defs/security._types__TemplateFormat"},"template":{"$ref":"./_types.json#/$defs/_types__Script"}},"required":["template"]},"security._types__TemplateFormat":{"enum":["string","json"]},"security._types__RoleMapping":{"type":"object","properties":{"enabled":{"type":"boolean"},"metadata":{"$ref":"./_types.json#/$defs/_types__Metadata"},"roles":{"type":"array","items":{"type":"string"}},"role_templates":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__RoleTemplate"}},"rules":{"$ref":"./security._types.json#/$defs/security._types__RoleMappingRule"}},"required":["enabled","metadata","rules"]},"security._types__RoleMappingRule":{"type":"object","properties":{"any":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__RoleMappingRule"}},"all":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__RoleMappingRule"}},"field":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"./_types.json#/$defs/_types__FieldValue"},{"type":"array","items":{"$ref":"./_types.json#/$defs/_types__FieldValue"}}]},"minProperties":1,"maxProperties":1},"except":{"$ref":"./security._types.json#/$defs/security._types__RoleMappingRule"}}},"security._types__RoleDescriptorRead":{"type":"object","properties":{"cluster":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__ClusterPrivilege"},"description":"A list of cluster privileges. These privileges define the cluster level actions that API keys are able to execute."},"indices":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__IndicesPrivileges"},"description":"A list of indices permissions entries."},"remote_indices":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__RemoteIndicesPrivileges"},"description":"A list of indices permissions for remote clusters.","x-availability":{"stack":{"since":"8.14.0"}}},"remote_cluster":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__RemoteClusterPrivileges"},"description":"A list of cluster permissions for remote clusters.\nNOTE: This is limited a subset of the cluster permissions.","x-availability":{"stack":{"since":"8.15.0"}}},"global":{"anyOf":[{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__GlobalPrivilege"}},{"$ref":"./security._types.json#/$defs/security._types__GlobalPrivilege"}],"description":"An object defining global privileges. A global privilege is a form of cluster privilege that is request-aware.","x-availability":{"stack":{}}},"applications":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__ApplicationPrivileges"},"description":"A list of application privilege entries"},"metadata":{"$ref":"./_types.json#/$defs/_types__Metadata","description":"Optional meta-data. Within the metadata object, keys that begin with `_` are reserved for system usage."},"run_as":{"type":"array","items":{"type":"string"},"description":"A list of users that the API keys can impersonate.\nNOTE: In Elastic Cloud Serverless, the run-as feature is disabled.\nFor API compatibility, you can still specify an empty `run_as` field, but a non-empty list will be rejected."},"description":{"type":"string","description":"Optional description of the role descriptor"},"restriction":{"$ref":"./security._types.json#/$defs/security._types__Restriction","description":"Restriction for when the role descriptor is allowed to be effective."},"transient_metadata":{"type":"object","additionalProperties":{}}},"required":["cluster","indices"]},"security._types__SecuritySettings":{"type":"object","properties":{"index":{"$ref":"./indices._types.json#/$defs/indices._types__IndexSettings"}}},"security._types__NodeSecurityStats":{"type":"object","properties":{"roles":{"$ref":"./security._types.json#/$defs/security._types__RolesStats","description":"Role statistics."}},"required":["roles"]},"security._types__RolesStats":{"type":"object","properties":{"dls":{"$ref":"./xpack.usage.json#/$defs/xpack.usage__SecurityRolesDls","description":"Document-level security (DLS) statistics."}},"required":["dls"]},"security._types__User":{"type":"object","properties":{"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"full_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"metadata":{"$ref":"./_types.json#/$defs/_types__Metadata"},"roles":{"type":"array","items":{"type":"string"}},"username":{"type":"string"},"enabled":{"type":"boolean"},"profile_uid":{"type":"string"}},"required":["metadata","roles","username","enabled"]},"security._types__UserIndicesPrivileges":{"type":"object","properties":{"field_security":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__FieldSecurity"},"description":"The document fields that the owners of the role have read access to."},"names":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"A list of indices (or index name patterns) to which the permissions in this entry apply."},"privileges":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__IndexPrivilege"},"description":"The index level privileges that owners of the role have on the specified indices."},"query":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__IndicesPrivilegesQuery"},"description":"Search queries that define the documents the user has access to. A document within the specified indices must match these queries for it to be accessible by the owners of the role."},"allow_restricted_indices":{"type":"boolean","description":"Set to `true` if using wildcard or regular expressions for patterns that cover restricted indices. Implicitly, restricted indices have limited privileges that can cause pattern tests to fail. If restricted indices are explicitly included in the `names` list, Elasticsearch checks privileges against these indices regardless of the value set for `allow_restricted_indices`."}},"required":["names","privileges","allow_restricted_indices"]},"security._types__RemoteUserIndicesPrivileges":{"type":"object","properties":{"clusters":{"type":"array","items":{"type":"string"}},"field_security":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__FieldSecurity"},"description":"The document fields that the owners of the role have read access to."},"names":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"A list of indices (or index name patterns) to which the permissions in this entry apply."},"privileges":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__IndexPrivilege"},"description":"The index level privileges that owners of the role have on the specified indices."},"query":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__IndicesPrivilegesQuery"},"description":"Search queries that define the documents the user has access to. A document within the specified indices must match these queries for it to be accessible by the owners of the role."},"allow_restricted_indices":{"type":"boolean","description":"Set to `true` if using wildcard or regular expressions for patterns that cover restricted indices. Implicitly, restricted indices have limited privileges that can cause pattern tests to fail. If restricted indices are explicitly included in the `names` list, Elasticsearch checks privileges against these indices regardless of the value set for `allow_restricted_indices`."}},"required":["clusters","names","privileges","allow_restricted_indices"]},"security._types__CreatedStatus":{"type":"object","properties":{"created":{"type":"boolean"}},"required":["created"]},"security._types__UserProfile":{"type":"object","properties":{"uid":{"type":"string"},"user":{"$ref":"./security._types.json#/$defs/security._types__UserProfileUser"},"data":{"type":"object","additionalProperties":{}},"labels":{"type":"object","additionalProperties":{}},"enabled":{"type":"boolean"}},"required":["uid","user","data","labels"]}}}
1	+ {"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"security._types__GrantType":{"enum":["password","access_token"]},"security._types__UserProfileWithMetadata":{"type":"object","properties":{"uid":{"type":"string"},"user":{"$ref":"./security._types.json#/$defs/security._types__UserProfileUser"},"data":{"type":"object","additionalProperties":{}},"labels":{"type":"object","additionalProperties":{}},"enabled":{"type":"boolean"},"last_synchronized":{"type":"number"},"_doc":{"$ref":"./security._types.json#/$defs/security._types__UserProfileHitMetadata"}},"required":["uid","user","data","labels","last_synchronized","_doc"]},"security._types__UserProfileUser":{"type":"object","properties":{"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"full_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"realm_name":{"type":"string"},"realm_domain":{"type":"string"},"roles":{"type":"array","items":{"type":"string"}},"username":{"type":"string"}},"required":["realm_name","roles","username"]},"security._types__UserProfileHitMetadata":{"type":"object","properties":{"_primary_term":{"type":"number"},"_seq_no":{"type":"number"}},"required":["_primary_term","_seq_no"]},"security._types__CredentialManagedBy":{"enum":["cloud","elasticsearch"]},"security._types__RealmInfo":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"}},"required":["name","type"]},"security._types__BulkError":{"type":"object","properties":{"count":{"type":"number","description":"The number of errors"},"details":{"type":"object","additionalProperties":{"$ref":"./_types.json#/$defs/_types__ErrorCause"},"description":"Details about the errors, keyed by role name"}},"required":["count","details"]},"security._types__RoleDescriptor":{"type":"object","properties":{"cluster":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__ClusterPrivilege"},"description":"A list of cluster privileges. These privileges define the cluster level actions that API keys are able to execute."},"indices":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__IndicesPrivileges"},"description":"A list of indices permissions entries."},"remote_indices":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__RemoteIndicesPrivileges"},"description":"A list of indices permissions for remote clusters.","x-availability":{"stack":{"since":"8.14.0"}}},"remote_cluster":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__RemoteClusterPrivileges"},"description":"A list of cluster permissions for remote clusters.\nNOTE: This is limited a subset of the cluster permissions.","x-availability":{"stack":{"since":"8.15.0"}}},"global":{"$ref":"./security._types.json#/$defs/security._types__GlobalPrivilege","description":"An object defining global privileges. A global privilege is a form of cluster privilege that is request-aware.","x-availability":{"stack":{}}},"applications":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__ApplicationPrivileges"},"description":"A list of application privilege entries"},"metadata":{"$ref":"./_types.json#/$defs/_types__Metadata","description":"Optional meta-data. Within the metadata object, keys that begin with `_` are reserved for system usage."},"run_as":{"type":"array","items":{"type":"string"},"description":"A list of users that the API keys can impersonate.\nNOTE: In Elastic Cloud Serverless, the run-as feature is disabled.\nFor API compatibility, you can still specify an empty `run_as` field, but a non-empty list will be rejected."},"description":{"type":"string","description":"Optional description of the role descriptor"},"restriction":{"$ref":"./security._types.json#/$defs/security._types__Restriction","description":"Restriction for when the role descriptor is allowed to be effective."},"transient_metadata":{"type":"object","additionalProperties":{}}}},"security._types__ClusterPrivilege":{"anyOf":[{"enum":["all","cancel_task","create_snapshot","cross_cluster_replication","cross_cluster_search","delegate_pki","grant_api_key","manage","manage_api_key","manage_autoscaling","manage_behavioral_analytics","manage_ccr","manage_data_frame_transforms","manage_data_stream_global_retention","manage_enrich","manage_esql","manage_ilm","manage_index_templates","manage_inference","manage_ingest_pipelines","manage_logstash_pipelines","manage_ml","manage_oidc","manage_own_api_key","manage_pipeline","manage_reindex","manage_rollup","manage_saml","manage_search_application","manage_search_query_rules","manage_search_synonyms","manage_security","manage_service_account","manage_slm","manage_token","manage_transform","manage_user_profile","manage_watcher","monitor","monitor_data_frame_transforms","monitor_data_stream_global_retention","monitor_enrich","monitor_esql","monitor_inference","monitor_ml","monitor_reindex","monitor_rollup","monitor_snapshot","monitor_stats","monitor_text_structure","monitor_transform","monitor_watcher","none","post_behavioral_analytics_event","read_ccr","read_fleet_secrets","read_ilm","read_pipeline","read_security","read_slm","transport_client","write_connector_secrets","write_fleet_secrets","read_project_routing","manage_project_routing"]},{"type":"string"}]},"security._types__IndicesPrivileges":{"type":"object","properties":{"field_security":{"$ref":"./security._types.json#/$defs/security._types__FieldSecurity","description":"The document fields that the owners of the role have read access to."},"names":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"A list of indices (or index name patterns) to which the permissions in this entry apply."},"privileges":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__IndexPrivilege"},"description":"The index level privileges that owners of the role have on the specified indices."},"query":{"$ref":"./security._types.json#/$defs/security._types__IndicesPrivilegesQuery","description":"A search query that defines the documents the owners of the role have access to. A document within the specified indices must match this query for it to be accessible by the owners of the role."},"allow_restricted_indices":{"type":"boolean","description":"Set to `true` if using wildcard or regular expressions for patterns that cover restricted indices. Implicitly, restricted indices have limited privileges that can cause pattern tests to fail. If restricted indices are explicitly included in the `names` list, Elasticsearch checks privileges against these indices regardless of the value set for `allow_restricted_indices`.","x-availability":{"stack":{}}}},"required":["names","privileges"]},"security._types__FieldSecurity":{"type":"object","properties":{"except":{"$ref":"./_types.json#/$defs/_types__Fields"},"grant":{"$ref":"./_types.json#/$defs/_types__Fields"}}},"security._types__IndexPrivilege":{"anyOf":[{"enum":["all","auto_configure","create","create_doc","create_index","create_view","cross_cluster_replication","cross_cluster_replication_internal","delete","delete_index","delete_view","index","maintenance","manage","manage_data_stream_lifecycle","manage_follow_index","manage_ilm","manage_leader_index","manage_view","monitor","none","read","read_cross_cluster","read_view_metadata","view_index_metadata","write"]},{"type":"string"}]},"security._types__IndicesPrivilegesQuery":{"anyOf":[{"type":"string"},{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer"},{"$ref":"./security._types.json#/$defs/security._types__RoleTemplateQuery"}],"description":"While creating or updating a role you can provide either a JSON structure or a string to the API.\nHowever, the response provided by Elasticsearch will only be string with a json-as-text content.\n\nSince this is embedded in `IndicesPrivileges`, the same structure is used for clarity in both contexts."},"security._types__RoleTemplateQuery":{"type":"object","properties":{"template":{"$ref":"./security._types.json#/$defs/security._types__RoleTemplateScript","description":"When you create a role, you can specify a query that defines the document level security permissions. You can optionally\nuse Mustache templates in the role query to insert the username of the current authenticated user into the role.\nLike other places in Elasticsearch that support templating or scripting, you can specify inline, stored, or file-based\ntemplates and define custom parameters. You access the details for the current authenticated user through the _user parameter."}}},"security._types__RoleTemplateScript":{"type":"object","properties":{"source":{"$ref":"./security._types.json#/$defs/security._types__RoleTemplateInlineQuery"},"id":{"type":"string","description":"The `id` for a stored script."},"params":{"type":"object","additionalProperties":{},"description":"Specifies any named parameters that are passed into the script as variables.\nUse parameters instead of hard-coded values to decrease compile time."},"lang":{"$ref":"./_types.json#/$defs/_types__ScriptLanguage","description":"Specifies the language the script is written in."},"options":{"type":"object","additionalProperties":{"type":"string"}}}},"security._types__RoleTemplateInlineQuery":{"anyOf":[{"type":"string"},{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer"}]},"security._types__RemoteIndicesPrivileges":{"type":"object","properties":{"clusters":{"$ref":"./_types.json#/$defs/_types__Names","description":"A list of cluster aliases to which the permissions in this entry apply."},"field_security":{"$ref":"./security._types.json#/$defs/security._types__FieldSecurity","description":"The document fields that the owners of the role have read access to."},"names":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"A list of indices (or index name patterns) to which the permissions in this entry apply."},"privileges":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__IndexPrivilege"},"description":"The index level privileges that owners of the role have on the specified indices."},"query":{"$ref":"./security._types.json#/$defs/security._types__IndicesPrivilegesQuery","description":"A search query that defines the documents the owners of the role have access to. A document within the specified indices must match this query for it to be accessible by the owners of the role."},"allow_restricted_indices":{"type":"boolean","description":"Set to `true` if using wildcard or regular expressions for patterns that cover restricted indices. Implicitly, restricted indices have limited privileges that can cause pattern tests to fail. If restricted indices are explicitly included in the `names` list, Elasticsearch checks privileges against these indices regardless of the value set for `allow_restricted_indices`.","x-availability":{"stack":{}}}},"required":["clusters","names","privileges"],"description":"The subset of index level privileges that can be defined for remote clusters."},"security._types__RemoteClusterPrivileges":{"type":"object","properties":{"clusters":{"$ref":"./_types.json#/$defs/_types__Names","description":"A list of cluster aliases to which the permissions in this entry apply."},"privileges":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__RemoteClusterPrivilege"},"description":"The cluster level privileges that owners of the role have on the remote cluster."}},"required":["clusters","privileges"],"description":"The subset of cluster level privileges that can be defined for remote clusters."},"security._types__RemoteClusterPrivilege":{"enum":["monitor_enrich","monitor_stats"]},"security._types__GlobalPrivilege":{"type":"object","properties":{"application":{"$ref":"./security._types.json#/$defs/security._types__ApplicationGlobalUserPrivileges"},"data_source":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__DataSourcePrivileges"},"description":"A list of data source privilege entries, used to grant access to ES\|QL data sources.","x-availability":{"stack":{"since":"9.5.0"}}}},"required":["application"]},"security._types__ApplicationGlobalUserPrivileges":{"type":"object","properties":{"manage":{"$ref":"./security._types.json#/$defs/security._types__ManageUserPrivileges"}},"required":["manage"]},"security._types__ManageUserPrivileges":{"type":"object","properties":{"applications":{"type":"array","items":{"type":"string"}}},"required":["applications"]},"security._types__DataSourcePrivileges":{"type":"object","properties":{"names":{"type":"array","items":{"type":"string"},"description":"A list of data source names or wildcard patterns to which the permissions in this entry apply."},"privileges":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__DataSourcePrivilege"},"description":"The data source privileges that owners of the role have for the specified data sources."}},"required":["names","privileges"]},"security._types__DataSourcePrivilege":{"anyOf":[{"enum":["create","delete","read_metadata","read","manage"]},{"type":"string"}]},"security._types__ApplicationPrivileges":{"type":"object","properties":{"application":{"type":"string","description":"The name of the application to which this entry applies."},"privileges":{"type":"array","items":{"type":"string"},"description":"A list of strings, where each element is the name of an application privilege or action."},"resources":{"type":"array","items":{"type":"string"},"description":"A list resources to which the privileges are applied."}},"required":["application","privileges","resources"]},"security._types__Restriction":{"type":"object","properties":{"workflows":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__RestrictionWorkflow"},"description":"A list of workflows to which the API key is restricted.\nNOTE: In order to use a role restriction, an API key must be created with a single role descriptor."}},"required":["workflows"]},"security._types__RestrictionWorkflow":{"anyOf":[{"enum":["search_application_query"]},{"type":"string"}]},"security._types__ClusterNode":{"type":"object","properties":{"name":{"type":"string"}},"required":["name"]},"security._types__Access":{"type":"object","properties":{"replication":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__ReplicationAccess"},"description":"A list of indices permission entries for cross-cluster replication."},"search":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__SearchAccess"},"description":"A list of indices permission entries for cross-cluster search."}}},"security._types__ReplicationAccess":{"type":"object","properties":{"names":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"A list of indices (or index name patterns) to which the permissions in this entry apply."},"allow_restricted_indices":{"type":"boolean","description":"This needs to be set to true if the patterns in the names field should cover system indices."}},"required":["names"]},"security._types__SearchAccess":{"type":"object","properties":{"field_security":{"$ref":"./security._types.json#/$defs/security._types__FieldSecurity","description":"The document fields that the owners of the role have read access to."},"names":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"A list of indices (or index name patterns) to which the permissions in this entry apply."},"query":{"$ref":"./security._types.json#/$defs/security._types__IndicesPrivilegesQuery","description":"A search query that defines the documents the owners of the role have access to. A document within the specified indices must match this query for it to be accessible by the owners of the role."},"allow_restricted_indices":{"type":"boolean","description":"Set to `true` if using wildcard or regular expressions for patterns that cover restricted indices. Implicitly, restricted indices have limited privileges that can cause pattern tests to fail. If restricted indices are explicitly included in the `names` list, Elasticsearch checks privileges against these indices regardless of the value set for `allow_restricted_indices`.","x-availability":{"stack":{}}}},"required":["names"]},"security._types__ApiKey":{"type":"object","properties":{"id":{"type":"string","description":"Id for the API key"},"name":{"type":"string","description":"Name of the API key."},"type":{"$ref":"./security._types.json#/$defs/security._types__ApiKeyType","description":"The type of the API key (e.g. `rest` or `cross_cluster`).","x-availability":{"stack":{"since":"8.10.0"},"serverless":{}}},"creation":{"description":"Creation time for the API key in milliseconds."},"expiration":{"description":"Expiration time for the API key in milliseconds."},"invalidated":{"type":"boolean","description":"Invalidation status for the API key.\nIf the key has been invalidated, it has a value of `true`. Otherwise, it is `false`."},"invalidation":{"description":"If the key has been invalidated, invalidation time in milliseconds.","x-availability":{"stack":{"since":"8.12.0"},"serverless":{}}},"username":{"type":"string","description":"Principal for which this API key was created"},"realm":{"type":"string","description":"Realm name of the principal for which this API key was created."},"realm_type":{"type":"string","description":"Realm type of the principal for which this API key was created","x-availability":{"stack":{"since":"8.14.0"},"serverless":{}}},"metadata":{"$ref":"./_types.json#/$defs/_types__Metadata","description":"Metadata of the API key","x-availability":{"stack":{"since":"7.13.0"},"serverless":{}}},"role_descriptors":{"type":"object","additionalProperties":{"$ref":"./security._types.json#/$defs/security._types__RoleDescriptor"},"description":"The role descriptors assigned to this API key when it was created or last updated.\nAn empty role descriptor means the API key inherits the owner user’s permissions."},"limited_by":{"type":"array","items":{"type":"object","additionalProperties":{"$ref":"./security._types.json#/$defs/security._types__RoleDescriptor"}},"description":"The owner user’s permissions associated with the API key.\nIt is a point-in-time snapshot captured at creation and subsequent updates.\nAn API key’s effective permissions are an intersection of its assigned privileges and the owner user’s permissions.","x-availability":{"stack":{"since":"8.5.0"},"serverless":{}}},"access":{"$ref":"./security._types.json#/$defs/security._types__Access","description":"The access granted to cross-cluster API keys.\nThe access is composed of permissions for cross cluster search and cross cluster replication.\nAt least one of them must be specified.\nWhen specified, the new access assignment fully replaces the previously assigned access.","x-availability":{"stack":{"since":"8.10.0"},"serverless":{}}},"certificate_identity":{"type":"string","description":"The certificate identity associated with a cross-cluster API key.\nRestricts the API key to connections authenticated by a specific TLS certificate.\nOnly applicable to cross-cluster API keys.","x-availability":{"stack":{"since":"9.3.0"}}},"profile_uid":{"type":"string","description":"The profile uid for the API key owner principal, if requested and if it exists","x-availability":{"stack":{"since":"8.14.0"},"serverless":{}}},"_sort":{"$ref":"./_types.json#/$defs/_types__SortResults","description":"Sorting values when using the `sort` parameter with the `security.query_api_keys` API."}},"required":["id","name","type","creation","invalidated","username","realm","metadata"]},"security._types__ApiKeyType":{"enum":["rest","cross_cluster"]},"security._types__RoleTemplate":{"type":"object","properties":{"format":{"$ref":"./security._types.json#/$defs/security._types__TemplateFormat"},"template":{"$ref":"./_types.json#/$defs/_types__Script"}},"required":["template"]},"security._types__TemplateFormat":{"enum":["string","json"]},"security._types__RoleMapping":{"type":"object","properties":{"enabled":{"type":"boolean"},"metadata":{"$ref":"./_types.json#/$defs/_types__Metadata"},"roles":{"type":"array","items":{"type":"string"}},"role_templates":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__RoleTemplate"}},"rules":{"$ref":"./security._types.json#/$defs/security._types__RoleMappingRule"}},"required":["enabled","metadata","rules"]},"security._types__RoleMappingRule":{"type":"object","properties":{"any":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__RoleMappingRule"}},"all":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__RoleMappingRule"}},"field":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"./_types.json#/$defs/_types__FieldValue"},{"type":"array","items":{"$ref":"./_types.json#/$defs/_types__FieldValue"}}]},"minProperties":1,"maxProperties":1},"except":{"$ref":"./security._types.json#/$defs/security._types__RoleMappingRule"}}},"security._types__RoleDescriptorRead":{"type":"object","properties":{"cluster":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__ClusterPrivilege"},"description":"A list of cluster privileges. These privileges define the cluster level actions that API keys are able to execute."},"indices":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__IndicesPrivileges"},"description":"A list of indices permissions entries."},"remote_indices":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__RemoteIndicesPrivileges"},"description":"A list of indices permissions for remote clusters.","x-availability":{"stack":{"since":"8.14.0"}}},"remote_cluster":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__RemoteClusterPrivileges"},"description":"A list of cluster permissions for remote clusters.\nNOTE: This is limited a subset of the cluster permissions.","x-availability":{"stack":{"since":"8.15.0"}}},"global":{"$ref":"./security._types.json#/$defs/security._types__GlobalPrivilege","description":"An object defining global privileges. A global privilege is a form of cluster privilege that is request-aware.","x-availability":{"stack":{}}},"applications":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__ApplicationPrivileges"},"description":"A list of application privilege entries"},"metadata":{"$ref":"./_types.json#/$defs/_types__Metadata","description":"Optional meta-data. Within the metadata object, keys that begin with `_` are reserved for system usage."},"run_as":{"type":"array","items":{"type":"string"},"description":"A list of users that the API keys can impersonate.\nNOTE: In Elastic Cloud Serverless, the run-as feature is disabled.\nFor API compatibility, you can still specify an empty `run_as` field, but a non-empty list will be rejected."},"description":{"type":"string","description":"Optional description of the role descriptor"},"restriction":{"$ref":"./security._types.json#/$defs/security._types__Restriction","description":"Restriction for when the role descriptor is allowed to be effective."},"transient_metadata":{"type":"object","additionalProperties":{}}},"required":["cluster","indices"]},"security._types__SecuritySettings":{"type":"object","properties":{"index":{"$ref":"./indices._types.json#/$defs/indices._types__IndexSettings"}}},"security._types__NodeSecurityStats":{"type":"object","properties":{"roles":{"$ref":"./security._types.json#/$defs/security._types__RolesStats","description":"Role statistics."}},"required":["roles"]},"security._types__RolesStats":{"type":"object","properties":{"dls":{"$ref":"./xpack.usage.json#/$defs/xpack.usage__SecurityRolesDls","description":"Document-level security (DLS) statistics."}},"required":["dls"]},"security._types__User":{"type":"object","properties":{"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"full_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"metadata":{"$ref":"./_types.json#/$defs/_types__Metadata"},"roles":{"type":"array","items":{"type":"string"}},"username":{"type":"string"},"enabled":{"type":"boolean"},"profile_uid":{"type":"string"}},"required":["metadata","roles","username","enabled"]},"security._types__UserIndicesPrivileges":{"type":"object","properties":{"field_security":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__FieldSecurity"},"description":"The document fields that the owners of the role have read access to."},"names":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"A list of indices (or index name patterns) to which the permissions in this entry apply."},"privileges":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__IndexPrivilege"},"description":"The index level privileges that owners of the role have on the specified indices."},"query":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__IndicesPrivilegesQuery"},"description":"Search queries that define the documents the user has access to. A document within the specified indices must match these queries for it to be accessible by the owners of the role."},"allow_restricted_indices":{"type":"boolean","description":"Set to `true` if using wildcard or regular expressions for patterns that cover restricted indices. Implicitly, restricted indices have limited privileges that can cause pattern tests to fail. If restricted indices are explicitly included in the `names` list, Elasticsearch checks privileges against these indices regardless of the value set for `allow_restricted_indices`."}},"required":["names","privileges","allow_restricted_indices"]},"security._types__RemoteUserIndicesPrivileges":{"type":"object","properties":{"clusters":{"type":"array","items":{"type":"string"}},"field_security":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__FieldSecurity"},"description":"The document fields that the owners of the role have read access to."},"names":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"A list of indices (or index name patterns) to which the permissions in this entry apply."},"privileges":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__IndexPrivilege"},"description":"The index level privileges that owners of the role have on the specified indices."},"query":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__IndicesPrivilegesQuery"},"description":"Search queries that define the documents the user has access to. A document within the specified indices must match these queries for it to be accessible by the owners of the role."},"allow_restricted_indices":{"type":"boolean","description":"Set to `true` if using wildcard or regular expressions for patterns that cover restricted indices. Implicitly, restricted indices have limited privileges that can cause pattern tests to fail. If restricted indices are explicitly included in the `names` list, Elasticsearch checks privileges against these indices regardless of the value set for `allow_restricted_indices`."}},"required":["clusters","names","privileges","allow_restricted_indices"]},"security._types__CreatedStatus":{"type":"object","properties":{"created":{"type":"boolean"}},"required":["created"]},"security._types__UserProfile":{"type":"object","properties":{"uid":{"type":"string"},"user":{"$ref":"./security._types.json#/$defs/security._types__UserProfileUser"},"data":{"type":"object","additionalProperties":{}},"labels":{"type":"object","additionalProperties":{}},"enabled":{"type":"boolean"}},"required":["uid","user","data","labels"]}}}

package/src/es/json/security.query_role.json CHANGED Viewed

	@@ -1 +1 @@
1	- {"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"security.query_role__RoleQueryContainer":{"type":"object","properties":{"bool":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__BoolQuery","description":"matches roles matching boolean combinations of other queries."},"exists":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__ExistsQuery","description":"Returns roles that contain an indexed value for a field."},"ids":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__IdsQuery","description":"Returns roles based on their IDs.\nThis query uses role document IDs stored in the `_id` field."},"match":{"type":"object","additionalProperties":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__MatchQuery"},"minProperties":1,"maxProperties":1,"description":"Returns roles that match a provided text, number, date or boolean value.\nThe provided text is analyzed before matching."},"match_all":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__MatchAllQuery","description":"Matches all roles, giving them all a `_score` of 1.0."},"prefix":{"type":"object","additionalProperties":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__PrefixQuery"},"minProperties":1,"maxProperties":1,"description":"Returns roles that contain a specific prefix in a provided field."},"range":{"type":"object","additionalProperties":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__RangeQuery"},"minProperties":1,"maxProperties":1,"description":"Returns roles that contain terms within a provided range."},"simple_query_string":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__SimpleQueryStringQuery","description":"Returns roles based on a provided query string, using a parser with a limited but fault-tolerant syntax."},"term":{"type":"object","additionalProperties":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__TermQuery"},"minProperties":1,"maxProperties":1,"description":"Returns roles that contain an exact term in a provided field.\nTo return a document, the query term must exactly match the queried field's value, including whitespace and capitalization."},"terms":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__TermsQuery","description":"Returns roles that contain one or more exact terms in a provided field.\nTo return a document, one or more terms must exactly match a field value, including whitespace and capitalization."},"wildcard":{"type":"object","additionalProperties":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__WildcardQuery"},"minProperties":1,"maxProperties":1,"description":"Returns roles that contain terms matching a wildcard pattern."}}},"security.query_role__QueryRole":{"type":"object","properties":{"cluster":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__ClusterPrivilege"},"description":"A list of cluster privileges. These privileges define the cluster level actions that API keys are able to execute."},"indices":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__IndicesPrivileges"},"description":"A list of indices permissions entries."},"remote_indices":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__RemoteIndicesPrivileges"},"description":"A list of indices permissions for remote clusters.","x-availability":{"stack":{"since":"8.14.0"}}},"remote_cluster":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__RemoteClusterPrivileges"},"description":"A list of cluster permissions for remote clusters.\nNOTE: This is limited a subset of the cluster permissions.","x-availability":{"stack":{"since":"8.15.0"}}},"global":{"~~anyOf":[{"type":"array","items":{"~~$ref":"./security._types.json#/$defs/security._types__GlobalPrivilege"}},{"~~$ref":"./security._types.json#/$defs/security._types__GlobalPrivilege"}],"~~description":"An object defining global privileges. A global privilege is a form of cluster privilege that is request-aware.","x-availability":{"stack":{}}},"applications":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__ApplicationPrivileges"},"description":"A list of application privilege entries"},"metadata":{"$ref":"./_types.json#/$defs/_types__Metadata","description":"Optional meta-data. Within the metadata object, keys that begin with `_` are reserved for system usage."},"run_as":{"type":"array","items":{"type":"string"},"description":"A list of users that the API keys can impersonate.\nNOTE: In Elastic Cloud Serverless, the run-as feature is disabled.\nFor API compatibility, you can still specify an empty `run_as` field, but a non-empty list will be rejected."},"description":{"type":"string","description":"Optional description of the role descriptor"},"restriction":{"$ref":"./security._types.json#/$defs/security._types__Restriction","description":"Restriction for when the role descriptor is allowed to be effective."},"transient_metadata":{"type":"object","additionalProperties":{}},"_sort":{"$ref":"./_types.json#/$defs/_types__SortResults"},"name":{"type":"string","description":"Name of the role."}},"required":["name"]}}}
1	+ {"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"security.query_role__RoleQueryContainer":{"type":"object","properties":{"bool":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__BoolQuery","description":"matches roles matching boolean combinations of other queries."},"exists":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__ExistsQuery","description":"Returns roles that contain an indexed value for a field."},"ids":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__IdsQuery","description":"Returns roles based on their IDs.\nThis query uses role document IDs stored in the `_id` field."},"match":{"type":"object","additionalProperties":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__MatchQuery"},"minProperties":1,"maxProperties":1,"description":"Returns roles that match a provided text, number, date or boolean value.\nThe provided text is analyzed before matching."},"match_all":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__MatchAllQuery","description":"Matches all roles, giving them all a `_score` of 1.0."},"prefix":{"type":"object","additionalProperties":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__PrefixQuery"},"minProperties":1,"maxProperties":1,"description":"Returns roles that contain a specific prefix in a provided field."},"range":{"type":"object","additionalProperties":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__RangeQuery"},"minProperties":1,"maxProperties":1,"description":"Returns roles that contain terms within a provided range."},"simple_query_string":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__SimpleQueryStringQuery","description":"Returns roles based on a provided query string, using a parser with a limited but fault-tolerant syntax."},"term":{"type":"object","additionalProperties":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__TermQuery"},"minProperties":1,"maxProperties":1,"description":"Returns roles that contain an exact term in a provided field.\nTo return a document, the query term must exactly match the queried field's value, including whitespace and capitalization."},"terms":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__TermsQuery","description":"Returns roles that contain one or more exact terms in a provided field.\nTo return a document, one or more terms must exactly match a field value, including whitespace and capitalization."},"wildcard":{"type":"object","additionalProperties":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__WildcardQuery"},"minProperties":1,"maxProperties":1,"description":"Returns roles that contain terms matching a wildcard pattern."}}},"security.query_role__QueryRole":{"type":"object","properties":{"cluster":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__ClusterPrivilege"},"description":"A list of cluster privileges. These privileges define the cluster level actions that API keys are able to execute."},"indices":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__IndicesPrivileges"},"description":"A list of indices permissions entries."},"remote_indices":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__RemoteIndicesPrivileges"},"description":"A list of indices permissions for remote clusters.","x-availability":{"stack":{"since":"8.14.0"}}},"remote_cluster":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__RemoteClusterPrivileges"},"description":"A list of cluster permissions for remote clusters.\nNOTE: This is limited a subset of the cluster permissions.","x-availability":{"stack":{"since":"8.15.0"}}},"global":{"$ref":"./security._types.json#/$defs/security._types__GlobalPrivilege","description":"An object defining global privileges. A global privilege is a form of cluster privilege that is request-aware.","x-availability":{"stack":{}}},"applications":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__ApplicationPrivileges"},"description":"A list of application privilege entries"},"metadata":{"$ref":"./_types.json#/$defs/_types__Metadata","description":"Optional meta-data. Within the metadata object, keys that begin with `_` are reserved for system usage."},"run_as":{"type":"array","items":{"type":"string"},"description":"A list of users that the API keys can impersonate.\nNOTE: In Elastic Cloud Serverless, the run-as feature is disabled.\nFor API compatibility, you can still specify an empty `run_as` field, but a non-empty list will be rejected."},"description":{"type":"string","description":"Optional description of the role descriptor"},"restriction":{"$ref":"./security._types.json#/$defs/security._types__Restriction","description":"Restriction for when the role descriptor is allowed to be effective."},"transient_metadata":{"type":"object","additionalProperties":{}},"_sort":{"$ref":"./_types.json#/$defs/_types__SortResults"},"name":{"type":"string","description":"Name of the role."}},"required":["name"]}}}