From e0372eea89266b28ba0bf19e5db930386c61e1f7 Mon Sep 17 00:00:00 2001 From: Josh Mock Date: Tue, 19 Nov 2024 17:04:50 -0600 Subject: [PATCH] More iteration on generated docs --- docs/basic-config.asciidoc | 10 +- docs/index.asciidoc | 4 - docs/reference-async_search-delete.asciidoc | 26 +- docs/reference-async_search-get.asciidoc | 26 +- docs/reference-async_search-status.asciidoc | 26 +- docs/reference-async_search-submit.asciidoc | 44 +- ...scaling-delete_autoscaling_policy.asciidoc | 26 +- ...oscaling-get_autoscaling_capacity.asciidoc | 26 +- ...utoscaling-get_autoscaling_policy.asciidoc | 26 +- ...utoscaling-put_autoscaling_policy.asciidoc | 26 +- docs/reference-bulk.asciidoc | 30 +- docs/reference-cat-aliases.asciidoc | 26 +- docs/reference-cat-allocation.asciidoc | 26 +- ...reference-cat-component_templates.asciidoc | 26 +- docs/reference-cat-count.asciidoc | 26 +- docs/reference-cat-fielddata.asciidoc | 26 +- docs/reference-cat-health.asciidoc | 26 +- docs/reference-cat-help.asciidoc | 26 +- docs/reference-cat-indices.asciidoc | 26 +- docs/reference-cat-master.asciidoc | 26 +- ...rence-cat-ml_data_frame_analytics.asciidoc | 26 +- docs/reference-cat-ml_datafeeds.asciidoc | 26 +- docs/reference-cat-ml_jobs.asciidoc | 26 +- docs/reference-cat-ml_trained_models.asciidoc | 30 +- docs/reference-cat-nodeattrs.asciidoc | 26 +- docs/reference-cat-nodes.asciidoc | 26 +- docs/reference-cat-pending_tasks.asciidoc | 26 +- docs/reference-cat-plugins.asciidoc | 26 +- docs/reference-cat-recovery.asciidoc | 26 +- docs/reference-cat-repositories.asciidoc | 26 +- docs/reference-cat-segments.asciidoc | 26 +- docs/reference-cat-shards.asciidoc | 26 +- docs/reference-cat-snapshots.asciidoc | 26 +- docs/reference-cat-tasks.asciidoc | 26 +- docs/reference-cat-templates.asciidoc | 26 +- docs/reference-cat-thread_pool.asciidoc | 26 +- docs/reference-cat-transforms.asciidoc | 30 +- ...ce-ccr-delete_auto_follow_pattern.asciidoc | 26 +- docs/reference-ccr-follow.asciidoc | 36 +- docs/reference-ccr-follow_info.asciidoc | 26 +- docs/reference-ccr-follow_stats.asciidoc | 26 +- docs/reference-ccr-forget_follower.asciidoc | 26 +- ...rence-ccr-get_auto_follow_pattern.asciidoc | 26 +- ...nce-ccr-pause_auto_follow_pattern.asciidoc | 26 +- docs/reference-ccr-pause_follow.asciidoc | 26 +- ...rence-ccr-put_auto_follow_pattern.asciidoc | 36 +- ...ce-ccr-resume_auto_follow_pattern.asciidoc | 26 +- docs/reference-ccr-resume_follow.asciidoc | 36 +- docs/reference-ccr-stats.asciidoc | 26 +- docs/reference-ccr-unfollow.asciidoc | 26 +- docs/reference-clear_scroll.asciidoc | 28 +- docs/reference-close_point_in_time.asciidoc | 28 +- ...erence-cluster-allocation_explain.asciidoc | 30 +- ...cluster-delete_component_template.asciidoc | 26 +- ...r-delete_voting_config_exclusions.asciidoc | 26 +- ...cluster-exists_component_template.asciidoc | 26 +- ...ce-cluster-get_component_template.asciidoc | 26 +- docs/reference-cluster-get_settings.asciidoc | 26 +- docs/reference-cluster-health.asciidoc | 28 +- docs/reference-cluster-info.asciidoc | 26 +- docs/reference-cluster-pending_tasks.asciidoc | 26 +- ...ter-post_voting_config_exclusions.asciidoc | 26 +- ...ce-cluster-put_component_template.asciidoc | 26 +- docs/reference-cluster-put_settings.asciidoc | 26 +- docs/reference-cluster-remote_info.asciidoc | 26 +- docs/reference-cluster-reroute.asciidoc | 26 +- docs/reference-cluster-state.asciidoc | 26 +- docs/reference-cluster-stats.asciidoc | 26 +- docs/reference-connector-check_in.asciidoc | 26 +- docs/reference-connector-delete.asciidoc | 26 +- docs/reference-connector-get.asciidoc | 26 +- docs/reference-connector-list.asciidoc | 32 +- docs/reference-connector-post.asciidoc | 26 +- docs/reference-connector-put.asciidoc | 26 +- ...ference-connector-sync_job_cancel.asciidoc | 26 +- ...rence-connector-sync_job_check_in.asciidoc | 17 - ...eference-connector-sync_job_claim.asciidoc | 17 - ...ference-connector-sync_job_delete.asciidoc | 26 +- ...eference-connector-sync_job_error.asciidoc | 17 - .../reference-connector-sync_job_get.asciidoc | 26 +- ...reference-connector-sync_job_list.asciidoc | 32 +- ...reference-connector-sync_job_post.asciidoc | 26 +- ...e-connector-sync_job_update_stats.asciidoc | 17 - ...connector-update_active_filtering.asciidoc | 26 +- ...rence-connector-update_api_key_id.asciidoc | 26 +- ...ce-connector-update_configuration.asciidoc | 26 +- .../reference-connector-update_error.asciidoc | 28 +- ...ference-connector-update_features.asciidoc | 17 - ...erence-connector-update_filtering.asciidoc | 26 +- ...ector-update_filtering_validation.asciidoc | 26 +- ...rence-connector-update_index_name.asciidoc | 28 +- docs/reference-connector-update_name.asciidoc | 26 +- ...reference-connector-update_native.asciidoc | 26 +- ...ference-connector-update_pipeline.asciidoc | 26 +- ...rence-connector-update_scheduling.asciidoc | 26 +- ...nce-connector-update_service_type.asciidoc | 26 +- ...reference-connector-update_status.asciidoc | 26 +- docs/reference-count.asciidoc | 32 +- docs/reference-create.asciidoc | 26 +- ...ing_indices-delete_dangling_index.asciidoc | 26 +- ...ing_indices-import_dangling_index.asciidoc | 26 +- ...ing_indices-list_dangling_indices.asciidoc | 26 +- docs/reference-delete.asciidoc | 28 +- docs/reference-delete_by_query.asciidoc | 50 +- ...erence-delete_by_query_rethrottle.asciidoc | 28 +- docs/reference-delete_script.asciidoc | 26 +- docs/reference-enrich-delete_policy.asciidoc | 26 +- docs/reference-enrich-execute_policy.asciidoc | 26 +- docs/reference-enrich-get_policy.asciidoc | 26 +- docs/reference-enrich-put_policy.asciidoc | 26 +- docs/reference-enrich-stats.asciidoc | 26 +- docs/reference-eql-delete.asciidoc | 26 +- docs/reference-eql-get.asciidoc | 26 +- docs/reference-eql-get_status.asciidoc | 28 +- docs/reference-eql-search.asciidoc | 30 +- docs/reference-esql-async_query.asciidoc | 17 - docs/reference-esql-async_query_get.asciidoc | 17 - docs/reference-esql-query.asciidoc | 26 +- docs/reference-exists.asciidoc | 26 +- docs/reference-exists_source.asciidoc | 26 +- docs/reference-explain.asciidoc | 26 +- docs/reference-features-get_features.asciidoc | 26 +- ...reference-features-reset_features.asciidoc | 26 +- docs/reference-field_caps.asciidoc | 26 +- ...eference-fleet-global_checkpoints.asciidoc | 26 +- docs/reference-fleet-msearch.asciidoc | 32 +- docs/reference-fleet-search.asciidoc | 50 +- docs/reference-get.asciidoc | 26 +- docs/reference-get_script.asciidoc | 26 +- docs/reference-get_script_context.asciidoc | 26 +- docs/reference-get_script_languages.asciidoc | 26 +- docs/reference-get_source.asciidoc | 26 +- docs/reference-graph-explore.asciidoc | 28 +- docs/reference-health_report.asciidoc | 28 +- docs/reference-ilm-delete_lifecycle.asciidoc | 26 +- docs/reference-ilm-explain_lifecycle.asciidoc | 26 +- docs/reference-ilm-get_lifecycle.asciidoc | 26 +- docs/reference-ilm-get_status.asciidoc | 26 +- ...ference-ilm-migrate_to_data_tiers.asciidoc | 26 +- docs/reference-ilm-move_to_step.asciidoc | 26 +- docs/reference-ilm-put_lifecycle.asciidoc | 26 +- docs/reference-ilm-remove_policy.asciidoc | 26 +- docs/reference-ilm-retry.asciidoc | 26 +- docs/reference-ilm-start.asciidoc | 26 +- docs/reference-ilm-stop.asciidoc | 26 +- docs/reference-index.asciidoc | 28 +- docs/reference-indices-add_block.asciidoc | 26 +- docs/reference-indices-analyze.asciidoc | 26 +- docs/reference-indices-clear_cache.asciidoc | 26 +- docs/reference-indices-clone.asciidoc | 26 +- docs/reference-indices-close.asciidoc | 26 +- docs/reference-indices-create.asciidoc | 26 +- ...erence-indices-create_data_stream.asciidoc | 26 +- ...erence-indices-data_streams_stats.asciidoc | 32 +- docs/reference-indices-delete.asciidoc | 26 +- docs/reference-indices-delete_alias.asciidoc | 26 +- ...nce-indices-delete_data_lifecycle.asciidoc | 26 +- ...erence-indices-delete_data_stream.asciidoc | 26 +- ...nce-indices-delete_index_template.asciidoc | 26 +- ...reference-indices-delete_template.asciidoc | 26 +- docs/reference-indices-disk_usage.asciidoc | 26 +- docs/reference-indices-downsample.asciidoc | 26 +- docs/reference-indices-exists.asciidoc | 26 +- docs/reference-indices-exists_alias.asciidoc | 26 +- ...nce-indices-exists_index_template.asciidoc | 26 +- ...reference-indices-exists_template.asciidoc | 26 +- ...ce-indices-explain_data_lifecycle.asciidoc | 26 +- ...ference-indices-field_usage_stats.asciidoc | 26 +- docs/reference-indices-flush.asciidoc | 26 +- docs/reference-indices-forcemerge.asciidoc | 28 +- docs/reference-indices-get.asciidoc | 26 +- docs/reference-indices-get_alias.asciidoc | 26 +- ...erence-indices-get_data_lifecycle.asciidoc | 26 +- ...reference-indices-get_data_stream.asciidoc | 26 +- ...ference-indices-get_field_mapping.asciidoc | 26 +- ...erence-indices-get_index_template.asciidoc | 26 +- docs/reference-indices-get_mapping.asciidoc | 26 +- docs/reference-indices-get_settings.asciidoc | 26 +- docs/reference-indices-get_template.asciidoc | 26 +- ...ce-indices-migrate_to_data_stream.asciidoc | 26 +- ...erence-indices-modify_data_stream.asciidoc | 26 +- docs/reference-indices-open.asciidoc | 26 +- ...rence-indices-promote_data_stream.asciidoc | 26 +- docs/reference-indices-put_alias.asciidoc | 26 +- ...erence-indices-put_data_lifecycle.asciidoc | 26 +- ...erence-indices-put_index_template.asciidoc | 28 +- docs/reference-indices-put_mapping.asciidoc | 26 +- docs/reference-indices-put_settings.asciidoc | 26 +- docs/reference-indices-put_template.asciidoc | 28 +- docs/reference-indices-recovery.asciidoc | 26 +- docs/reference-indices-refresh.asciidoc | 26 +- ...e-indices-reload_search_analyzers.asciidoc | 26 +- ...reference-indices-resolve_cluster.asciidoc | 26 +- docs/reference-indices-resolve_index.asciidoc | 26 +- docs/reference-indices-rollover.asciidoc | 26 +- docs/reference-indices-segments.asciidoc | 26 +- docs/reference-indices-shard_stores.asciidoc | 26 +- docs/reference-indices-shrink.asciidoc | 26 +- ...e-indices-simulate_index_template.asciidoc | 26 +- ...ference-indices-simulate_template.asciidoc | 28 +- docs/reference-indices-split.asciidoc | 26 +- docs/reference-indices-stats.asciidoc | 26 +- docs/reference-indices-unfreeze.asciidoc | 26 +- .../reference-indices-update_aliases.asciidoc | 26 +- .../reference-indices-validate_query.asciidoc | 26 +- docs/reference-inference-delete.asciidoc | 26 +- docs/reference-inference-get.asciidoc | 26 +- docs/reference-inference-inference.asciidoc | 26 +- docs/reference-inference-put.asciidoc | 26 +- ...erence-inference-stream_inference.asciidoc | 17 - docs/reference-info.asciidoc | 26 +- ...ence-ingest-delete_geoip_database.asciidoc | 26 +- .../reference-ingest-delete_pipeline.asciidoc | 26 +- docs/reference-ingest-geo_ip_stats.asciidoc | 26 +- ...ference-ingest-get_geoip_database.asciidoc | 26 +- docs/reference-ingest-get_pipeline.asciidoc | 26 +- docs/reference-ingest-processor_grok.asciidoc | 26 +- ...ference-ingest-put_geoip_database.asciidoc | 26 +- docs/reference-ingest-put_pipeline.asciidoc | 26 +- docs/reference-ingest-simulate.asciidoc | 26 +- docs/reference-knn_search.asciidoc | 30 +- docs/reference-license-delete.asciidoc | 26 +- docs/reference-license-get.asciidoc | 26 +- ...eference-license-get_basic_status.asciidoc | 26 +- ...eference-license-get_trial_status.asciidoc | 26 +- docs/reference-license-post.asciidoc | 26 +- ...eference-license-post_start_basic.asciidoc | 26 +- ...eference-license-post_start_trial.asciidoc | 26 +- ...eference-logstash-delete_pipeline.asciidoc | 26 +- docs/reference-logstash-get_pipeline.asciidoc | 26 +- docs/reference-logstash-put_pipeline.asciidoc | 26 +- docs/reference-main-index.asciidoc | 1000 ++--- docs/reference-mget.asciidoc | 26 +- .../reference-migration-deprecations.asciidoc | 26 +- ...ration-get_feature_upgrade_status.asciidoc | 26 +- ...ce-migration-post_feature_upgrade.asciidoc | 26 +- ...ar_trained_model_deployment_cache.asciidoc | 26 +- docs/reference-ml-close_job.asciidoc | 26 +- docs/reference-ml-delete_calendar.asciidoc | 26 +- ...eference-ml-delete_calendar_event.asciidoc | 26 +- .../reference-ml-delete_calendar_job.asciidoc | 26 +- ...ce-ml-delete_data_frame_analytics.asciidoc | 26 +- docs/reference-ml-delete_datafeed.asciidoc | 26 +- .../reference-ml-delete_expired_data.asciidoc | 28 +- docs/reference-ml-delete_filter.asciidoc | 26 +- docs/reference-ml-delete_forecast.asciidoc | 26 +- docs/reference-ml-delete_job.asciidoc | 26 +- ...eference-ml-delete_model_snapshot.asciidoc | 26 +- ...reference-ml-delete_trained_model.asciidoc | 26 +- ...nce-ml-delete_trained_model_alias.asciidoc | 26 +- ...eference-ml-estimate_model_memory.asciidoc | 30 +- .../reference-ml-evaluate_data_frame.asciidoc | 26 +- ...e-ml-explain_data_frame_analytics.asciidoc | 28 +- docs/reference-ml-flush_job.asciidoc | 28 +- docs/reference-ml-forecast.asciidoc | 26 +- docs/reference-ml-get_buckets.asciidoc | 34 +- .../reference-ml-get_calendar_events.asciidoc | 32 +- docs/reference-ml-get_calendars.asciidoc | 32 +- docs/reference-ml-get_categories.asciidoc | 32 +- ...rence-ml-get_data_frame_analytics.asciidoc | 32 +- ...ml-get_data_frame_analytics_stats.asciidoc | 32 +- docs/reference-ml-get_datafeed_stats.asciidoc | 28 +- docs/reference-ml-get_datafeeds.asciidoc | 28 +- docs/reference-ml-get_filters.asciidoc | 32 +- docs/reference-ml-get_influencers.asciidoc | 34 +- docs/reference-ml-get_job_stats.asciidoc | 28 +- docs/reference-ml-get_jobs.asciidoc | 28 +- docs/reference-ml-get_memory_stats.asciidoc | 26 +- ...-get_model_snapshot_upgrade_stats.asciidoc | 28 +- .../reference-ml-get_model_snapshots.asciidoc | 32 +- .../reference-ml-get_overall_buckets.asciidoc | 32 +- docs/reference-ml-get_records.asciidoc | 34 +- docs/reference-ml-get_trained_models.asciidoc | 32 +- ...rence-ml-get_trained_models_stats.asciidoc | 32 +- .../reference-ml-infer_trained_model.asciidoc | 26 +- docs/reference-ml-info.asciidoc | 26 +- docs/reference-ml-open_job.asciidoc | 26 +- ...reference-ml-post_calendar_events.asciidoc | 26 +- docs/reference-ml-post_data.asciidoc | 54 +- ...e-ml-preview_data_frame_analytics.asciidoc | 26 +- docs/reference-ml-preview_datafeed.asciidoc | 26 +- docs/reference-ml-put_calendar.asciidoc | 26 +- docs/reference-ml-put_calendar_job.asciidoc | 26 +- ...rence-ml-put_data_frame_analytics.asciidoc | 30 +- docs/reference-ml-put_datafeed.asciidoc | 34 +- docs/reference-ml-put_filter.asciidoc | 26 +- docs/reference-ml-put_job.asciidoc | 42 +- docs/reference-ml-put_trained_model.asciidoc | 28 +- ...erence-ml-put_trained_model_alias.asciidoc | 26 +- ...put_trained_model_definition_part.asciidoc | 32 +- ...e-ml-put_trained_model_vocabulary.asciidoc | 28 +- docs/reference-ml-reset_job.asciidoc | 26 +- ...eference-ml-revert_model_snapshot.asciidoc | 26 +- docs/reference-ml-set_upgrade_mode.asciidoc | 26 +- ...nce-ml-start_data_frame_analytics.asciidoc | 26 +- docs/reference-ml-start_datafeed.asciidoc | 26 +- ...ml-start_trained_model_deployment.asciidoc | 32 +- ...ence-ml-stop_data_frame_analytics.asciidoc | 26 +- docs/reference-ml-stop_datafeed.asciidoc | 26 +- ...-ml-stop_trained_model_deployment.asciidoc | 26 +- ...ce-ml-update_data_frame_analytics.asciidoc | 32 +- docs/reference-ml-update_datafeed.asciidoc | 34 +- docs/reference-ml-update_filter.asciidoc | 26 +- docs/reference-ml-update_job.asciidoc | 42 +- ...eference-ml-update_model_snapshot.asciidoc | 26 +- ...l-update_trained_model_deployment.asciidoc | 28 +- ...reference-ml-upgrade_job_snapshot.asciidoc | 26 +- docs/reference-monitoring-bulk.asciidoc | 28 +- docs/reference-msearch.asciidoc | 32 +- docs/reference-msearch_template.asciidoc | 28 +- docs/reference-mtermvectors.asciidoc | 26 +- ...ear_repositories_metering_archive.asciidoc | 28 +- ...es-get_repositories_metering_info.asciidoc | 26 +- docs/reference-nodes-hot_threads.asciidoc | 30 +- docs/reference-nodes-info.asciidoc | 26 +- ...ence-nodes-reload_secure_settings.asciidoc | 26 +- docs/reference-nodes-stats.asciidoc | 26 +- docs/reference-nodes-usage.asciidoc | 26 +- docs/reference-open_point_in_time.asciidoc | 26 +- docs/reference-ping.asciidoc | 26 +- docs/reference-put_script.asciidoc | 26 +- ...reference-query_rules-delete_rule.asciidoc | 26 +- ...erence-query_rules-delete_ruleset.asciidoc | 26 +- docs/reference-query_rules-get_rule.asciidoc | 26 +- ...reference-query_rules-get_ruleset.asciidoc | 26 +- ...ference-query_rules-list_rulesets.asciidoc | 32 +- docs/reference-query_rules-put_rule.asciidoc | 28 +- ...reference-query_rules-put_ruleset.asciidoc | 26 +- docs/reference-query_rules-test.asciidoc | 28 +- docs/reference-rank_eval.asciidoc | 28 +- docs/reference-reindex.asciidoc | 50 +- docs/reference-reindex_rethrottle.asciidoc | 28 +- .../reference-render_search_template.asciidoc | 26 +- docs/reference-rollup-delete_job.asciidoc | 26 +- docs/reference-rollup-get_jobs.asciidoc | 26 +- .../reference-rollup-get_rollup_caps.asciidoc | 26 +- ...ence-rollup-get_rollup_index_caps.asciidoc | 26 +- docs/reference-rollup-put_job.asciidoc | 28 +- docs/reference-rollup-rollup_search.asciidoc | 30 +- docs/reference-rollup-start_job.asciidoc | 26 +- docs/reference-rollup-stop_job.asciidoc | 26 +- ...eference-scripts_painless_execute.asciidoc | 26 +- docs/reference-scroll.asciidoc | 26 +- docs/reference-search.asciidoc | 44 +- ...ference-search_application-delete.asciidoc | 26 +- ...ation-delete_behavioral_analytics.asciidoc | 26 +- .../reference-search_application-get.asciidoc | 26 +- ...lication-get_behavioral_analytics.asciidoc | 26 +- ...reference-search_application-list.asciidoc | 32 +- ...n-post_behavioral_analytics_event.asciidoc | 17 - .../reference-search_application-put.asciidoc | 26 +- ...lication-put_behavioral_analytics.asciidoc | 26 +- ...e-search_application-render_query.asciidoc | 17 - ...ference-search_application-search.asciidoc | 26 +- docs/reference-search_mvt.asciidoc | 34 +- docs/reference-search_shards.asciidoc | 26 +- docs/reference-search_template.asciidoc | 32 +- ...-searchable_snapshots-cache_stats.asciidoc | 26 +- ...-searchable_snapshots-clear_cache.asciidoc | 26 +- ...erence-searchable_snapshots-mount.asciidoc | 26 +- ...erence-searchable_snapshots-stats.asciidoc | 26 +- ...ce-security-activate_user_profile.asciidoc | 26 +- docs/reference-security-authenticate.asciidoc | 26 +- ...ference-security-bulk_delete_role.asciidoc | 26 +- .../reference-security-bulk_put_role.asciidoc | 26 +- ...nce-security-bulk_update_api_keys.asciidoc | 17 - ...eference-security-change_password.asciidoc | 26 +- ...ence-security-clear_api_key_cache.asciidoc | 26 +- ...-security-clear_cached_privileges.asciidoc | 26 +- ...ence-security-clear_cached_realms.asciidoc | 26 +- ...rence-security-clear_cached_roles.asciidoc | 26 +- ...urity-clear_cached_service_tokens.asciidoc | 26 +- ...reference-security-create_api_key.asciidoc | 28 +- ...rity-create_cross_cluster_api_key.asciidoc | 26 +- ...nce-security-create_service_token.asciidoc | 26 +- ...erence-security-delete_privileges.asciidoc | 26 +- docs/reference-security-delete_role.asciidoc | 26 +- ...ence-security-delete_role_mapping.asciidoc | 26 +- ...nce-security-delete_service_token.asciidoc | 26 +- docs/reference-security-delete_user.asciidoc | 26 +- docs/reference-security-disable_user.asciidoc | 26 +- ...nce-security-disable_user_profile.asciidoc | 26 +- docs/reference-security-enable_user.asciidoc | 26 +- ...ence-security-enable_user_profile.asciidoc | 26 +- .../reference-security-enroll_kibana.asciidoc | 26 +- docs/reference-security-enroll_node.asciidoc | 26 +- docs/reference-security-get_api_key.asciidoc | 26 +- ...e-security-get_builtin_privileges.asciidoc | 26 +- ...reference-security-get_privileges.asciidoc | 26 +- docs/reference-security-get_role.asciidoc | 26 +- ...ference-security-get_role_mapping.asciidoc | 26 +- ...nce-security-get_service_accounts.asciidoc | 26 +- ...-security-get_service_credentials.asciidoc | 28 +- docs/reference-security-get_settings.asciidoc | 17 - docs/reference-security-get_token.asciidoc | 28 +- docs/reference-security-get_user.asciidoc | 26 +- ...ence-security-get_user_privileges.asciidoc | 26 +- ...ference-security-get_user_profile.asciidoc | 26 +- .../reference-security-grant_api_key.asciidoc | 26 +- ...reference-security-has_privileges.asciidoc | 26 +- ...urity-has_privileges_user_profile.asciidoc | 26 +- ...rence-security-invalidate_api_key.asciidoc | 28 +- ...ference-security-invalidate_token.asciidoc | 32 +- ...erence-security-oidc_authenticate.asciidoc | 17 - docs/reference-security-oidc_logout.asciidoc | 17 - ...urity-oidc_prepare_authentication.asciidoc | 17 - ...reference-security-put_privileges.asciidoc | 26 +- docs/reference-security-put_role.asciidoc | 26 +- ...ference-security-put_role_mapping.asciidoc | 26 +- docs/reference-security-put_user.asciidoc | 26 +- ...reference-security-query_api_keys.asciidoc | 34 +- docs/reference-security-query_role.asciidoc | 34 +- docs/reference-security-query_user.asciidoc | 34 +- ...erence-security-saml_authenticate.asciidoc | 28 +- ...nce-security-saml_complete_logout.asciidoc | 26 +- ...eference-security-saml_invalidate.asciidoc | 28 +- docs/reference-security-saml_logout.asciidoc | 26 +- ...urity-saml_prepare_authentication.asciidoc | 26 +- ...ty-saml_service_provider_metadata.asciidoc | 26 +- ...ce-security-suggest_user_profiles.asciidoc | 30 +- ...reference-security-update_api_key.asciidoc | 26 +- ...rity-update_cross_cluster_api_key.asciidoc | 26 +- ...eference-security-update_settings.asciidoc | 17 - ...security-update_user_profile_data.asciidoc | 28 +- docs/reference-shared-types.asciidoc | 3246 ++++++++++++----- docs/reference-shutdown-delete_node.asciidoc | 26 +- docs/reference-shutdown-get_node.asciidoc | 26 +- docs/reference-shutdown-put_node.asciidoc | 26 +- docs/reference-simulate-ingest.asciidoc | 17 - docs/reference-slm-delete_lifecycle.asciidoc | 26 +- docs/reference-slm-execute_lifecycle.asciidoc | 26 +- docs/reference-slm-execute_retention.asciidoc | 26 +- docs/reference-slm-get_lifecycle.asciidoc | 26 +- docs/reference-slm-get_stats.asciidoc | 40 +- docs/reference-slm-get_status.asciidoc | 26 +- docs/reference-slm-put_lifecycle.asciidoc | 26 +- docs/reference-slm-start.asciidoc | 26 +- docs/reference-slm-stop.asciidoc | 26 +- ...rence-snapshot-cleanup_repository.asciidoc | 26 +- docs/reference-snapshot-clone.asciidoc | 26 +- docs/reference-snapshot-create.asciidoc | 26 +- ...erence-snapshot-create_repository.asciidoc | 26 +- docs/reference-snapshot-delete.asciidoc | 26 +- ...erence-snapshot-delete_repository.asciidoc | 26 +- docs/reference-snapshot-get.asciidoc | 34 +- ...reference-snapshot-get_repository.asciidoc | 26 +- ...rence-snapshot-repository_analyze.asciidoc | 17 - docs/reference-snapshot-restore.asciidoc | 26 +- docs/reference-snapshot-status.asciidoc | 26 +- ...erence-snapshot-verify_repository.asciidoc | 26 +- docs/reference-sql-clear_cursor.asciidoc | 26 +- docs/reference-sql-delete_async.asciidoc | 26 +- docs/reference-sql-get_async.asciidoc | 26 +- docs/reference-sql-get_async_status.asciidoc | 28 +- docs/reference-sql-query.asciidoc | 28 +- docs/reference-sql-translate.asciidoc | 30 +- docs/reference-ssl-certificates.asciidoc | 26 +- ...reference-synonyms-delete_synonym.asciidoc | 26 +- ...ence-synonyms-delete_synonym_rule.asciidoc | 26 +- docs/reference-synonyms-get_synonym.asciidoc | 32 +- ...ference-synonyms-get_synonym_rule.asciidoc | 26 +- ...erence-synonyms-get_synonyms_sets.asciidoc | 32 +- docs/reference-synonyms-put_synonym.asciidoc | 26 +- ...ference-synonyms-put_synonym_rule.asciidoc | 26 +- docs/reference-tasks-cancel.asciidoc | 26 +- docs/reference-tasks-get.asciidoc | 26 +- docs/reference-tasks-list.asciidoc | 26 +- docs/reference-terms_enum.asciidoc | 28 +- docs/reference-termvectors.asciidoc | 28 +- ...xt_structure-find_field_structure.asciidoc | 17 - ..._structure-find_message_structure.asciidoc | 17 - ...nce-text_structure-find_structure.asciidoc | 36 +- ...-text_structure-test_grok_pattern.asciidoc | 26 +- ...erence-transform-delete_transform.asciidoc | 26 +- ...eference-transform-get_node_stats.asciidoc | 17 - ...reference-transform-get_transform.asciidoc | 32 +- ...nce-transform-get_transform_stats.asciidoc | 32 +- ...rence-transform-preview_transform.asciidoc | 26 +- ...reference-transform-put_transform.asciidoc | 26 +- ...ference-transform-reset_transform.asciidoc | 26 +- ...-transform-schedule_now_transform.asciidoc | 26 +- ...ference-transform-start_transform.asciidoc | 26 +- ...eference-transform-stop_transform.asciidoc | 26 +- ...erence-transform-update_transform.asciidoc | 28 +- ...ence-transform-upgrade_transforms.asciidoc | 32 +- docs/reference-update.asciidoc | 30 +- docs/reference-update_by_query.asciidoc | 50 +- ...erence-update_by_query_rethrottle.asciidoc | 28 +- docs/reference-watcher-ack_watch.asciidoc | 26 +- .../reference-watcher-activate_watch.asciidoc | 26 +- ...eference-watcher-deactivate_watch.asciidoc | 26 +- docs/reference-watcher-delete_watch.asciidoc | 26 +- docs/reference-watcher-execute_watch.asciidoc | 26 +- docs/reference-watcher-get_settings.asciidoc | 17 - docs/reference-watcher-get_watch.asciidoc | 28 +- docs/reference-watcher-put_watch.asciidoc | 30 +- docs/reference-watcher-query_watches.asciidoc | 32 +- docs/reference-watcher-start.asciidoc | 26 +- docs/reference-watcher-stats.asciidoc | 26 +- docs/reference-watcher-stop.asciidoc | 26 +- ...reference-watcher-update_settings.asciidoc | 17 - docs/reference-xpack-info.asciidoc | 26 +- docs/reference-xpack-usage.asciidoc | 26 +- 503 files changed, 11653 insertions(+), 6026 deletions(-) diff --git a/docs/basic-config.asciidoc b/docs/basic-config.asciidoc index 799866f93..fa0982618 100644 --- a/docs/basic-config.asciidoc +++ b/docs/basic-config.asciidoc @@ -85,7 +85,7 @@ _Default:_ `3` _Default:_ `30000` |`pingTimeout` -|`number` - Max ping request timeout in milliseconds for each request. + +|`number` - Max number of milliseconds a `ClusterConnectionPool` will wait when pinging nodes before marking them dead. + _Default:_ `3000` |`sniffInterval` @@ -105,17 +105,13 @@ _Default:_ `'_nodes/_all/http'` _Default:_ `false` |`resurrectStrategy` -|`string` - Configure the node resurrection strategy. + +|`string` - Strategy for resurrecting dead nodes when using `ClusterConnectionPool`. 'ping' will issue a test request to a node and resurrect it if it responds. 'optimistic' marks a node as alive without testing it. 'none' will never attempt to revive a dead connection. + _Options:_ `'ping'`, `'optimistic'`, `'none'` + _Default:_ `'ping'` -|`suggestCompression` -|`boolean` - Adds `accept-encoding` header to every request. + -_Default:_ `false` - |`compression` |`string, boolean` - Enables gzip request body compression. + -_Options:_ `'gzip'`, `false` + +_Options:_ `true`, `false` + _Default:_ `false` |`tls` diff --git a/docs/index.asciidoc b/docs/index.asciidoc index 7a438c11d..7b8f12158 100644 --- a/docs/index.asciidoc +++ b/docs/index.asciidoc @@ -1,8 +1,5 @@ = Elasticsearch JavaScript Client -include::{asciidoc-dir}/../../shared/versions/stack/{source_branch}.asciidoc[] -include::{asciidoc-dir}/../../shared/attributes.asciidoc[] - include::introduction.asciidoc[] include::getting-started.asciidoc[] include::changelog.asciidoc[] @@ -20,5 +17,4 @@ include::typescript.asciidoc[] include::reference-main-index.asciidoc[] include::examples/index.asciidoc[] include::helpers.asciidoc[] -include::redirects.asciidoc[] include::timeout-best-practices.asciidoc[] diff --git a/docs/reference-async_search-delete.asciidoc b/docs/reference-async_search-delete.asciidoc index ef3bfa339..2cbf3ea3a 100644 --- a/docs/reference-async_search-delete.asciidoc +++ b/docs/reference-async_search-delete.asciidoc @@ -41,20 +41,30 @@ Delete an async search. If the asynchronous search is still running, it is cance ---- [discrete] -===== `AsyncSearchDeleteRequest` +==== AsyncSearchDeleteRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface AsyncSearchDeleteRequest extends <> {
   id: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `AsyncSearchDeleteResponse` +==== AsyncSearchDeleteResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type AsyncSearchDeleteResponse = <>
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-async_search-get.asciidoc b/docs/reference-async_search-get.asciidoc index 4d9eee425..2c00e52c7 100644 --- a/docs/reference-async_search-get.asciidoc +++ b/docs/reference-async_search-get.asciidoc @@ -41,23 +41,33 @@ Get async search results. Retrieve the results of a previously submitted asynchr ---- [discrete] -===== `AsyncSearchGetRequest` +==== AsyncSearchGetRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface AsyncSearchGetRequest extends <> {
   id: <>
   keep_alive?: <>
   typed_keys?: boolean
   wait_for_completion_timeout?: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `AsyncSearchGetResponse` +==== AsyncSearchGetResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type AsyncSearchGetResponse>, AggregationsAggregate>> = AsyncSearchAsyncSearchDocumentResponseBase
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-async_search-status.asciidoc b/docs/reference-async_search-status.asciidoc index 9bfe7f1a5..f84488dd3 100644 --- a/docs/reference-async_search-status.asciidoc +++ b/docs/reference-async_search-status.asciidoc @@ -41,20 +41,30 @@ Get the async search status. Get the status of a previously submitted async sear ---- [discrete] -===== `AsyncSearchStatusRequest` +==== AsyncSearchStatusRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface AsyncSearchStatusRequest extends <> {
   id: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `AsyncSearchStatusResponse` +==== AsyncSearchStatusResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type AsyncSearchStatusResponse = AsyncSearchStatusStatusResponseBase
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-async_search-submit.asciidoc b/docs/reference-async_search-submit.asciidoc index d07dbe348..75352edb3 100644 --- a/docs/reference-async_search-submit.asciidoc +++ b/docs/reference-async_search-submit.asciidoc @@ -41,10 +41,12 @@ Run an async search. When the primary sort of the results is an indexed field, s ---- [discrete] -===== `AsyncSearchSubmitRequest` +==== AsyncSearchSubmitRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface AsyncSearchSubmitRequest extends <> {
   index?: <>
   wait_for_completion_timeout?: <>
@@ -54,7 +56,7 @@ interface AsyncSearchSubmitRequest extends <> {
   allow_partial_search_results?: boolean
   analyzer?: string
   analyze_wildcard?: boolean
-  batched_reduce_size?: <>
+  batched_reduce_size?: number
   ccs_minimize_roundtrips?: boolean
   default_operator?: QueryDslOperator
   df?: string
@@ -62,17 +64,17 @@ interface AsyncSearchSubmitRequest extends <> {
   ignore_throttled?: boolean
   ignore_unavailable?: boolean
   lenient?: boolean
-  max_concurrent_shard_requests?: <>
+  max_concurrent_shard_requests?: number
   min_compatible_shard_node?: <>
   preference?: string
-  pre_filter_shard_size?: <>
+  pre_filter_shard_size?: number
   request_cache?: boolean
   routing?: <>
   scroll?: <>
   search_type?: <>
   suggest_field?: <>
   suggest_mode?: <>
-  suggest_size?: <>
+  suggest_size?: number
   suggest_text?: string
   typed_keys?: boolean
   rest_total_hits_as_int?: boolean
@@ -85,26 +87,26 @@ interface AsyncSearchSubmitRequest extends <> {
   collapse?: SearchFieldCollapse
   explain?: boolean
   ext?: Record
-  from?: <>
+  from?: number
   highlight?: SearchHighlight
   track_total_hits?: SearchTrackHits
-  indices_boost?: Record<<>, <>>[]
+  indices_boost?: Record<<>, number>[]
   docvalue_fields?: (QueryDslFieldAndFormat | <>)[]
   knn?: <> | <>[]
-  min_score?: <>
+  min_score?: number
   post_filter?: QueryDslQueryContainer
   profile?: boolean
   query?: QueryDslQueryContainer
   rescore?: SearchRescore | SearchRescore[]
   script_fields?: Record>>
   search_after?: <>
-  size?: <>
+  size?: number
   slice?: <>
   sort?: <>
   _source?: SearchSourceConfig
   fields?: (QueryDslFieldAndFormat | <>)[]
   suggest?: SearchSuggester
-  terminate_after?: <>
+  terminate_after?: number
   timeout?: string
   track_scores?: boolean
   version?: boolean
@@ -114,13 +116,21 @@ interface AsyncSearchSubmitRequest extends <> {
   runtime_mappings?: MappingRuntimeFields
   stats?: string[]
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `AsyncSearchSubmitResponse` +==== AsyncSearchSubmitResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type AsyncSearchSubmitResponse>, AggregationsAggregate>> = AsyncSearchAsyncSearchDocumentResponseBase
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-autoscaling-delete_autoscaling_policy.asciidoc b/docs/reference-autoscaling-delete_autoscaling_policy.asciidoc index 58a95bcf3..1d2107408 100644 --- a/docs/reference-autoscaling-delete_autoscaling_policy.asciidoc +++ b/docs/reference-autoscaling-delete_autoscaling_policy.asciidoc @@ -41,20 +41,30 @@ Delete an autoscaling policy. NOTE: This feature is designed for indirect use by ---- [discrete] -===== `AutoscalingDeleteAutoscalingPolicyRequest` +==== AutoscalingDeleteAutoscalingPolicyRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface AutoscalingDeleteAutoscalingPolicyRequest extends <> {
   name: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `AutoscalingDeleteAutoscalingPolicyResponse` +==== AutoscalingDeleteAutoscalingPolicyResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type AutoscalingDeleteAutoscalingPolicyResponse = <>
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-autoscaling-get_autoscaling_capacity.asciidoc b/docs/reference-autoscaling-get_autoscaling_capacity.asciidoc index a91e491e6..2eb89a798 100644 --- a/docs/reference-autoscaling-get_autoscaling_capacity.asciidoc +++ b/docs/reference-autoscaling-get_autoscaling_capacity.asciidoc @@ -41,21 +41,31 @@ Get the autoscaling capacity. NOTE: This feature is designed for indirect use by ---- [discrete] -===== `AutoscalingGetAutoscalingCapacityRequest` +==== AutoscalingGetAutoscalingCapacityRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface AutoscalingGetAutoscalingCapacityRequest extends <> {
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `AutoscalingGetAutoscalingCapacityResponse` +==== AutoscalingGetAutoscalingCapacityResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface AutoscalingGetAutoscalingCapacityResponse {
   policies: Record
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-autoscaling-get_autoscaling_policy.asciidoc b/docs/reference-autoscaling-get_autoscaling_policy.asciidoc index ba403f233..af52d8dcd 100644 --- a/docs/reference-autoscaling-get_autoscaling_policy.asciidoc +++ b/docs/reference-autoscaling-get_autoscaling_policy.asciidoc @@ -41,20 +41,30 @@ Get an autoscaling policy. NOTE: This feature is designed for indirect use by El ---- [discrete] -===== `AutoscalingGetAutoscalingPolicyRequest` +==== AutoscalingGetAutoscalingPolicyRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface AutoscalingGetAutoscalingPolicyRequest extends <> {
   name: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `AutoscalingGetAutoscalingPolicyResponse` +==== AutoscalingGetAutoscalingPolicyResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type AutoscalingGetAutoscalingPolicyResponse = AutoscalingAutoscalingPolicy
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-autoscaling-put_autoscaling_policy.asciidoc b/docs/reference-autoscaling-put_autoscaling_policy.asciidoc index 93b66749f..f6fd06e6c 100644 --- a/docs/reference-autoscaling-put_autoscaling_policy.asciidoc +++ b/docs/reference-autoscaling-put_autoscaling_policy.asciidoc @@ -41,21 +41,31 @@ Create or update an autoscaling policy. NOTE: This feature is designed for indir ---- [discrete] -===== `AutoscalingPutAutoscalingPolicyRequest` +==== AutoscalingPutAutoscalingPolicyRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface AutoscalingPutAutoscalingPolicyRequest extends <> {
   name: <>
   policy?: AutoscalingAutoscalingPolicy
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `AutoscalingPutAutoscalingPolicyResponse` +==== AutoscalingPutAutoscalingPolicyResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type AutoscalingPutAutoscalingPolicyResponse = <>
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-bulk.asciidoc b/docs/reference-bulk.asciidoc index 265a0ff2e..434137f36 100644 --- a/docs/reference-bulk.asciidoc +++ b/docs/reference-bulk.asciidoc @@ -41,10 +41,12 @@ Bulk index or delete documents. Performs multiple indexing or delete operations ---- [discrete] -===== `BulkRequest` +==== BulkRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface BulkRequest extends <> {
   index?: <>
   pipeline?: string
@@ -58,18 +60,26 @@ interface BulkRequest extends <
   require_alias?: boolean
   operations?: (BulkOperationContainer | BulkUpdateAction | TDocument)[]
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `BulkResponse` +==== BulkResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface BulkResponse {
   errors: boolean
   items: Partial>[]
-  took: <>
-  ingest_took?: <>
+  took: number
+  ingest_took?: number
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-cat-aliases.asciidoc b/docs/reference-cat-aliases.asciidoc index 9c5628b58..f2e15606e 100644 --- a/docs/reference-cat-aliases.asciidoc +++ b/docs/reference-cat-aliases.asciidoc @@ -41,21 +41,31 @@ Get aliases. Retrieves the cluster’s index aliases, including filter and routi ---- [discrete] -===== `CatAliasesRequest` +==== CatAliasesRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface CatAliasesRequest extends CatCatRequestBase {
   name?: <>
   expand_wildcards?: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `CatAliasesResponse` +==== CatAliasesResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type CatAliasesResponse = CatAliasesAliasesRecord[]
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-cat-allocation.asciidoc b/docs/reference-cat-allocation.asciidoc index 13e69ef13..e94ce0564 100644 --- a/docs/reference-cat-allocation.asciidoc +++ b/docs/reference-cat-allocation.asciidoc @@ -41,21 +41,31 @@ Provides a snapshot of the number of shards allocated to each data node and thei ---- [discrete] -===== `CatAllocationRequest` +==== CatAllocationRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface CatAllocationRequest extends CatCatRequestBase {
   node_id?: <>
   bytes?: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `CatAllocationResponse` +==== CatAllocationResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type CatAllocationResponse = CatAllocationAllocationRecord[]
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-cat-component_templates.asciidoc b/docs/reference-cat-component_templates.asciidoc index bc52e218e..2e66e3814 100644 --- a/docs/reference-cat-component_templates.asciidoc +++ b/docs/reference-cat-component_templates.asciidoc @@ -41,20 +41,30 @@ Get component templates. Returns information about component templates in a clus ---- [discrete] -===== `CatComponentTemplatesRequest` +==== CatComponentTemplatesRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface CatComponentTemplatesRequest extends CatCatRequestBase {
   name?: string
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `CatComponentTemplatesResponse` +==== CatComponentTemplatesResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type CatComponentTemplatesResponse = CatComponentTemplatesComponentTemplate[]
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-cat-count.asciidoc b/docs/reference-cat-count.asciidoc index 2948f69b5..70cd2316a 100644 --- a/docs/reference-cat-count.asciidoc +++ b/docs/reference-cat-count.asciidoc @@ -41,20 +41,30 @@ Get a document count. Provides quick access to a document count for a data strea ---- [discrete] -===== `CatCountRequest` +==== CatCountRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface CatCountRequest extends CatCatRequestBase {
   index?: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `CatCountResponse` +==== CatCountResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type CatCountResponse = CatCountCountRecord[]
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-cat-fielddata.asciidoc b/docs/reference-cat-fielddata.asciidoc index 6f4280b26..44df7eff2 100644 --- a/docs/reference-cat-fielddata.asciidoc +++ b/docs/reference-cat-fielddata.asciidoc @@ -41,21 +41,31 @@ Returns the amount of heap memory currently used by the field data cache on ever ---- [discrete] -===== `CatFielddataRequest` +==== CatFielddataRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface CatFielddataRequest extends CatCatRequestBase {
   fields?: <>
   bytes?: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `CatFielddataResponse` +==== CatFielddataResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type CatFielddataResponse = CatFielddataFielddataRecord[]
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-cat-health.asciidoc b/docs/reference-cat-health.asciidoc index 408e0b087..ad4ad6410 100644 --- a/docs/reference-cat-health.asciidoc +++ b/docs/reference-cat-health.asciidoc @@ -41,21 +41,31 @@ Returns the health status of a cluster, similar to the cluster health API. IMPOR ---- [discrete] -===== `CatHealthRequest` +==== CatHealthRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface CatHealthRequest extends CatCatRequestBase {
   time?: <>
   ts?: boolean
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `CatHealthResponse` +==== CatHealthResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type CatHealthResponse = CatHealthHealthRecord[]
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-cat-help.asciidoc b/docs/reference-cat-help.asciidoc index d240a6b1e..f7f077c5a 100644 --- a/docs/reference-cat-help.asciidoc +++ b/docs/reference-cat-help.asciidoc @@ -41,19 +41,29 @@ Get CAT help. Returns help for the CAT APIs. ---- [discrete] -===== `CatHelpRequest` +==== CatHelpRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface CatHelpRequest extends CatCatRequestBase {
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `CatHelpResponse` +==== CatHelpResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type CatHelpResponse = CatHelpHelpRecord[]
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-cat-indices.asciidoc b/docs/reference-cat-indices.asciidoc index 0dd322635..4ef9a083c 100644 --- a/docs/reference-cat-indices.asciidoc +++ b/docs/reference-cat-indices.asciidoc @@ -41,10 +41,12 @@ Get index information. Returns high-level information about indices in a cluster ---- [discrete] -===== `CatIndicesRequest` +==== CatIndicesRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface CatIndicesRequest extends CatCatRequestBase {
   index?: <>
   bytes?: <>
@@ -54,13 +56,21 @@ interface CatIndicesRequest extends CatCatRequestBase {
   pri?: boolean
   time?: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `CatIndicesResponse` +==== CatIndicesResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type CatIndicesResponse = CatIndicesIndicesRecord[]
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-cat-master.asciidoc b/docs/reference-cat-master.asciidoc index cddacfc85..de6aa1a12 100644 --- a/docs/reference-cat-master.asciidoc +++ b/docs/reference-cat-master.asciidoc @@ -41,19 +41,29 @@ Returns information about the master node, including the ID, bound IP address, a ---- [discrete] -===== `CatMasterRequest` +==== CatMasterRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface CatMasterRequest extends CatCatRequestBase {
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `CatMasterResponse` +==== CatMasterResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type CatMasterResponse = CatMasterMasterRecord[]
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-cat-ml_data_frame_analytics.asciidoc b/docs/reference-cat-ml_data_frame_analytics.asciidoc index 2359c0b41..d96f470d2 100644 --- a/docs/reference-cat-ml_data_frame_analytics.asciidoc +++ b/docs/reference-cat-ml_data_frame_analytics.asciidoc @@ -41,10 +41,12 @@ Get data frame analytics jobs. Returns configuration and usage information about ---- [discrete] -===== `CatMlDataFrameAnalyticsRequest` +==== CatMlDataFrameAnalyticsRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface CatMlDataFrameAnalyticsRequest extends CatCatRequestBase {
   id?: <>
   allow_no_match?: boolean
@@ -53,13 +55,21 @@ interface CatMlDataFrameAnalyticsRequest extends CatCatRequestBase {
   s?: CatCatDfaColumns
   time?: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `CatMlDataFrameAnalyticsResponse` +==== CatMlDataFrameAnalyticsResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type CatMlDataFrameAnalyticsResponse = CatMlDataFrameAnalyticsDataFrameAnalyticsRecord[]
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-cat-ml_datafeeds.asciidoc b/docs/reference-cat-ml_datafeeds.asciidoc index fee750d64..3cbe6968d 100644 --- a/docs/reference-cat-ml_datafeeds.asciidoc +++ b/docs/reference-cat-ml_datafeeds.asciidoc @@ -41,10 +41,12 @@ Get datafeeds. Returns configuration and usage information about datafeeds. This ---- [discrete] -===== `CatMlDatafeedsRequest` +==== CatMlDatafeedsRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface CatMlDatafeedsRequest extends CatCatRequestBase {
   datafeed_id?: <>
   allow_no_match?: boolean
@@ -52,13 +54,21 @@ interface CatMlDatafeedsRequest extends CatCatRequestBase {
   s?: CatCatDatafeedColumns
   time?: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `CatMlDatafeedsResponse` +==== CatMlDatafeedsResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type CatMlDatafeedsResponse = CatMlDatafeedsDatafeedsRecord[]
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-cat-ml_jobs.asciidoc b/docs/reference-cat-ml_jobs.asciidoc index 29f3d5136..572f455f3 100644 --- a/docs/reference-cat-ml_jobs.asciidoc +++ b/docs/reference-cat-ml_jobs.asciidoc @@ -41,10 +41,12 @@ Get anomaly detection jobs. Returns configuration and usage information for anom ---- [discrete] -===== `CatMlJobsRequest` +==== CatMlJobsRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface CatMlJobsRequest extends CatCatRequestBase {
   job_id?: <>
   allow_no_match?: boolean
@@ -53,13 +55,21 @@ interface CatMlJobsRequest extends CatCatRequestBase {
   s?: CatCatAnonalyDetectorColumns
   time?: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `CatMlJobsResponse` +==== CatMlJobsResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type CatMlJobsResponse = CatMlJobsJobsRecord[]
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-cat-ml_trained_models.asciidoc b/docs/reference-cat-ml_trained_models.asciidoc index 85140bb52..68d61fe38 100644 --- a/docs/reference-cat-ml_trained_models.asciidoc +++ b/docs/reference-cat-ml_trained_models.asciidoc @@ -41,26 +41,36 @@ Get trained models. Returns configuration and usage information about inference ---- [discrete] -===== `CatMlTrainedModelsRequest` +==== CatMlTrainedModelsRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface CatMlTrainedModelsRequest extends CatCatRequestBase {
   model_id?: <>
   allow_no_match?: boolean
   bytes?: <>
   h?: CatCatTrainedModelsColumns
   s?: CatCatTrainedModelsColumns
-  from?: <>
-  size?: <>
+  from?: number
+  size?: number
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `CatMlTrainedModelsResponse` +==== CatMlTrainedModelsResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type CatMlTrainedModelsResponse = CatMlTrainedModelsTrainedModelsRecord[]
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-cat-nodeattrs.asciidoc b/docs/reference-cat-nodeattrs.asciidoc index e7190d1d5..be6e8f6e8 100644 --- a/docs/reference-cat-nodeattrs.asciidoc +++ b/docs/reference-cat-nodeattrs.asciidoc @@ -41,19 +41,29 @@ Returns information about custom node attributes. IMPORTANT: cat APIs are only i ---- [discrete] -===== `CatNodeattrsRequest` +==== CatNodeattrsRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface CatNodeattrsRequest extends CatCatRequestBase {
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `CatNodeattrsResponse` +==== CatNodeattrsResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type CatNodeattrsResponse = CatNodeattrsNodeAttributesRecord[]
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-cat-nodes.asciidoc b/docs/reference-cat-nodes.asciidoc index ad69da952..f5635ac7d 100644 --- a/docs/reference-cat-nodes.asciidoc +++ b/docs/reference-cat-nodes.asciidoc @@ -41,22 +41,32 @@ Returns information about the nodes in a cluster. IMPORTANT: cat APIs are only i ---- [discrete] -===== `CatNodesRequest` +==== CatNodesRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface CatNodesRequest extends CatCatRequestBase {
   bytes?: <>
   full_id?: boolean | string
   include_unloaded_segments?: boolean
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `CatNodesResponse` +==== CatNodesResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type CatNodesResponse = CatNodesNodesRecord[]
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-cat-pending_tasks.asciidoc b/docs/reference-cat-pending_tasks.asciidoc index 1ba36e7cb..bfcbcbe13 100644 --- a/docs/reference-cat-pending_tasks.asciidoc +++ b/docs/reference-cat-pending_tasks.asciidoc @@ -41,19 +41,29 @@ Returns cluster-level changes that have not yet been executed. IMPORTANT: cat AP ---- [discrete] -===== `CatPendingTasksRequest` +==== CatPendingTasksRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface CatPendingTasksRequest extends CatCatRequestBase {
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `CatPendingTasksResponse` +==== CatPendingTasksResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type CatPendingTasksResponse = CatPendingTasksPendingTasksRecord[]
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-cat-plugins.asciidoc b/docs/reference-cat-plugins.asciidoc index 21aade07b..699ae445d 100644 --- a/docs/reference-cat-plugins.asciidoc +++ b/docs/reference-cat-plugins.asciidoc @@ -41,19 +41,29 @@ Returns a list of plugins running on each node of a cluster. IMPORTANT: cat APIs ---- [discrete] -===== `CatPluginsRequest` +==== CatPluginsRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface CatPluginsRequest extends CatCatRequestBase {
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `CatPluginsResponse` +==== CatPluginsResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type CatPluginsResponse = CatPluginsPluginsRecord[]
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-cat-recovery.asciidoc b/docs/reference-cat-recovery.asciidoc index 0ef0228fa..bd83ff831 100644 --- a/docs/reference-cat-recovery.asciidoc +++ b/docs/reference-cat-recovery.asciidoc @@ -41,23 +41,33 @@ Returns information about ongoing and completed shard recoveries. Shard recovery ---- [discrete] -===== `CatRecoveryRequest` +==== CatRecoveryRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface CatRecoveryRequest extends CatCatRequestBase {
   index?: <>
   active_only?: boolean
   bytes?: <>
   detailed?: boolean
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `CatRecoveryResponse` +==== CatRecoveryResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type CatRecoveryResponse = CatRecoveryRecoveryRecord[]
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-cat-repositories.asciidoc b/docs/reference-cat-repositories.asciidoc index ef5967fbe..ff2976a14 100644 --- a/docs/reference-cat-repositories.asciidoc +++ b/docs/reference-cat-repositories.asciidoc @@ -41,19 +41,29 @@ Returns the snapshot repositories for a cluster. IMPORTANT: cat APIs are only in ---- [discrete] -===== `CatRepositoriesRequest` +==== CatRepositoriesRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface CatRepositoriesRequest extends CatCatRequestBase {
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `CatRepositoriesResponse` +==== CatRepositoriesResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type CatRepositoriesResponse = CatRepositoriesRepositoriesRecord[]
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-cat-segments.asciidoc b/docs/reference-cat-segments.asciidoc index 4862ff312..2e5cb5a6b 100644 --- a/docs/reference-cat-segments.asciidoc +++ b/docs/reference-cat-segments.asciidoc @@ -41,21 +41,31 @@ Returns low-level information about the Lucene segments in index shards. For dat ---- [discrete] -===== `CatSegmentsRequest` +==== CatSegmentsRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface CatSegmentsRequest extends CatCatRequestBase {
   index?: <>
   bytes?: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `CatSegmentsResponse` +==== CatSegmentsResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type CatSegmentsResponse = CatSegmentsSegmentsRecord[]
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-cat-shards.asciidoc b/docs/reference-cat-shards.asciidoc index 939ef6c93..136711c93 100644 --- a/docs/reference-cat-shards.asciidoc +++ b/docs/reference-cat-shards.asciidoc @@ -41,21 +41,31 @@ Returns information about the shards in a cluster. For data streams, the API ret ---- [discrete] -===== `CatShardsRequest` +==== CatShardsRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface CatShardsRequest extends CatCatRequestBase {
   index?: <>
   bytes?: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `CatShardsResponse` +==== CatShardsResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type CatShardsResponse = CatShardsShardsRecord[]
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-cat-snapshots.asciidoc b/docs/reference-cat-snapshots.asciidoc index 4898ed988..7985fcb93 100644 --- a/docs/reference-cat-snapshots.asciidoc +++ b/docs/reference-cat-snapshots.asciidoc @@ -41,21 +41,31 @@ Returns information about the snapshots stored in one or more repositories. A sn ---- [discrete] -===== `CatSnapshotsRequest` +==== CatSnapshotsRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface CatSnapshotsRequest extends CatCatRequestBase {
   repository?: <>
   ignore_unavailable?: boolean
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `CatSnapshotsResponse` +==== CatSnapshotsResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type CatSnapshotsResponse = CatSnapshotsSnapshotsRecord[]
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-cat-tasks.asciidoc b/docs/reference-cat-tasks.asciidoc index f8b8aad21..e48e0d631 100644 --- a/docs/reference-cat-tasks.asciidoc +++ b/docs/reference-cat-tasks.asciidoc @@ -41,23 +41,33 @@ Returns information about tasks currently executing in the cluster. IMPORTANT: c ---- [discrete] -===== `CatTasksRequest` +==== CatTasksRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface CatTasksRequest extends CatCatRequestBase {
   actions?: string[]
   detailed?: boolean
   node_id?: string[]
   parent_task_id?: string
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `CatTasksResponse` +==== CatTasksResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type CatTasksResponse = CatTasksTasksRecord[]
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-cat-templates.asciidoc b/docs/reference-cat-templates.asciidoc index 6b8d7bd89..fe904ba52 100644 --- a/docs/reference-cat-templates.asciidoc +++ b/docs/reference-cat-templates.asciidoc @@ -41,20 +41,30 @@ Returns information about index templates in a cluster. You can use index templa ---- [discrete] -===== `CatTemplatesRequest` +==== CatTemplatesRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface CatTemplatesRequest extends CatCatRequestBase {
   name?: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `CatTemplatesResponse` +==== CatTemplatesResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type CatTemplatesResponse = CatTemplatesTemplatesRecord[]
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-cat-thread_pool.asciidoc b/docs/reference-cat-thread_pool.asciidoc index 0726614c0..05b52d18f 100644 --- a/docs/reference-cat-thread_pool.asciidoc +++ b/docs/reference-cat-thread_pool.asciidoc @@ -41,21 +41,31 @@ Returns thread pool statistics for each node in a cluster. Returned information ---- [discrete] -===== `CatThreadPoolRequest` +==== CatThreadPoolRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface CatThreadPoolRequest extends CatCatRequestBase {
   thread_pool_patterns?: <>
   time?: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `CatThreadPoolResponse` +==== CatThreadPoolResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type CatThreadPoolResponse = CatThreadPoolThreadPoolRecord[]
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-cat-transforms.asciidoc b/docs/reference-cat-transforms.asciidoc index 37b0fa11e..430340f2f 100644 --- a/docs/reference-cat-transforms.asciidoc +++ b/docs/reference-cat-transforms.asciidoc @@ -41,26 +41,36 @@ Get transforms. Returns configuration and usage information about transforms. CA ---- [discrete] -===== `CatTransformsRequest` +==== CatTransformsRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface CatTransformsRequest extends CatCatRequestBase {
   transform_id?: <>
   allow_no_match?: boolean
-  from?: <>
+  from?: number
   h?: CatCatTransformColumns
   s?: CatCatTransformColumns
   time?: <>
-  size?: <>
+  size?: number
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `CatTransformsResponse` +==== CatTransformsResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type CatTransformsResponse = CatTransformsTransformsRecord[]
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-ccr-delete_auto_follow_pattern.asciidoc b/docs/reference-ccr-delete_auto_follow_pattern.asciidoc index 9cc165b78..d731d4370 100644 --- a/docs/reference-ccr-delete_auto_follow_pattern.asciidoc +++ b/docs/reference-ccr-delete_auto_follow_pattern.asciidoc @@ -41,20 +41,30 @@ Deletes auto-follow patterns. ---- [discrete] -===== `CcrDeleteAutoFollowPatternRequest` +==== CcrDeleteAutoFollowPatternRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface CcrDeleteAutoFollowPatternRequest extends <> {
   name: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `CcrDeleteAutoFollowPatternResponse` +==== CcrDeleteAutoFollowPatternResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type CcrDeleteAutoFollowPatternResponse = <>
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-ccr-follow.asciidoc b/docs/reference-ccr-follow.asciidoc index bb6c2d42b..b7b770df7 100644 --- a/docs/reference-ccr-follow.asciidoc +++ b/docs/reference-ccr-follow.asciidoc @@ -41,37 +41,47 @@ Creates a new follower index configured to follow the referenced leader index. ---- [discrete] -===== `CcrFollowRequest` +==== CcrFollowRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface CcrFollowRequest extends <> {
   index: <>
   wait_for_active_shards?: <>
   leader_index?: <>
-  max_outstanding_read_requests?: <>
-  max_outstanding_write_requests?: <>
-  max_read_request_operation_count?: <>
+  max_outstanding_read_requests?: number
+  max_outstanding_write_requests?: number
+  max_read_request_operation_count?: number
   max_read_request_size?: string
   max_retry_delay?: <>
-  max_write_buffer_count?: <>
+  max_write_buffer_count?: number
   max_write_buffer_size?: string
-  max_write_request_operation_count?: <>
+  max_write_request_operation_count?: number
   max_write_request_size?: string
   read_poll_timeout?: <>
   remote_cluster?: string
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `CcrFollowResponse` +==== CcrFollowResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface CcrFollowResponse {
   follow_index_created: boolean
   follow_index_shards_acked: boolean
   index_following_started: boolean
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-ccr-follow_info.asciidoc b/docs/reference-ccr-follow_info.asciidoc index 451438c1a..deb0abe54 100644 --- a/docs/reference-ccr-follow_info.asciidoc +++ b/docs/reference-ccr-follow_info.asciidoc @@ -41,22 +41,32 @@ Retrieves information about all follower indices, including parameters and statu ---- [discrete] -===== `CcrFollowInfoRequest` +==== CcrFollowInfoRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface CcrFollowInfoRequest extends <> {
   index: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `CcrFollowInfoResponse` +==== CcrFollowInfoResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface CcrFollowInfoResponse {
   follower_indices: CcrFollowInfoFollowerIndex[]
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-ccr-follow_stats.asciidoc b/docs/reference-ccr-follow_stats.asciidoc index 853eeee16..42bd0ce29 100644 --- a/docs/reference-ccr-follow_stats.asciidoc +++ b/docs/reference-ccr-follow_stats.asciidoc @@ -41,22 +41,32 @@ Retrieves follower stats. return shard-level stats about the following tasks ass ---- [discrete] -===== `CcrFollowStatsRequest` +==== CcrFollowStatsRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface CcrFollowStatsRequest extends <> {
   index: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `CcrFollowStatsResponse` +==== CcrFollowStatsResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface CcrFollowStatsResponse {
   indices: CcrFollowIndexStats[]
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-ccr-forget_follower.asciidoc b/docs/reference-ccr-forget_follower.asciidoc index b752afd3e..ac89c0d72 100644 --- a/docs/reference-ccr-forget_follower.asciidoc +++ b/docs/reference-ccr-forget_follower.asciidoc @@ -41,10 +41,12 @@ Removes the follower retention leases from the leader. ---- [discrete] -===== `CcrForgetFollowerRequest` +==== CcrForgetFollowerRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface CcrForgetFollowerRequest extends <> {
   index: <>
   follower_cluster?: string
@@ -52,15 +54,23 @@ interface CcrForgetFollowerRequest extends <> {
   follower_index_uuid?: <>
   leader_remote_cluster?: string
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `CcrForgetFollowerResponse` +==== CcrForgetFollowerResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface CcrForgetFollowerResponse {
   _shards: <>
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-ccr-get_auto_follow_pattern.asciidoc b/docs/reference-ccr-get_auto_follow_pattern.asciidoc index 62dae8862..6a4df8812 100644 --- a/docs/reference-ccr-get_auto_follow_pattern.asciidoc +++ b/docs/reference-ccr-get_auto_follow_pattern.asciidoc @@ -41,22 +41,32 @@ Gets configured auto-follow patterns. Returns the specified auto-follow pattern ---- [discrete] -===== `CcrGetAutoFollowPatternRequest` +==== CcrGetAutoFollowPatternRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface CcrGetAutoFollowPatternRequest extends <> {
   name?: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `CcrGetAutoFollowPatternResponse` +==== CcrGetAutoFollowPatternResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface CcrGetAutoFollowPatternResponse {
   patterns: CcrGetAutoFollowPatternAutoFollowPattern[]
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-ccr-pause_auto_follow_pattern.asciidoc b/docs/reference-ccr-pause_auto_follow_pattern.asciidoc index 9d13e03e2..e11277ee4 100644 --- a/docs/reference-ccr-pause_auto_follow_pattern.asciidoc +++ b/docs/reference-ccr-pause_auto_follow_pattern.asciidoc @@ -41,20 +41,30 @@ Pauses an auto-follow pattern ---- [discrete] -===== `CcrPauseAutoFollowPatternRequest` +==== CcrPauseAutoFollowPatternRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface CcrPauseAutoFollowPatternRequest extends <> {
   name: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `CcrPauseAutoFollowPatternResponse` +==== CcrPauseAutoFollowPatternResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type CcrPauseAutoFollowPatternResponse = <>
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-ccr-pause_follow.asciidoc b/docs/reference-ccr-pause_follow.asciidoc index 2856ecc10..64f8155a0 100644 --- a/docs/reference-ccr-pause_follow.asciidoc +++ b/docs/reference-ccr-pause_follow.asciidoc @@ -41,20 +41,30 @@ Pauses a follower index. The follower index will not fetch any additional operat ---- [discrete] -===== `CcrPauseFollowRequest` +==== CcrPauseFollowRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface CcrPauseFollowRequest extends <> {
   index: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `CcrPauseFollowResponse` +==== CcrPauseFollowResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type CcrPauseFollowResponse = <>
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-ccr-put_auto_follow_pattern.asciidoc b/docs/reference-ccr-put_auto_follow_pattern.asciidoc index 6c6878547..24927041a 100644 --- a/docs/reference-ccr-put_auto_follow_pattern.asciidoc +++ b/docs/reference-ccr-put_auto_follow_pattern.asciidoc @@ -41,35 +41,45 @@ Creates a new named collection of auto-follow patterns against a specified remot ---- [discrete] -===== `CcrPutAutoFollowPatternRequest` +==== CcrPutAutoFollowPatternRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface CcrPutAutoFollowPatternRequest extends <> {
   name: <>
   remote_cluster: string
   follow_index_pattern?: <>
   leader_index_patterns?: <>
   leader_index_exclusion_patterns?: <>
-  max_outstanding_read_requests?: <>
+  max_outstanding_read_requests?: number
   settings?: Record
-  max_outstanding_write_requests?: <>
+  max_outstanding_write_requests?: number
   read_poll_timeout?: <>
-  max_read_request_operation_count?: <>
+  max_read_request_operation_count?: number
   max_read_request_size?: <>
   max_retry_delay?: <>
-  max_write_buffer_count?: <>
+  max_write_buffer_count?: number
   max_write_buffer_size?: <>
-  max_write_request_operation_count?: <>
+  max_write_request_operation_count?: number
   max_write_request_size?: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `CcrPutAutoFollowPatternResponse` +==== CcrPutAutoFollowPatternResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type CcrPutAutoFollowPatternResponse = <>
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-ccr-resume_auto_follow_pattern.asciidoc b/docs/reference-ccr-resume_auto_follow_pattern.asciidoc index 291ea1aa8..824758d70 100644 --- a/docs/reference-ccr-resume_auto_follow_pattern.asciidoc +++ b/docs/reference-ccr-resume_auto_follow_pattern.asciidoc @@ -41,20 +41,30 @@ Resumes an auto-follow pattern that has been paused ---- [discrete] -===== `CcrResumeAutoFollowPatternRequest` +==== CcrResumeAutoFollowPatternRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface CcrResumeAutoFollowPatternRequest extends <> {
   name: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `CcrResumeAutoFollowPatternResponse` +==== CcrResumeAutoFollowPatternResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type CcrResumeAutoFollowPatternResponse = <>
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-ccr-resume_follow.asciidoc b/docs/reference-ccr-resume_follow.asciidoc index 700defa44..5c40d5df6 100644 --- a/docs/reference-ccr-resume_follow.asciidoc +++ b/docs/reference-ccr-resume_follow.asciidoc @@ -41,30 +41,40 @@ Resumes a follower index that has been paused ---- [discrete] -===== `CcrResumeFollowRequest` +==== CcrResumeFollowRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface CcrResumeFollowRequest extends <> {
   index: <>
-  max_outstanding_read_requests?: <>
-  max_outstanding_write_requests?: <>
-  max_read_request_operation_count?: <>
+  max_outstanding_read_requests?: number
+  max_outstanding_write_requests?: number
+  max_read_request_operation_count?: number
   max_read_request_size?: string
   max_retry_delay?: <>
-  max_write_buffer_count?: <>
+  max_write_buffer_count?: number
   max_write_buffer_size?: string
-  max_write_request_operation_count?: <>
+  max_write_request_operation_count?: number
   max_write_request_size?: string
   read_poll_timeout?: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `CcrResumeFollowResponse` +==== CcrResumeFollowResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type CcrResumeFollowResponse = <>
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-ccr-stats.asciidoc b/docs/reference-ccr-stats.asciidoc index b1a4ba275..cc8b9f128 100644 --- a/docs/reference-ccr-stats.asciidoc +++ b/docs/reference-ccr-stats.asciidoc @@ -41,22 +41,32 @@ Gets all stats related to cross-cluster replication. ---- [discrete] -===== `CcrStatsRequest` +==== CcrStatsRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface CcrStatsRequest extends <> {
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `CcrStatsResponse` +==== CcrStatsResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface CcrStatsResponse {
   auto_follow_stats: CcrStatsAutoFollowStats
   follow_stats: CcrStatsFollowStats
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-ccr-unfollow.asciidoc b/docs/reference-ccr-unfollow.asciidoc index d0f071518..bc792e2c5 100644 --- a/docs/reference-ccr-unfollow.asciidoc +++ b/docs/reference-ccr-unfollow.asciidoc @@ -41,20 +41,30 @@ Stops the following task associated with a follower index and removes index meta ---- [discrete] -===== `CcrUnfollowRequest` +==== CcrUnfollowRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface CcrUnfollowRequest extends <> {
   index: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `CcrUnfollowResponse` +==== CcrUnfollowResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type CcrUnfollowResponse = <>
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-clear_scroll.asciidoc b/docs/reference-clear_scroll.asciidoc index 2bc343786..24ef6297a 100644 --- a/docs/reference-clear_scroll.asciidoc +++ b/docs/reference-clear_scroll.asciidoc @@ -41,23 +41,33 @@ Clear a scrolling search. Clear the search context and results for a scrolling s ---- [discrete] -===== `ClearScrollRequest` +==== ClearScrollRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface ClearScrollRequest extends <> {
   scroll_id?: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `ClearScrollResponse` +==== ClearScrollResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface ClearScrollResponse {
   succeeded: boolean
-  num_freed: <>
+  num_freed: number
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-close_point_in_time.asciidoc b/docs/reference-close_point_in_time.asciidoc index 2e4c9f2f7..a6b5d3b34 100644 --- a/docs/reference-close_point_in_time.asciidoc +++ b/docs/reference-close_point_in_time.asciidoc @@ -41,23 +41,33 @@ Close a point in time. A point in time must be opened explicitly before being us ---- [discrete] -===== `ClosePointInTimeRequest` +==== ClosePointInTimeRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface ClosePointInTimeRequest extends <> {
   id: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `ClosePointInTimeResponse` +==== ClosePointInTimeResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface ClosePointInTimeResponse {
   succeeded: boolean
-  num_freed: <>
+  num_freed: number
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-cluster-allocation_explain.asciidoc b/docs/reference-cluster-allocation_explain.asciidoc index e85bfcd1e..f65bd16e4 100644 --- a/docs/reference-cluster-allocation_explain.asciidoc +++ b/docs/reference-cluster-allocation_explain.asciidoc @@ -41,25 +41,32 @@ Provides explanations for shard allocations in the cluster. ---- [discrete] -===== `ClusterAllocationExplainRequest` +==== ClusterAllocationExplainRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface ClusterAllocationExplainRequest extends <> {
   include_disk_info?: boolean
   include_yes_decisions?: boolean
   current_node?: string
   index?: <>
   primary?: boolean
-  shard?: <>
+  shard?: number
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `ClusterAllocationExplainResponse` +==== ClusterAllocationExplainResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface ClusterAllocationExplainResponse {
   allocate_explanation?: string
   allocation_delay?: <>
@@ -83,9 +90,12 @@ interface ClusterAllocationExplainResponse {
   rebalance_explanation?: string
   remaining_delay?: <>
   remaining_delay_in_millis?: <><<>>
-  shard: <>
+  shard: number
   unassigned_info?: ClusterAllocationExplainUnassignedInformation
   note?: string
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-cluster-delete_component_template.asciidoc b/docs/reference-cluster-delete_component_template.asciidoc index 3d5b460da..f5dc519de 100644 --- a/docs/reference-cluster-delete_component_template.asciidoc +++ b/docs/reference-cluster-delete_component_template.asciidoc @@ -41,22 +41,32 @@ Delete component templates. Deletes component templates. Component templates are ---- [discrete] -===== `ClusterDeleteComponentTemplateRequest` +==== ClusterDeleteComponentTemplateRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface ClusterDeleteComponentTemplateRequest extends <> {
   name: <>
   master_timeout?: <>
   timeout?: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `ClusterDeleteComponentTemplateResponse` +==== ClusterDeleteComponentTemplateResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type ClusterDeleteComponentTemplateResponse = <>
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-cluster-delete_voting_config_exclusions.asciidoc b/docs/reference-cluster-delete_voting_config_exclusions.asciidoc index 1a95d2f54..4642bdd0c 100644 --- a/docs/reference-cluster-delete_voting_config_exclusions.asciidoc +++ b/docs/reference-cluster-delete_voting_config_exclusions.asciidoc @@ -41,20 +41,30 @@ Clears cluster voting config exclusions. ---- [discrete] -===== `ClusterDeleteVotingConfigExclusionsRequest` +==== ClusterDeleteVotingConfigExclusionsRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface ClusterDeleteVotingConfigExclusionsRequest extends <> {
   wait_for_removal?: boolean
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `ClusterDeleteVotingConfigExclusionsResponse` +==== ClusterDeleteVotingConfigExclusionsResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type ClusterDeleteVotingConfigExclusionsResponse = boolean
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-cluster-exists_component_template.asciidoc b/docs/reference-cluster-exists_component_template.asciidoc index ffb8e5ba4..b1d1e8635 100644 --- a/docs/reference-cluster-exists_component_template.asciidoc +++ b/docs/reference-cluster-exists_component_template.asciidoc @@ -41,22 +41,32 @@ Check component templates. Returns information about whether a particular compon ---- [discrete] -===== `ClusterExistsComponentTemplateRequest` +==== ClusterExistsComponentTemplateRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface ClusterExistsComponentTemplateRequest extends <> {
   name: <>
   master_timeout?: <>
   local?: boolean
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `ClusterExistsComponentTemplateResponse` +==== ClusterExistsComponentTemplateResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type ClusterExistsComponentTemplateResponse = boolean
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-cluster-get_component_template.asciidoc b/docs/reference-cluster-get_component_template.asciidoc index b547aa17c..d7267ff04 100644 --- a/docs/reference-cluster-get_component_template.asciidoc +++ b/docs/reference-cluster-get_component_template.asciidoc @@ -41,10 +41,12 @@ Get component templates. Retrieves information about component templates. ---- [discrete] -===== `ClusterGetComponentTemplateRequest` +==== ClusterGetComponentTemplateRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface ClusterGetComponentTemplateRequest extends <> {
   name?: <>
   flat_settings?: boolean
@@ -52,15 +54,23 @@ interface ClusterGetComponentTemplateRequest extends <> {
   local?: boolean
   master_timeout?: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `ClusterGetComponentTemplateResponse` +==== ClusterGetComponentTemplateResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface ClusterGetComponentTemplateResponse {
   component_templates: ClusterComponentTemplate[]
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-cluster-get_settings.asciidoc b/docs/reference-cluster-get_settings.asciidoc index adcf8e948..ec6dd701b 100644 --- a/docs/reference-cluster-get_settings.asciidoc +++ b/docs/reference-cluster-get_settings.asciidoc @@ -41,27 +41,37 @@ Returns cluster-wide settings. By default, it returns only settings that have be ---- [discrete] -===== `ClusterGetSettingsRequest` +==== ClusterGetSettingsRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface ClusterGetSettingsRequest extends <> {
   flat_settings?: boolean
   include_defaults?: boolean
   master_timeout?: <>
   timeout?: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `ClusterGetSettingsResponse` +==== ClusterGetSettingsResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface ClusterGetSettingsResponse {
   persistent: Record
   transient: Record
   defaults?: Record
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-cluster-health.asciidoc b/docs/reference-cluster-health.asciidoc index 7c80c37a1..29be6d5fc 100644 --- a/docs/reference-cluster-health.asciidoc +++ b/docs/reference-cluster-health.asciidoc @@ -41,10 +41,12 @@ The cluster health API returns a simple status on the health of the cluster. You ---- [discrete] -===== `ClusterHealthRequest` +==== ClusterHealthRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface ClusterHealthRequest extends <> {
   index?: <>
   expand_wildcards?: <>
@@ -54,18 +56,26 @@ interface ClusterHealthRequest extends <> {
   timeout?: <>
   wait_for_active_shards?: <>
   wait_for_events?: <>
-  wait_for_nodes?: string | <>
+  wait_for_nodes?: string | number
   wait_for_no_initializing_shards?: boolean
   wait_for_no_relocating_shards?: boolean
   wait_for_status?: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `ClusterHealthResponse` +==== ClusterHealthResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type ClusterHealthResponse = ClusterHealthHealthResponseBody
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-cluster-info.asciidoc b/docs/reference-cluster-info.asciidoc index 14d9c1889..b5ff01496 100644 --- a/docs/reference-cluster-info.asciidoc +++ b/docs/reference-cluster-info.asciidoc @@ -41,20 +41,27 @@ Get cluster info. Returns basic information about the cluster. ---- [discrete] -===== `ClusterInfoRequest` +==== ClusterInfoRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface ClusterInfoRequest extends <> {
   target: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `ClusterInfoResponse` +==== ClusterInfoResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface ClusterInfoResponse {
   cluster_name: <>
   http?: NodesHttp
@@ -62,5 +69,8 @@ interface ClusterInfoResponse {
   thread_pool?: Record
   script?: NodesScripting
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-cluster-pending_tasks.asciidoc b/docs/reference-cluster-pending_tasks.asciidoc index d528df913..6baf37f69 100644 --- a/docs/reference-cluster-pending_tasks.asciidoc +++ b/docs/reference-cluster-pending_tasks.asciidoc @@ -41,23 +41,33 @@ Returns cluster-level changes (such as create index, update mapping, allocate or ---- [discrete] -===== `ClusterPendingTasksRequest` +==== ClusterPendingTasksRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface ClusterPendingTasksRequest extends <> {
   local?: boolean
   master_timeout?: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `ClusterPendingTasksResponse` +==== ClusterPendingTasksResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface ClusterPendingTasksResponse {
   tasks: ClusterPendingTasksPendingTask[]
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-cluster-post_voting_config_exclusions.asciidoc b/docs/reference-cluster-post_voting_config_exclusions.asciidoc index 76c0757e1..67816ac1e 100644 --- a/docs/reference-cluster-post_voting_config_exclusions.asciidoc +++ b/docs/reference-cluster-post_voting_config_exclusions.asciidoc @@ -41,22 +41,32 @@ Updates the cluster voting config exclusions by node ids or node names. ---- [discrete] -===== `ClusterPostVotingConfigExclusionsRequest` +==== ClusterPostVotingConfigExclusionsRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface ClusterPostVotingConfigExclusionsRequest extends <> {
   node_names?: <>
   node_ids?: <>
   timeout?: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `ClusterPostVotingConfigExclusionsResponse` +==== ClusterPostVotingConfigExclusionsResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type ClusterPostVotingConfigExclusionsResponse = boolean
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-cluster-put_component_template.asciidoc b/docs/reference-cluster-put_component_template.asciidoc index db145d28f..e591b7a83 100644 --- a/docs/reference-cluster-put_component_template.asciidoc +++ b/docs/reference-cluster-put_component_template.asciidoc @@ -41,10 +41,12 @@ Create or update a component template. Creates or updates a component template. ---- [discrete] -===== `ClusterPutComponentTemplateRequest` +==== ClusterPutComponentTemplateRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface ClusterPutComponentTemplateRequest extends <> {
   name: <>
   create?: boolean
@@ -54,13 +56,21 @@ interface ClusterPutComponentTemplateRequest extends <> {
   _meta?: <>
   deprecated?: boolean
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `ClusterPutComponentTemplateResponse` +==== ClusterPutComponentTemplateResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type ClusterPutComponentTemplateResponse = <>
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-cluster-put_settings.asciidoc b/docs/reference-cluster-put_settings.asciidoc index 7e6a9bc31..f180c979f 100644 --- a/docs/reference-cluster-put_settings.asciidoc +++ b/docs/reference-cluster-put_settings.asciidoc @@ -41,10 +41,12 @@ Updates the cluster settings. ---- [discrete] -===== `ClusterPutSettingsRequest` +==== ClusterPutSettingsRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface ClusterPutSettingsRequest extends <> {
   flat_settings?: boolean
   master_timeout?: <>
@@ -52,17 +54,25 @@ interface ClusterPutSettingsRequest extends <> {
   persistent?: Record
   transient?: Record
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `ClusterPutSettingsResponse` +==== ClusterPutSettingsResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface ClusterPutSettingsResponse {
   acknowledged: boolean
   persistent: Record
   transient: Record
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-cluster-remote_info.asciidoc b/docs/reference-cluster-remote_info.asciidoc index 10078a0a4..003f5914b 100644 --- a/docs/reference-cluster-remote_info.asciidoc +++ b/docs/reference-cluster-remote_info.asciidoc @@ -41,19 +41,29 @@ The cluster remote info API allows you to retrieve all of the configured remote ---- [discrete] -===== `ClusterRemoteInfoRequest` +==== ClusterRemoteInfoRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface ClusterRemoteInfoRequest extends <> {
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `ClusterRemoteInfoResponse` +==== ClusterRemoteInfoResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type ClusterRemoteInfoResponse = Record
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-cluster-reroute.asciidoc b/docs/reference-cluster-reroute.asciidoc index 2d28e8f8e..d88f3abea 100644 --- a/docs/reference-cluster-reroute.asciidoc +++ b/docs/reference-cluster-reroute.asciidoc @@ -41,10 +41,12 @@ Allows to manually change the allocation of individual shards in the cluster. ---- [discrete] -===== `ClusterRerouteRequest` +==== ClusterRerouteRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface ClusterRerouteRequest extends <> {
   dry_run?: boolean
   explain?: boolean
@@ -54,17 +56,25 @@ interface ClusterRerouteRequest extends <> {
   timeout?: <>
   commands?: ClusterRerouteCommand[]
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `ClusterRerouteResponse` +==== ClusterRerouteResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface ClusterRerouteResponse {
   acknowledged: boolean
   explanations?: ClusterRerouteRerouteExplanation[]
   state?: any
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-cluster-state.asciidoc b/docs/reference-cluster-state.asciidoc index 1498d90a1..2cd8d43e4 100644 --- a/docs/reference-cluster-state.asciidoc +++ b/docs/reference-cluster-state.asciidoc @@ -41,10 +41,12 @@ Returns a comprehensive information about the state of the cluster. ---- [discrete] -===== `ClusterStateRequest` +==== ClusterStateRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface ClusterStateRequest extends <> {
   metric?: <>
   index?: <>
@@ -57,13 +59,21 @@ interface ClusterStateRequest extends <> {
   wait_for_metadata_version?: <>
   wait_for_timeout?: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `ClusterStateResponse` +==== ClusterStateResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type ClusterStateResponse = any
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-cluster-stats.asciidoc b/docs/reference-cluster-stats.asciidoc index c11e17ed2..7d0641d8a 100644 --- a/docs/reference-cluster-stats.asciidoc +++ b/docs/reference-cluster-stats.asciidoc @@ -41,22 +41,32 @@ Returns cluster statistics. It returns basic index metrics (shard numbers, store ---- [discrete] -===== `ClusterStatsRequest` +==== ClusterStatsRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface ClusterStatsRequest extends <> {
   node_id?: <>
   include_remotes?: boolean
   timeout?: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `ClusterStatsResponse` +==== ClusterStatsResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type ClusterStatsResponse = ClusterStatsStatsResponseBase
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-connector-check_in.asciidoc b/docs/reference-connector-check_in.asciidoc index 55dd98b92..30a8f2c84 100644 --- a/docs/reference-connector-check_in.asciidoc +++ b/docs/reference-connector-check_in.asciidoc @@ -41,22 +41,32 @@ Check in a connector. Update the `last_seen` field in the connector and set it t ---- [discrete] -===== `ConnectorCheckInRequest` +==== ConnectorCheckInRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface ConnectorCheckInRequest extends <> {
   connector_id: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `ConnectorCheckInResponse` +==== ConnectorCheckInResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface ConnectorCheckInResponse {
   result: <>
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-connector-delete.asciidoc b/docs/reference-connector-delete.asciidoc index 9ddb9ba8d..001e972fe 100644 --- a/docs/reference-connector-delete.asciidoc +++ b/docs/reference-connector-delete.asciidoc @@ -41,21 +41,31 @@ Delete a connector. Removes a connector and associated sync jobs. This is a dest ---- [discrete] -===== `ConnectorDeleteRequest` +==== ConnectorDeleteRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface ConnectorDeleteRequest extends <> {
   connector_id: <>
   delete_sync_jobs?: boolean
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `ConnectorDeleteResponse` +==== ConnectorDeleteResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type ConnectorDeleteResponse = <>
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-connector-get.asciidoc b/docs/reference-connector-get.asciidoc index f0894535f..60d77f782 100644 --- a/docs/reference-connector-get.asciidoc +++ b/docs/reference-connector-get.asciidoc @@ -41,20 +41,30 @@ Get a connector. Get the details about a connector. ---- [discrete] -===== `ConnectorGetRequest` +==== ConnectorGetRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface ConnectorGetRequest extends <> {
   connector_id: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `ConnectorGetResponse` +==== ConnectorGetResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type ConnectorGetResponse = ConnectorConnector
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-connector-list.asciidoc b/docs/reference-connector-list.asciidoc index ec61e4ff6..4e71cda25 100644 --- a/docs/reference-connector-list.asciidoc +++ b/docs/reference-connector-list.asciidoc @@ -41,28 +41,38 @@ Get all connectors. Get information about all connectors. ---- [discrete] -===== `ConnectorListRequest` +==== ConnectorListRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface ConnectorListRequest extends <> {
-  from?: <>
-  size?: <>
+  from?: number
+  size?: number
   index_name?: <>
   connector_name?: <>
   service_type?: <>
   query?: string
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `ConnectorListResponse` +==== ConnectorListResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface ConnectorListResponse {
-  count: <>
+  count: number
   results: ConnectorConnector[]
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-connector-post.asciidoc b/docs/reference-connector-post.asciidoc index 0aca7b9b1..818131b1c 100644 --- a/docs/reference-connector-post.asciidoc +++ b/docs/reference-connector-post.asciidoc @@ -41,10 +41,12 @@ Create a connector. Connectors are Elasticsearch integrations that bring content ---- [discrete] -===== `ConnectorPostRequest` +==== ConnectorPostRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface ConnectorPostRequest extends <> {
   description?: string
   index_name?: <>
@@ -53,16 +55,24 @@ interface ConnectorPostRequest extends <> {
   name?: string
   service_type?: string
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `ConnectorPostResponse` +==== ConnectorPostResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface ConnectorPostResponse {
   result: <>
   id: <>
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-connector-put.asciidoc b/docs/reference-connector-put.asciidoc index 939d109d8..4df06d749 100644 --- a/docs/reference-connector-put.asciidoc +++ b/docs/reference-connector-put.asciidoc @@ -41,10 +41,12 @@ Create or update a connector. ---- [discrete] -===== `ConnectorPutRequest` +==== ConnectorPutRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface ConnectorPutRequest extends <> {
   connector_id?: <>
   description?: string
@@ -54,16 +56,24 @@ interface ConnectorPutRequest extends <> {
   name?: string
   service_type?: string
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `ConnectorPutResponse` +==== ConnectorPutResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface ConnectorPutResponse {
   result: <>
   id: <>
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-connector-sync_job_cancel.asciidoc b/docs/reference-connector-sync_job_cancel.asciidoc index e977c0f1e..fb181004f 100644 --- a/docs/reference-connector-sync_job_cancel.asciidoc +++ b/docs/reference-connector-sync_job_cancel.asciidoc @@ -41,22 +41,32 @@ Cancel a connector sync job. Cancel a connector sync job, which sets the status ---- [discrete] -===== `ConnectorSyncJobCancelRequest` +==== ConnectorSyncJobCancelRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface ConnectorSyncJobCancelRequest extends <> {
   connector_sync_job_id: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `ConnectorSyncJobCancelResponse` +==== ConnectorSyncJobCancelResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface ConnectorSyncJobCancelResponse {
   result: <>
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-connector-sync_job_check_in.asciidoc b/docs/reference-connector-sync_job_check_in.asciidoc index e10c2eaf7..12d90ae3d 100644 --- a/docs/reference-connector-sync_job_check_in.asciidoc +++ b/docs/reference-connector-sync_job_check_in.asciidoc @@ -40,20 +40,3 @@ Checks in a connector sync job (refreshes 'last_seen'). (ConnectorSyncJobCheckInRequest, options?): Promise ---- -[discrete] -===== `ConnectorSyncJobCheckInRequest` - -[source,ts] ----- -{ -} ----- - -[discrete] -===== `ConnectorSyncJobCheckInResponse` - -[source,ts] ----- -n/a ----- - diff --git a/docs/reference-connector-sync_job_claim.asciidoc b/docs/reference-connector-sync_job_claim.asciidoc index 889dfb29e..da5254b69 100644 --- a/docs/reference-connector-sync_job_claim.asciidoc +++ b/docs/reference-connector-sync_job_claim.asciidoc @@ -38,20 +38,3 @@ Claims a connector sync job. (ConnectorSyncJobClaimRequest, options?): Promise ---- -[discrete] -===== `ConnectorSyncJobClaimRequest` - -[source,ts] ----- -{ -} ----- - -[discrete] -===== `ConnectorSyncJobClaimResponse` - -[source,ts] ----- -n/a ----- - diff --git a/docs/reference-connector-sync_job_delete.asciidoc b/docs/reference-connector-sync_job_delete.asciidoc index e8186c33a..ada8ef8fe 100644 --- a/docs/reference-connector-sync_job_delete.asciidoc +++ b/docs/reference-connector-sync_job_delete.asciidoc @@ -41,20 +41,30 @@ Delete a connector sync job. Remove a connector sync job and its associated data ---- [discrete] -===== `ConnectorSyncJobDeleteRequest` +==== ConnectorSyncJobDeleteRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface ConnectorSyncJobDeleteRequest extends <> {
   connector_sync_job_id: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `ConnectorSyncJobDeleteResponse` +==== ConnectorSyncJobDeleteResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type ConnectorSyncJobDeleteResponse = <>
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-connector-sync_job_error.asciidoc b/docs/reference-connector-sync_job_error.asciidoc index aba697d1c..ec4dfab70 100644 --- a/docs/reference-connector-sync_job_error.asciidoc +++ b/docs/reference-connector-sync_job_error.asciidoc @@ -40,20 +40,3 @@ Sets an error for a connector sync job. (ConnectorSyncJobErrorRequest, options?): Promise ---- -[discrete] -===== `ConnectorSyncJobErrorRequest` - -[source,ts] ----- -{ -} ----- - -[discrete] -===== `ConnectorSyncJobErrorResponse` - -[source,ts] ----- -n/a ----- - diff --git a/docs/reference-connector-sync_job_get.asciidoc b/docs/reference-connector-sync_job_get.asciidoc index 32ce6fd94..9e13fd60c 100644 --- a/docs/reference-connector-sync_job_get.asciidoc +++ b/docs/reference-connector-sync_job_get.asciidoc @@ -41,20 +41,30 @@ Get a connector sync job. ---- [discrete] -===== `ConnectorSyncJobGetRequest` +==== ConnectorSyncJobGetRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface ConnectorSyncJobGetRequest extends <> {
   connector_sync_job_id: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `ConnectorSyncJobGetResponse` +==== ConnectorSyncJobGetResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type ConnectorSyncJobGetResponse = ConnectorConnectorSyncJob
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-connector-sync_job_list.asciidoc b/docs/reference-connector-sync_job_list.asciidoc index 5ad848fcf..ea20284d1 100644 --- a/docs/reference-connector-sync_job_list.asciidoc +++ b/docs/reference-connector-sync_job_list.asciidoc @@ -41,27 +41,37 @@ Get all connector sync jobs. Get information about all stored connector sync job ---- [discrete] -===== `ConnectorSyncJobListRequest` +==== ConnectorSyncJobListRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface ConnectorSyncJobListRequest extends <> {
-  from?: <>
-  size?: <>
+  from?: number
+  size?: number
   status?: ConnectorSyncStatus
   connector_id?: <>
   job_type?: ConnectorSyncJobType | ConnectorSyncJobType[]
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `ConnectorSyncJobListResponse` +==== ConnectorSyncJobListResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface ConnectorSyncJobListResponse {
-  count: <>
+  count: number
   results: ConnectorConnectorSyncJob[]
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-connector-sync_job_post.asciidoc b/docs/reference-connector-sync_job_post.asciidoc index a02c86f66..d8daa9ff5 100644 --- a/docs/reference-connector-sync_job_post.asciidoc +++ b/docs/reference-connector-sync_job_post.asciidoc @@ -41,24 +41,34 @@ Create a connector sync job. Create a connector sync job document in the interna ---- [discrete] -===== `ConnectorSyncJobPostRequest` +==== ConnectorSyncJobPostRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface ConnectorSyncJobPostRequest extends <> {
   id: <>
   job_type?: ConnectorSyncJobType
   trigger_method?: ConnectorSyncJobTriggerMethod
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `ConnectorSyncJobPostResponse` +==== ConnectorSyncJobPostResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface ConnectorSyncJobPostResponse {
   id: <>
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-connector-sync_job_update_stats.asciidoc b/docs/reference-connector-sync_job_update_stats.asciidoc index 8ef50dd09..240b4d28b 100644 --- a/docs/reference-connector-sync_job_update_stats.asciidoc +++ b/docs/reference-connector-sync_job_update_stats.asciidoc @@ -40,20 +40,3 @@ Updates the stats fields in the connector sync job document. (ConnectorSyncJobUpdateStatsRequest, options?): Promise ---- -[discrete] -===== `ConnectorSyncJobUpdateStatsRequest` - -[source,ts] ----- -{ -} ----- - -[discrete] -===== `ConnectorSyncJobUpdateStatsResponse` - -[source,ts] ----- -n/a ----- - diff --git a/docs/reference-connector-update_active_filtering.asciidoc b/docs/reference-connector-update_active_filtering.asciidoc index 3905b60f8..0096fa7a5 100644 --- a/docs/reference-connector-update_active_filtering.asciidoc +++ b/docs/reference-connector-update_active_filtering.asciidoc @@ -41,22 +41,32 @@ Activate the connector draft filter. Activates the valid draft filtering for a c ---- [discrete] -===== `ConnectorUpdateActiveFilteringRequest` +==== ConnectorUpdateActiveFilteringRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface ConnectorUpdateActiveFilteringRequest extends <> {
   connector_id: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `ConnectorUpdateActiveFilteringResponse` +==== ConnectorUpdateActiveFilteringResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface ConnectorUpdateActiveFilteringResponse {
   result: <>
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-connector-update_api_key_id.asciidoc b/docs/reference-connector-update_api_key_id.asciidoc index e78f1af6a..88c979af5 100644 --- a/docs/reference-connector-update_api_key_id.asciidoc +++ b/docs/reference-connector-update_api_key_id.asciidoc @@ -41,24 +41,34 @@ Update the connector API key ID. Update the `api_key_id` and `api_key_secret_id` ---- [discrete] -===== `ConnectorUpdateApiKeyIdRequest` +==== ConnectorUpdateApiKeyIdRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface ConnectorUpdateApiKeyIdRequest extends <> {
   connector_id: <>
   api_key_id?: string
   api_key_secret_id?: string
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `ConnectorUpdateApiKeyIdResponse` +==== ConnectorUpdateApiKeyIdResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface ConnectorUpdateApiKeyIdResponse {
   result: <>
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-connector-update_configuration.asciidoc b/docs/reference-connector-update_configuration.asciidoc index 82c080c2c..9be03856b 100644 --- a/docs/reference-connector-update_configuration.asciidoc +++ b/docs/reference-connector-update_configuration.asciidoc @@ -41,24 +41,34 @@ Update the connector configuration. Update the configuration field in the connec ---- [discrete] -===== `ConnectorUpdateConfigurationRequest` +==== ConnectorUpdateConfigurationRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface ConnectorUpdateConfigurationRequest extends <> {
   connector_id: <>
   configuration?: ConnectorConnectorConfiguration
   values?: Record
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `ConnectorUpdateConfigurationResponse` +==== ConnectorUpdateConfigurationResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface ConnectorUpdateConfigurationResponse {
   result: <>
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-connector-update_error.asciidoc b/docs/reference-connector-update_error.asciidoc index 9f3dae2e4..a9925efb8 100644 --- a/docs/reference-connector-update_error.asciidoc +++ b/docs/reference-connector-update_error.asciidoc @@ -41,23 +41,33 @@ Update the connector error field. Set the error field for the connector. If the ---- [discrete] -===== `ConnectorUpdateErrorRequest` +==== ConnectorUpdateErrorRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface ConnectorUpdateErrorRequest extends <> {
   connector_id: <>
-  error: SpecUtilsWithNullValue
+  error: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `ConnectorUpdateErrorResponse` +==== ConnectorUpdateErrorResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface ConnectorUpdateErrorResponse {
   result: <>
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-connector-update_features.asciidoc b/docs/reference-connector-update_features.asciidoc index ceb4f10b4..5b2ebd7d3 100644 --- a/docs/reference-connector-update_features.asciidoc +++ b/docs/reference-connector-update_features.asciidoc @@ -40,20 +40,3 @@ Updates the connector features in the connector document. (ConnectorUpdateFeaturesRequest, options?): Promise ---- -[discrete] -===== `ConnectorUpdateFeaturesRequest` - -[source,ts] ----- -{ -} ----- - -[discrete] -===== `ConnectorUpdateFeaturesResponse` - -[source,ts] ----- -n/a ----- - diff --git a/docs/reference-connector-update_filtering.asciidoc b/docs/reference-connector-update_filtering.asciidoc index b6bca94ea..503f3c407 100644 --- a/docs/reference-connector-update_filtering.asciidoc +++ b/docs/reference-connector-update_filtering.asciidoc @@ -41,25 +41,35 @@ Update the connector filtering. Update the draft filtering configuration of a co ---- [discrete] -===== `ConnectorUpdateFilteringRequest` +==== ConnectorUpdateFilteringRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface ConnectorUpdateFilteringRequest extends <> {
   connector_id: <>
   filtering?: ConnectorFilteringConfig[]
   rules?: ConnectorFilteringRule[]
   advanced_snippet?: ConnectorFilteringAdvancedSnippet
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `ConnectorUpdateFilteringResponse` +==== ConnectorUpdateFilteringResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface ConnectorUpdateFilteringResponse {
   result: <>
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-connector-update_filtering_validation.asciidoc b/docs/reference-connector-update_filtering_validation.asciidoc index 8a83ef4f6..5293f90dc 100644 --- a/docs/reference-connector-update_filtering_validation.asciidoc +++ b/docs/reference-connector-update_filtering_validation.asciidoc @@ -39,23 +39,33 @@ Update the connector draft filtering validation. Update the draft filtering vali ---- [discrete] -===== `ConnectorUpdateFilteringValidationRequest` +==== ConnectorUpdateFilteringValidationRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface ConnectorUpdateFilteringValidationRequest extends <> {
   connector_id: <>
   validation: ConnectorFilteringRulesValidation
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `ConnectorUpdateFilteringValidationResponse` +==== ConnectorUpdateFilteringValidationResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface ConnectorUpdateFilteringValidationResponse {
   result: <>
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-connector-update_index_name.asciidoc b/docs/reference-connector-update_index_name.asciidoc index 56109727c..bc1f742d3 100644 --- a/docs/reference-connector-update_index_name.asciidoc +++ b/docs/reference-connector-update_index_name.asciidoc @@ -41,23 +41,33 @@ Update the connector index name. Update the `index_name` field of a connector, s ---- [discrete] -===== `ConnectorUpdateIndexNameRequest` +==== ConnectorUpdateIndexNameRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface ConnectorUpdateIndexNameRequest extends <> {
   connector_id: <>
-  index_name: SpecUtilsWithNullValue<<>>
+  index_name: <><<>>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `ConnectorUpdateIndexNameResponse` +==== ConnectorUpdateIndexNameResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface ConnectorUpdateIndexNameResponse {
   result: <>
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-connector-update_name.asciidoc b/docs/reference-connector-update_name.asciidoc index c60bd18a7..5f8162eed 100644 --- a/docs/reference-connector-update_name.asciidoc +++ b/docs/reference-connector-update_name.asciidoc @@ -41,24 +41,34 @@ Update the connector name and description. ---- [discrete] -===== `ConnectorUpdateNameRequest` +==== ConnectorUpdateNameRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface ConnectorUpdateNameRequest extends <> {
   connector_id: <>
   name?: string
   description?: string
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `ConnectorUpdateNameResponse` +==== ConnectorUpdateNameResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface ConnectorUpdateNameResponse {
   result: <>
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-connector-update_native.asciidoc b/docs/reference-connector-update_native.asciidoc index df3d72f68..ca12d017e 100644 --- a/docs/reference-connector-update_native.asciidoc +++ b/docs/reference-connector-update_native.asciidoc @@ -39,23 +39,33 @@ Update the connector is_native flag. ---- [discrete] -===== `ConnectorUpdateNativeRequest` +==== ConnectorUpdateNativeRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface ConnectorUpdateNativeRequest extends <> {
   connector_id: <>
   is_native: boolean
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `ConnectorUpdateNativeResponse` +==== ConnectorUpdateNativeResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface ConnectorUpdateNativeResponse {
   result: <>
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-connector-update_pipeline.asciidoc b/docs/reference-connector-update_pipeline.asciidoc index eda967b41..f002769b4 100644 --- a/docs/reference-connector-update_pipeline.asciidoc +++ b/docs/reference-connector-update_pipeline.asciidoc @@ -41,23 +41,33 @@ Update the connector pipeline. When you create a new connector, the configuratio ---- [discrete] -===== `ConnectorUpdatePipelineRequest` +==== ConnectorUpdatePipelineRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface ConnectorUpdatePipelineRequest extends <> {
   connector_id: <>
   pipeline: ConnectorIngestPipelineParams
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `ConnectorUpdatePipelineResponse` +==== ConnectorUpdatePipelineResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface ConnectorUpdatePipelineResponse {
   result: <>
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-connector-update_scheduling.asciidoc b/docs/reference-connector-update_scheduling.asciidoc index 76cceaa41..ebbd99e48 100644 --- a/docs/reference-connector-update_scheduling.asciidoc +++ b/docs/reference-connector-update_scheduling.asciidoc @@ -41,23 +41,33 @@ Update the connector scheduling. ---- [discrete] -===== `ConnectorUpdateSchedulingRequest` +==== ConnectorUpdateSchedulingRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface ConnectorUpdateSchedulingRequest extends <> {
   connector_id: <>
   scheduling: ConnectorSchedulingConfiguration
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `ConnectorUpdateSchedulingResponse` +==== ConnectorUpdateSchedulingResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface ConnectorUpdateSchedulingResponse {
   result: <>
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-connector-update_service_type.asciidoc b/docs/reference-connector-update_service_type.asciidoc index 9e93523cf..1199530a3 100644 --- a/docs/reference-connector-update_service_type.asciidoc +++ b/docs/reference-connector-update_service_type.asciidoc @@ -41,23 +41,33 @@ Update the connector service type. ---- [discrete] -===== `ConnectorUpdateServiceTypeRequest` +==== ConnectorUpdateServiceTypeRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface ConnectorUpdateServiceTypeRequest extends <> {
   connector_id: <>
   service_type: string
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `ConnectorUpdateServiceTypeResponse` +==== ConnectorUpdateServiceTypeResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface ConnectorUpdateServiceTypeResponse {
   result: <>
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-connector-update_status.asciidoc b/docs/reference-connector-update_status.asciidoc index ae0b32122..081615760 100644 --- a/docs/reference-connector-update_status.asciidoc +++ b/docs/reference-connector-update_status.asciidoc @@ -41,23 +41,33 @@ Update the connector status. ---- [discrete] -===== `ConnectorUpdateStatusRequest` +==== ConnectorUpdateStatusRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface ConnectorUpdateStatusRequest extends <> {
   connector_id: <>
   status: ConnectorConnectorStatus
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `ConnectorUpdateStatusResponse` +==== ConnectorUpdateStatusResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface ConnectorUpdateStatusResponse {
   result: <>
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-count.asciidoc b/docs/reference-count.asciidoc index 0c1fb860a..f705ad493 100644 --- a/docs/reference-count.asciidoc +++ b/docs/reference-count.asciidoc @@ -41,10 +41,12 @@ Returns number of documents matching a query. ---- [discrete] -===== `CountRequest` +==== CountRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface CountRequest extends <> {
   index?: <>
   allow_no_indices?: boolean
@@ -56,23 +58,31 @@ interface CountRequest extends <> {
   ignore_throttled?: boolean
   ignore_unavailable?: boolean
   lenient?: boolean
-  min_score?: <>
+  min_score?: number
   preference?: string
   routing?: <>
-  terminate_after?: <>
+  terminate_after?: number
   q?: string
   query?: QueryDslQueryContainer
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `CountResponse` +==== CountResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface CountResponse {
-  count: <>
+  count: number
   _shards: <>
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-create.asciidoc b/docs/reference-create.asciidoc index 44184a497..62391a732 100644 --- a/docs/reference-create.asciidoc +++ b/docs/reference-create.asciidoc @@ -41,10 +41,12 @@ Index a document. Adds a JSON document to the specified data stream or index and ---- [discrete] -===== `CreateRequest` +==== CreateRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface CreateRequest extends <> {
   id: <>
   index: <>
@@ -57,13 +59,21 @@ interface CreateRequest extends <> {
   wait_for_active_shards?: <>
   document?: TDocument
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `CreateResponse` +==== CreateResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type CreateResponse = <>
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-dangling_indices-delete_dangling_index.asciidoc b/docs/reference-dangling_indices-delete_dangling_index.asciidoc index 6e93d9105..a8b5d8c01 100644 --- a/docs/reference-dangling_indices-delete_dangling_index.asciidoc +++ b/docs/reference-dangling_indices-delete_dangling_index.asciidoc @@ -41,23 +41,33 @@ Delete a dangling index. If Elasticsearch encounters index data that is absent f ---- [discrete] -===== `DanglingIndicesDeleteDanglingIndexRequest` +==== DanglingIndicesDeleteDanglingIndexRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface DanglingIndicesDeleteDanglingIndexRequest extends <> {
   index_uuid: <>
   accept_data_loss: boolean
   master_timeout?: <>
   timeout?: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `DanglingIndicesDeleteDanglingIndexResponse` +==== DanglingIndicesDeleteDanglingIndexResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type DanglingIndicesDeleteDanglingIndexResponse = <>
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-dangling_indices-import_dangling_index.asciidoc b/docs/reference-dangling_indices-import_dangling_index.asciidoc index 4a1d0cf6c..7105559af 100644 --- a/docs/reference-dangling_indices-import_dangling_index.asciidoc +++ b/docs/reference-dangling_indices-import_dangling_index.asciidoc @@ -41,23 +41,33 @@ Import a dangling index. If Elasticsearch encounters index data that is absent f ---- [discrete] -===== `DanglingIndicesImportDanglingIndexRequest` +==== DanglingIndicesImportDanglingIndexRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface DanglingIndicesImportDanglingIndexRequest extends <> {
   index_uuid: <>
   accept_data_loss: boolean
   master_timeout?: <>
   timeout?: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `DanglingIndicesImportDanglingIndexResponse` +==== DanglingIndicesImportDanglingIndexResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type DanglingIndicesImportDanglingIndexResponse = <>
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-dangling_indices-list_dangling_indices.asciidoc b/docs/reference-dangling_indices-list_dangling_indices.asciidoc index b9438f60b..cd1a58a0e 100644 --- a/docs/reference-dangling_indices-list_dangling_indices.asciidoc +++ b/docs/reference-dangling_indices-list_dangling_indices.asciidoc @@ -41,21 +41,31 @@ Get the dangling indices. If Elasticsearch encounters index data that is absent ---- [discrete] -===== `DanglingIndicesListDanglingIndicesRequest` +==== DanglingIndicesListDanglingIndicesRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface DanglingIndicesListDanglingIndicesRequest extends <> {
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `DanglingIndicesListDanglingIndicesResponse` +==== DanglingIndicesListDanglingIndicesResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface DanglingIndicesListDanglingIndicesResponse {
   dangling_indices: DanglingIndicesListDanglingIndicesDanglingIndex[]
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-delete.asciidoc b/docs/reference-delete.asciidoc index 04210c15f..11f09d53a 100644 --- a/docs/reference-delete.asciidoc +++ b/docs/reference-delete.asciidoc @@ -41,14 +41,16 @@ Delete a document. Removes a JSON document from the specified index. ---- [discrete] -===== `DeleteRequest` +==== DeleteRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface DeleteRequest extends <> {
   id: <>
   index: <>
-  if_primary_term?: <>
+  if_primary_term?: number
   if_seq_no?: <>
   refresh?: <>
   routing?: <>
@@ -57,13 +59,21 @@ interface DeleteRequest extends <> {
   version_type?: <>
   wait_for_active_shards?: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `DeleteResponse` +==== DeleteResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type DeleteResponse = <>
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-delete_by_query.asciidoc b/docs/reference-delete_by_query.asciidoc index f73d3e4c6..36a8c816d 100644 --- a/docs/reference-delete_by_query.asciidoc +++ b/docs/reference-delete_by_query.asciidoc @@ -41,10 +41,12 @@ Delete documents. Deletes documents that match the specified query. ---- [discrete] -===== `DeleteByQueryRequest` +==== DeleteByQueryRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface DeleteByQueryRequest extends <> {
   index: <>
   allow_no_indices?: boolean
@@ -54,46 +56,51 @@ interface DeleteByQueryRequest extends <> {
   default_operator?: QueryDslOperator
   df?: string
   expand_wildcards?: <>
-  from?: <>
+  from?: number
   ignore_unavailable?: boolean
   lenient?: boolean
   preference?: string
   refresh?: boolean
   request_cache?: boolean
-  requests_per_second?: <>
+  requests_per_second?: number
   routing?: <>
   q?: string
   scroll?: <>
-  scroll_size?: <>
+  scroll_size?: number
   search_timeout?: <>
   search_type?: <>
   slices?: <>
   sort?: string[]
   stats?: string[]
-  terminate_after?: <>
+  terminate_after?: number
   timeout?: <>
   version?: boolean
   wait_for_active_shards?: <>
   wait_for_completion?: boolean
-  max_docs?: <>
+  max_docs?: number
   query?: QueryDslQueryContainer
   slice?: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `DeleteByQueryResponse` +==== DeleteByQueryResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface DeleteByQueryResponse {
-  batches?: <>
-  deleted?: <>
+  batches?: number
+  deleted?: number
   failures?: <>[]
-  noops?: <>
-  requests_per_second?: <>
+  noops?: number
+  requests_per_second?: number
   retries?: <>
-  slice_id?: <>
+  slice_id?: number
   task?: <>
   throttled?: <>
   throttled_millis?: <><<>>
@@ -101,8 +108,11 @@ interface DeleteByQueryResponse {
   throttled_until_millis?: <><<>>
   timed_out?: boolean
   took?: <><<>>
-  total?: <>
-  version_conflicts?: <>
+  total?: number
+  version_conflicts?: number
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-delete_by_query_rethrottle.asciidoc b/docs/reference-delete_by_query_rethrottle.asciidoc index 199af459c..760171bce 100644 --- a/docs/reference-delete_by_query_rethrottle.asciidoc +++ b/docs/reference-delete_by_query_rethrottle.asciidoc @@ -41,21 +41,31 @@ Throttle a delete by query operation. Change the number of requests per second f ---- [discrete] -===== `DeleteByQueryRethrottleRequest` +==== DeleteByQueryRethrottleRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface DeleteByQueryRethrottleRequest extends <> {
   task_id: <>
-  requests_per_second?: <>
+  requests_per_second?: number
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `DeleteByQueryRethrottleResponse` +==== DeleteByQueryRethrottleResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type DeleteByQueryRethrottleResponse = TasksTaskListResponseBase
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-delete_script.asciidoc b/docs/reference-delete_script.asciidoc index a1ee7107c..402b0a667 100644 --- a/docs/reference-delete_script.asciidoc +++ b/docs/reference-delete_script.asciidoc @@ -41,22 +41,32 @@ Delete a script or search template. Deletes a stored script or search template. ---- [discrete] -===== `DeleteScriptRequest` +==== DeleteScriptRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface DeleteScriptRequest extends <> {
   id: <>
   master_timeout?: <>
   timeout?: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `DeleteScriptResponse` +==== DeleteScriptResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type DeleteScriptResponse = <>
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-enrich-delete_policy.asciidoc b/docs/reference-enrich-delete_policy.asciidoc index 61741e442..a98722020 100644 --- a/docs/reference-enrich-delete_policy.asciidoc +++ b/docs/reference-enrich-delete_policy.asciidoc @@ -41,20 +41,30 @@ Delete an enrich policy. Deletes an existing enrich policy and its enrich index. ---- [discrete] -===== `EnrichDeletePolicyRequest` +==== EnrichDeletePolicyRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface EnrichDeletePolicyRequest extends <> {
   name: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `EnrichDeletePolicyResponse` +==== EnrichDeletePolicyResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type EnrichDeletePolicyResponse = <>
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-enrich-execute_policy.asciidoc b/docs/reference-enrich-execute_policy.asciidoc index 1d0756d0f..e57c982d4 100644 --- a/docs/reference-enrich-execute_policy.asciidoc +++ b/docs/reference-enrich-execute_policy.asciidoc @@ -41,24 +41,34 @@ Creates the enrich index for an existing enrich policy. ---- [discrete] -===== `EnrichExecutePolicyRequest` +==== EnrichExecutePolicyRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface EnrichExecutePolicyRequest extends <> {
   name: <>
   wait_for_completion?: boolean
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `EnrichExecutePolicyResponse` +==== EnrichExecutePolicyResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface EnrichExecutePolicyResponse {
   status?: EnrichExecutePolicyExecuteEnrichPolicyStatus
   task_id?: <>
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-enrich-get_policy.asciidoc b/docs/reference-enrich-get_policy.asciidoc index 9faa027ca..fdee0179f 100644 --- a/docs/reference-enrich-get_policy.asciidoc +++ b/docs/reference-enrich-get_policy.asciidoc @@ -41,22 +41,32 @@ Get an enrich policy. Returns information about an enrich policy. ---- [discrete] -===== `EnrichGetPolicyRequest` +==== EnrichGetPolicyRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface EnrichGetPolicyRequest extends <> {
   name?: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `EnrichGetPolicyResponse` +==== EnrichGetPolicyResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface EnrichGetPolicyResponse {
   policies: EnrichSummary[]
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-enrich-put_policy.asciidoc b/docs/reference-enrich-put_policy.asciidoc index 57aba40f9..85d142f23 100644 --- a/docs/reference-enrich-put_policy.asciidoc +++ b/docs/reference-enrich-put_policy.asciidoc @@ -41,23 +41,33 @@ Create an enrich policy. Creates an enrich policy. ---- [discrete] -===== `EnrichPutPolicyRequest` +==== EnrichPutPolicyRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface EnrichPutPolicyRequest extends <> {
   name: <>
   geo_match?: EnrichPolicy
   match?: EnrichPolicy
   range?: EnrichPolicy
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `EnrichPutPolicyResponse` +==== EnrichPutPolicyResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type EnrichPutPolicyResponse = <>
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-enrich-stats.asciidoc b/docs/reference-enrich-stats.asciidoc index d5c5cbc8c..803c9dfee 100644 --- a/docs/reference-enrich-stats.asciidoc +++ b/docs/reference-enrich-stats.asciidoc @@ -41,23 +41,33 @@ Get enrich stats. Returns enrich coordinator statistics and information about en ---- [discrete] -===== `EnrichStatsRequest` +==== EnrichStatsRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface EnrichStatsRequest extends <> {
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `EnrichStatsResponse` +==== EnrichStatsResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface EnrichStatsResponse {
   coordinator_stats: EnrichStatsCoordinatorStats[]
   executing_policies: EnrichStatsExecutingPolicy[]
   cache_stats?: EnrichStatsCacheStats[]
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-eql-delete.asciidoc b/docs/reference-eql-delete.asciidoc index 1bda4bbed..3c1d22be3 100644 --- a/docs/reference-eql-delete.asciidoc +++ b/docs/reference-eql-delete.asciidoc @@ -41,20 +41,30 @@ Deletes an async EQL search or a stored synchronous EQL search. The API also del ---- [discrete] -===== `EqlDeleteRequest` +==== EqlDeleteRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface EqlDeleteRequest extends <> {
   id: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `EqlDeleteResponse` +==== EqlDeleteResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type EqlDeleteResponse = <>
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-eql-get.asciidoc b/docs/reference-eql-get.asciidoc index 81566c4d9..584a1399e 100644 --- a/docs/reference-eql-get.asciidoc +++ b/docs/reference-eql-get.asciidoc @@ -41,22 +41,32 @@ Returns the current status and available results for an async EQL search or a st ---- [discrete] -===== `EqlGetRequest` +==== EqlGetRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface EqlGetRequest extends <> {
   id: <>
   keep_alive?: <>
   wait_for_completion_timeout?: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `EqlGetResponse` +==== EqlGetResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type EqlGetResponse = EqlEqlSearchResponseBase
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-eql-get_status.asciidoc b/docs/reference-eql-get_status.asciidoc index 95c35e105..e51ebd506 100644 --- a/docs/reference-eql-get_status.asciidoc +++ b/docs/reference-eql-get_status.asciidoc @@ -41,27 +41,37 @@ Returns the current status for an async EQL search or a stored synchronous EQL s ---- [discrete] -===== `EqlGetStatusRequest` +==== EqlGetStatusRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface EqlGetStatusRequest extends <> {
   id: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `EqlGetStatusResponse` +==== EqlGetStatusResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface EqlGetStatusResponse {
   id: <>
   is_partial: boolean
   is_running: boolean
   start_time_in_millis?: <><<>>
   expiration_time_in_millis?: <><<>>
-  completion_status?: <>
+  completion_status?: number
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-eql-search.asciidoc b/docs/reference-eql-search.asciidoc index 2491ebcd2..ebe52c53d 100644 --- a/docs/reference-eql-search.asciidoc +++ b/docs/reference-eql-search.asciidoc @@ -41,10 +41,12 @@ Returns results matching a query expressed in Event Query Language (EQL) ---- [discrete] -===== `EqlSearchRequest` +==== EqlSearchRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface EqlSearchRequest extends <> {
   index: <>
   allow_no_indices?: boolean
@@ -55,23 +57,31 @@ interface EqlSearchRequest extends <> {
   event_category_field?: <>
   tiebreaker_field?: <>
   timestamp_field?: <>
-  fetch_size?: <>
+  fetch_size?: number
   filter?: QueryDslQueryContainer | QueryDslQueryContainer[]
   keep_alive?: <>
   keep_on_completion?: boolean
   wait_for_completion_timeout?: <>
-  size?: <>
+  size?: number
   fields?: QueryDslFieldAndFormat | <> | (QueryDslFieldAndFormat | <>)[]
   result_position?: EqlSearchResultPosition
   runtime_mappings?: MappingRuntimeFields
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `EqlSearchResponse` +==== EqlSearchResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type EqlSearchResponse = EqlEqlSearchResponseBase
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-esql-async_query.asciidoc b/docs/reference-esql-async_query.asciidoc index 0cc9bcb65..46b545f08 100644 --- a/docs/reference-esql-async_query.asciidoc +++ b/docs/reference-esql-async_query.asciidoc @@ -40,20 +40,3 @@ Executes an ESQL request asynchronously (EsqlAsyncQueryRequest, options?): Promise ---- -[discrete] -===== `EsqlAsyncQueryRequest` - -[source,ts] ----- -{ -} ----- - -[discrete] -===== `EsqlAsyncQueryResponse` - -[source,ts] ----- -n/a ----- - diff --git a/docs/reference-esql-async_query_get.asciidoc b/docs/reference-esql-async_query_get.asciidoc index ffd187289..f82ac29db 100644 --- a/docs/reference-esql-async_query_get.asciidoc +++ b/docs/reference-esql-async_query_get.asciidoc @@ -40,20 +40,3 @@ Retrieves the results of a previously submitted async query request given its ID (EsqlAsyncQueryGetRequest, options?): Promise ---- -[discrete] -===== `EsqlAsyncQueryGetRequest` - -[source,ts] ----- -{ -} ----- - -[discrete] -===== `EsqlAsyncQueryGetResponse` - -[source,ts] ----- -n/a ----- - diff --git a/docs/reference-esql-query.asciidoc b/docs/reference-esql-query.asciidoc index b0829d0e8..d4ba970ea 100644 --- a/docs/reference-esql-query.asciidoc +++ b/docs/reference-esql-query.asciidoc @@ -41,10 +41,12 @@ Executes an ES|QL request ---- [discrete] -===== `EsqlQueryRequest` +==== EsqlQueryRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface EsqlQueryRequest extends <> {
   format?: EsqlQueryEsqlFormat
   delimiter?: string
@@ -57,13 +59,21 @@ interface EsqlQueryRequest extends <> {
   query: string
   tables?: Record>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `EsqlQueryResponse` +==== EsqlQueryResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type EsqlQueryResponse = <>
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-exists.asciidoc b/docs/reference-exists.asciidoc index 36722d62f..3a417be5e 100644 --- a/docs/reference-exists.asciidoc +++ b/docs/reference-exists.asciidoc @@ -41,10 +41,12 @@ Check a document. Checks if a specified document exists. ---- [discrete] -===== `ExistsRequest` +==== ExistsRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface ExistsRequest extends <> {
   id: <>
   index: <>
@@ -59,13 +61,21 @@ interface ExistsRequest extends <> {
   version?: <>
   version_type?: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `ExistsResponse` +==== ExistsResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type ExistsResponse = boolean
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-exists_source.asciidoc b/docs/reference-exists_source.asciidoc index 3baa64d45..7285ff38f 100644 --- a/docs/reference-exists_source.asciidoc +++ b/docs/reference-exists_source.asciidoc @@ -41,10 +41,12 @@ Check for a document source. Checks if a document's `_source` is stored. ---- [discrete] -===== `ExistsSourceRequest` +==== ExistsSourceRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface ExistsSourceRequest extends <> {
   id: <>
   index: <>
@@ -58,13 +60,21 @@ interface ExistsSourceRequest extends <> {
   version?: <>
   version_type?: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `ExistsSourceResponse` +==== ExistsSourceResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type ExistsSourceResponse = boolean
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-explain.asciidoc b/docs/reference-explain.asciidoc index 07c01ba5c..193e9040c 100644 --- a/docs/reference-explain.asciidoc +++ b/docs/reference-explain.asciidoc @@ -41,10 +41,12 @@ Explain a document match result. Returns information about why a specific docume ---- [discrete] -===== `ExplainRequest` +==== ExplainRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface ExplainRequest extends <> {
   id: <>
   index: <>
@@ -62,13 +64,18 @@ interface ExplainRequest extends <> {
   q?: string
   query?: QueryDslQueryContainer
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `ExplainResponse` +==== ExplainResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface ExplainResponse {
   _index: <>
   _id: <>
@@ -76,5 +83,8 @@ interface ExplainResponse {
   explanation?: ExplainExplanationDetail
   get?: <>
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-features-get_features.asciidoc b/docs/reference-features-get_features.asciidoc index 30f1d3b60..1a691eb94 100644 --- a/docs/reference-features-get_features.asciidoc +++ b/docs/reference-features-get_features.asciidoc @@ -41,21 +41,31 @@ Gets a list of features which can be included in snapshots using the feature_sta ---- [discrete] -===== `FeaturesGetFeaturesRequest` +==== FeaturesGetFeaturesRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface FeaturesGetFeaturesRequest extends <> {
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `FeaturesGetFeaturesResponse` +==== FeaturesGetFeaturesResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface FeaturesGetFeaturesResponse {
   features: FeaturesFeature[]
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-features-reset_features.asciidoc b/docs/reference-features-reset_features.asciidoc index 584b9d913..cd7cf499a 100644 --- a/docs/reference-features-reset_features.asciidoc +++ b/docs/reference-features-reset_features.asciidoc @@ -41,21 +41,31 @@ Resets the internal state of features, usually by deleting system indices ---- [discrete] -===== `FeaturesResetFeaturesRequest` +==== FeaturesResetFeaturesRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface FeaturesResetFeaturesRequest extends <> {
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `FeaturesResetFeaturesResponse` +==== FeaturesResetFeaturesResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface FeaturesResetFeaturesResponse {
   features: FeaturesFeature[]
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-field_caps.asciidoc b/docs/reference-field_caps.asciidoc index 3a39fb613..6e354c51c 100644 --- a/docs/reference-field_caps.asciidoc +++ b/docs/reference-field_caps.asciidoc @@ -41,10 +41,12 @@ Get the field capabilities. Get information about the capabilities of fields amo ---- [discrete] -===== `FieldCapsRequest` +==== FieldCapsRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface FieldCapsRequest extends <> {
   index?: <>
   allow_no_indices?: boolean
@@ -58,16 +60,24 @@ interface FieldCapsRequest extends <> {
   index_filter?: QueryDslQueryContainer
   runtime_mappings?: MappingRuntimeFields
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `FieldCapsResponse` +==== FieldCapsResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface FieldCapsResponse {
   indices: <>
   fields: Record<<>, Record>
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-fleet-global_checkpoints.asciidoc b/docs/reference-fleet-global_checkpoints.asciidoc index 2f32e348e..3b8e1e6ca 100644 --- a/docs/reference-fleet-global_checkpoints.asciidoc +++ b/docs/reference-fleet-global_checkpoints.asciidoc @@ -41,10 +41,12 @@ Returns the current global checkpoints for an index. This API is design for inte ---- [discrete] -===== `FleetGlobalCheckpointsRequest` +==== FleetGlobalCheckpointsRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface FleetGlobalCheckpointsRequest extends <> {
   index: <> | <>
   wait_for_advance?: boolean
@@ -52,16 +54,24 @@ interface FleetGlobalCheckpointsRequest extends <> {
   checkpoints?: FleetCheckpoint[]
   timeout?: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `FleetGlobalCheckpointsResponse` +==== FleetGlobalCheckpointsResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface FleetGlobalCheckpointsResponse {
   global_checkpoints: FleetCheckpoint[]
   timed_out: boolean
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-fleet-msearch.asciidoc b/docs/reference-fleet-msearch.asciidoc index 467986729..681c360e2 100644 --- a/docs/reference-fleet-msearch.asciidoc +++ b/docs/reference-fleet-msearch.asciidoc @@ -39,10 +39,12 @@ Executes several [fleet searches](https://www.elastic.co/guide/en/elasticsearch/ ---- [discrete] -===== `FleetMsearchRequest` +==== FleetMsearchRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface FleetMsearchRequest extends <> {
   index?: <> | <>
   allow_no_indices?: boolean
@@ -50,9 +52,9 @@ interface FleetMsearchRequest extends <> {
   expand_wildcards?: <>
   ignore_throttled?: boolean
   ignore_unavailable?: boolean
-  max_concurrent_searches?: <>
-  max_concurrent_shard_requests?: <>
-  pre_filter_shard_size?: <>
+  max_concurrent_searches?: number
+  max_concurrent_shard_requests?: number
+  pre_filter_shard_size?: number
   search_type?: <>
   rest_total_hits_as_int?: boolean
   typed_keys?: boolean
@@ -60,15 +62,23 @@ interface FleetMsearchRequest extends <> {
   allow_partial_search_results?: boolean
   searches?: MsearchRequestItem[]
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `FleetMsearchResponse` +==== FleetMsearchResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface FleetMsearchResponse {
   docs: MsearchResponseItem[]
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-fleet-search.asciidoc b/docs/reference-fleet-search.asciidoc index 57f038d7e..590941668 100644 --- a/docs/reference-fleet-search.asciidoc +++ b/docs/reference-fleet-search.asciidoc @@ -39,16 +39,18 @@ The purpose of the fleet search api is to provide a search api where the search ---- [discrete] -===== `FleetSearchRequest` +==== FleetSearchRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface FleetSearchRequest extends <> {
   index: <> | <>
   allow_no_indices?: boolean
   analyzer?: string
   analyze_wildcard?: boolean
-  batched_reduce_size?: <>
+  batched_reduce_size?: number
   ccs_minimize_roundtrips?: boolean
   default_operator?: QueryDslOperator
   df?: string
@@ -56,17 +58,17 @@ interface FleetSearchRequest extends <> {
   ignore_throttled?: boolean
   ignore_unavailable?: boolean
   lenient?: boolean
-  max_concurrent_shard_requests?: <>
+  max_concurrent_shard_requests?: number
   min_compatible_shard_node?: <>
   preference?: string
-  pre_filter_shard_size?: <>
+  pre_filter_shard_size?: number
   request_cache?: boolean
   routing?: <>
   scroll?: <>
   search_type?: <>
   suggest_field?: <>
   suggest_mode?: <>
-  suggest_size?: <>
+  suggest_size?: number
   suggest_text?: string
   typed_keys?: boolean
   rest_total_hits_as_int?: boolean
@@ -81,25 +83,25 @@ interface FleetSearchRequest extends <> {
   collapse?: SearchFieldCollapse
   explain?: boolean
   ext?: Record
-  from?: <>
+  from?: number
   highlight?: SearchHighlight
   track_total_hits?: SearchTrackHits
-  indices_boost?: Record<<>, <>>[]
+  indices_boost?: Record<<>, number>[]
   docvalue_fields?: (QueryDslFieldAndFormat | <>)[]
-  min_score?: <>
+  min_score?: number
   post_filter?: QueryDslQueryContainer
   profile?: boolean
   query?: QueryDslQueryContainer
   rescore?: SearchRescore | SearchRescore[]
   script_fields?: Record>>
   search_after?: <>
-  size?: <>
+  size?: number
   slice?: <>
   sort?: <>
   _source?: SearchSourceConfig
   fields?: (QueryDslFieldAndFormat | <>)[]
   suggest?: SearchSuggester
-  terminate_after?: <>
+  terminate_after?: number
   timeout?: string
   track_scores?: boolean
   version?: boolean
@@ -109,28 +111,36 @@ interface FleetSearchRequest extends <> {
   runtime_mappings?: MappingRuntimeFields
   stats?: string[]
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `FleetSearchResponse` +==== FleetSearchResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface FleetSearchResponse {
-  took: <>
+  took: number
   timed_out: boolean
   _shards: <>
   hits: SearchHitsMetadata
   aggregations?: Record<<>, AggregationsAggregate>
   _clusters?: <>
   fields?: Record
-  max_score?: <>
-  num_reduce_phases?: <>
+  max_score?: number
+  num_reduce_phases?: number
   profile?: SearchProfile
   pit_id?: <>
   _scroll_id?: <>
   suggest?: Record<<>, SearchSuggest[]>
   terminated_early?: boolean
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-get.asciidoc b/docs/reference-get.asciidoc index 813abe1e0..46bff523c 100644 --- a/docs/reference-get.asciidoc +++ b/docs/reference-get.asciidoc @@ -41,10 +41,12 @@ Get a document by its ID. Retrieves the document with the specified ID from an i ---- [discrete] -===== `GetRequest` +==== GetRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface GetRequest extends <> {
   id: <>
   index: <>
@@ -60,13 +62,21 @@ interface GetRequest extends <> {
   version?: <>
   version_type?: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `GetResponse` +==== GetResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type GetResponse = GetGetResult
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-get_script.asciidoc b/docs/reference-get_script.asciidoc index b056d6fc4..8315d2486 100644 --- a/docs/reference-get_script.asciidoc +++ b/docs/reference-get_script.asciidoc @@ -41,25 +41,35 @@ Get a script or search template. Retrieves a stored script or search template. ---- [discrete] -===== `GetScriptRequest` +==== GetScriptRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface GetScriptRequest extends <> {
   id: <>
   master_timeout?: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `GetScriptResponse` +==== GetScriptResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface GetScriptResponse {
   _id: <>
   found: boolean
   script?: <>
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-get_script_context.asciidoc b/docs/reference-get_script_context.asciidoc index b1a0f567f..2893cda04 100644 --- a/docs/reference-get_script_context.asciidoc +++ b/docs/reference-get_script_context.asciidoc @@ -41,21 +41,31 @@ Get script contexts. Get a list of supported script contexts and their methods. ---- [discrete] -===== `GetScriptContextRequest` +==== GetScriptContextRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface GetScriptContextRequest extends <> {
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `GetScriptContextResponse` +==== GetScriptContextResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface GetScriptContextResponse {
   contexts: GetScriptContextContext[]
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-get_script_languages.asciidoc b/docs/reference-get_script_languages.asciidoc index c80a7b88f..e3743e586 100644 --- a/docs/reference-get_script_languages.asciidoc +++ b/docs/reference-get_script_languages.asciidoc @@ -41,22 +41,32 @@ Get script languages. Get a list of available script types, languages, and conte ---- [discrete] -===== `GetScriptLanguagesRequest` +==== GetScriptLanguagesRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface GetScriptLanguagesRequest extends <> {
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `GetScriptLanguagesResponse` +==== GetScriptLanguagesResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface GetScriptLanguagesResponse {
   language_contexts: GetScriptLanguagesLanguageContext[]
   types_allowed: string[]
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-get_source.asciidoc b/docs/reference-get_source.asciidoc index 43a3d3e1e..37e2278b2 100644 --- a/docs/reference-get_source.asciidoc +++ b/docs/reference-get_source.asciidoc @@ -41,10 +41,12 @@ Get a document's source. Returns the source of a document. ---- [discrete] -===== `GetSourceRequest` +==== GetSourceRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface GetSourceRequest extends <> {
   id: <>
   index: <>
@@ -59,13 +61,21 @@ interface GetSourceRequest extends <> {
   version?: <>
   version_type?: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `GetSourceResponse` +==== GetSourceResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type GetSourceResponse = TDocument
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-graph-explore.asciidoc b/docs/reference-graph-explore.asciidoc index 2c3f70a24..f9d68c519 100644 --- a/docs/reference-graph-explore.asciidoc +++ b/docs/reference-graph-explore.asciidoc @@ -41,10 +41,12 @@ Extracts and summarizes information about the documents and terms in an Elastics ---- [discrete] -===== `GraphExploreRequest` +==== GraphExploreRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface GraphExploreRequest extends <> {
   index: <>
   routing?: <>
@@ -54,19 +56,27 @@ interface GraphExploreRequest extends <> {
   query?: QueryDslQueryContainer
   vertices?: GraphVertexDefinition[]
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `GraphExploreResponse` +==== GraphExploreResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface GraphExploreResponse {
   connections: GraphConnection[]
   failures: <>[]
   timed_out: boolean
-  took: <>
+  took: number
   vertices: GraphVertex[]
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-health_report.asciidoc b/docs/reference-health_report.asciidoc index e921e030d..29873dd48 100644 --- a/docs/reference-health_report.asciidoc +++ b/docs/reference-health_report.asciidoc @@ -41,27 +41,37 @@ Returns the health of the cluster. ---- [discrete] -===== `HealthReportRequest` +==== HealthReportRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface HealthReportRequest extends <> {
   feature?: string | string[]
   timeout?: <>
   verbose?: boolean
-  size?: <>
+  size?: number
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `HealthReportResponse` +==== HealthReportResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface HealthReportResponse {
   cluster_name: string
   indicators: HealthReportIndicators
   status?: HealthReportIndicatorHealthStatus
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-ilm-delete_lifecycle.asciidoc b/docs/reference-ilm-delete_lifecycle.asciidoc index 6b34af6df..adc2f66e9 100644 --- a/docs/reference-ilm-delete_lifecycle.asciidoc +++ b/docs/reference-ilm-delete_lifecycle.asciidoc @@ -41,22 +41,32 @@ Deletes the specified lifecycle policy definition. You cannot delete policies th ---- [discrete] -===== `IlmDeleteLifecycleRequest` +==== IlmDeleteLifecycleRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface IlmDeleteLifecycleRequest extends <> {
   name: <>
   master_timeout?: <>
   timeout?: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `IlmDeleteLifecycleResponse` +==== IlmDeleteLifecycleResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type IlmDeleteLifecycleResponse = <>
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-ilm-explain_lifecycle.asciidoc b/docs/reference-ilm-explain_lifecycle.asciidoc index 63820af98..5c1cb3dec 100644 --- a/docs/reference-ilm-explain_lifecycle.asciidoc +++ b/docs/reference-ilm-explain_lifecycle.asciidoc @@ -41,10 +41,12 @@ Retrieves information about the index’s current lifecycle state, such as the c ---- [discrete] -===== `IlmExplainLifecycleRequest` +==== IlmExplainLifecycleRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface IlmExplainLifecycleRequest extends <> {
   index: <>
   only_errors?: boolean
@@ -52,15 +54,23 @@ interface IlmExplainLifecycleRequest extends <> {
   master_timeout?: <>
   timeout?: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `IlmExplainLifecycleResponse` +==== IlmExplainLifecycleResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface IlmExplainLifecycleResponse {
   indices: Record<<>, IlmExplainLifecycleLifecycleExplain>
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-ilm-get_lifecycle.asciidoc b/docs/reference-ilm-get_lifecycle.asciidoc index 9e5df441e..eb03b8254 100644 --- a/docs/reference-ilm-get_lifecycle.asciidoc +++ b/docs/reference-ilm-get_lifecycle.asciidoc @@ -41,22 +41,32 @@ Retrieves a lifecycle policy. ---- [discrete] -===== `IlmGetLifecycleRequest` +==== IlmGetLifecycleRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface IlmGetLifecycleRequest extends <> {
   name?: <>
   master_timeout?: <>
   timeout?: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `IlmGetLifecycleResponse` +==== IlmGetLifecycleResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type IlmGetLifecycleResponse = Record
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-ilm-get_status.asciidoc b/docs/reference-ilm-get_status.asciidoc index d60817f81..e5abfa74a 100644 --- a/docs/reference-ilm-get_status.asciidoc +++ b/docs/reference-ilm-get_status.asciidoc @@ -41,21 +41,31 @@ Retrieves the current index lifecycle management (ILM) status. ---- [discrete] -===== `IlmGetStatusRequest` +==== IlmGetStatusRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface IlmGetStatusRequest extends <> {
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `IlmGetStatusResponse` +==== IlmGetStatusResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface IlmGetStatusResponse {
   operation_mode: <>
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-ilm-migrate_to_data_tiers.asciidoc b/docs/reference-ilm-migrate_to_data_tiers.asciidoc index 4e9a52ace..86247c8f8 100644 --- a/docs/reference-ilm-migrate_to_data_tiers.asciidoc +++ b/docs/reference-ilm-migrate_to_data_tiers.asciidoc @@ -41,22 +41,29 @@ Switches the indices, ILM policies, and legacy, composable and component templat ---- [discrete] -===== `IlmMigrateToDataTiersRequest` +==== IlmMigrateToDataTiersRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface IlmMigrateToDataTiersRequest extends <> {
   dry_run?: boolean
   legacy_template_to_delete?: string
   node_attribute?: string
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `IlmMigrateToDataTiersResponse` +==== IlmMigrateToDataTiersResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface IlmMigrateToDataTiersResponse {
   dry_run: boolean
   removed_legacy_template: string
@@ -66,5 +73,8 @@ interface IlmMigrateToDataTiersResponse {
   migrated_composable_templates: string[]
   migrated_component_templates: string[]
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-ilm-move_to_step.asciidoc b/docs/reference-ilm-move_to_step.asciidoc index 497862306..354554711 100644 --- a/docs/reference-ilm-move_to_step.asciidoc +++ b/docs/reference-ilm-move_to_step.asciidoc @@ -41,22 +41,32 @@ Manually moves an index into the specified step and executes that step. ---- [discrete] -===== `IlmMoveToStepRequest` +==== IlmMoveToStepRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface IlmMoveToStepRequest extends <> {
   index: <>
   current_step: IlmMoveToStepStepKey
   next_step: IlmMoveToStepStepKey
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `IlmMoveToStepResponse` +==== IlmMoveToStepResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type IlmMoveToStepResponse = <>
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-ilm-put_lifecycle.asciidoc b/docs/reference-ilm-put_lifecycle.asciidoc index 1fe6b584b..393afdb8f 100644 --- a/docs/reference-ilm-put_lifecycle.asciidoc +++ b/docs/reference-ilm-put_lifecycle.asciidoc @@ -41,23 +41,33 @@ Creates a lifecycle policy. If the specified policy exists, the policy is replac ---- [discrete] -===== `IlmPutLifecycleRequest` +==== IlmPutLifecycleRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface IlmPutLifecycleRequest extends <> {
   name: <>
   master_timeout?: <>
   timeout?: <>
   policy?: IlmPolicy
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `IlmPutLifecycleResponse` +==== IlmPutLifecycleResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type IlmPutLifecycleResponse = <>
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-ilm-remove_policy.asciidoc b/docs/reference-ilm-remove_policy.asciidoc index 961ac5ead..982809242 100644 --- a/docs/reference-ilm-remove_policy.asciidoc +++ b/docs/reference-ilm-remove_policy.asciidoc @@ -41,23 +41,33 @@ Removes the assigned lifecycle policy and stops managing the specified index ---- [discrete] -===== `IlmRemovePolicyRequest` +==== IlmRemovePolicyRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface IlmRemovePolicyRequest extends <> {
   index: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `IlmRemovePolicyResponse` +==== IlmRemovePolicyResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface IlmRemovePolicyResponse {
   failed_indexes: <>[]
   has_failures: boolean
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-ilm-retry.asciidoc b/docs/reference-ilm-retry.asciidoc index 1da83eff7..f3264ebf8 100644 --- a/docs/reference-ilm-retry.asciidoc +++ b/docs/reference-ilm-retry.asciidoc @@ -41,20 +41,30 @@ Retries executing the policy for an index that is in the ERROR step. ---- [discrete] -===== `IlmRetryRequest` +==== IlmRetryRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface IlmRetryRequest extends <> {
   index: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `IlmRetryResponse` +==== IlmRetryResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type IlmRetryResponse = <>
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-ilm-start.asciidoc b/docs/reference-ilm-start.asciidoc index 6ad667696..5ee249276 100644 --- a/docs/reference-ilm-start.asciidoc +++ b/docs/reference-ilm-start.asciidoc @@ -41,21 +41,31 @@ Start the index lifecycle management (ILM) plugin. ---- [discrete] -===== `IlmStartRequest` +==== IlmStartRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface IlmStartRequest extends <> {
   master_timeout?: <>
   timeout?: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `IlmStartResponse` +==== IlmStartResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type IlmStartResponse = <>
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-ilm-stop.asciidoc b/docs/reference-ilm-stop.asciidoc index 64f08b814..68b1fd149 100644 --- a/docs/reference-ilm-stop.asciidoc +++ b/docs/reference-ilm-stop.asciidoc @@ -41,21 +41,31 @@ Halts all lifecycle management operations and stops the index lifecycle manageme ---- [discrete] -===== `IlmStopRequest` +==== IlmStopRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface IlmStopRequest extends <> {
   master_timeout?: <>
   timeout?: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `IlmStopResponse` +==== IlmStopResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type IlmStopResponse = <>
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-index.asciidoc b/docs/reference-index.asciidoc index ec1810121..cfce952f5 100644 --- a/docs/reference-index.asciidoc +++ b/docs/reference-index.asciidoc @@ -41,14 +41,16 @@ Index a document. Adds a JSON document to the specified data stream or index and ---- [discrete] -===== `IndexRequest` +==== IndexRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface IndexRequest extends <> {
   id?: <>
   index: <>
-  if_primary_term?: <>
+  if_primary_term?: number
   if_seq_no?: <>
   op_type?: <>
   pipeline?: string
@@ -61,13 +63,21 @@ interface IndexRequest extends <> {
   require_alias?: boolean
   document?: TDocument
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `IndexResponse` +==== IndexResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type IndexResponse = <>
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-indices-add_block.asciidoc b/docs/reference-indices-add_block.asciidoc index 866d4bb7a..046865087 100644 --- a/docs/reference-indices-add_block.asciidoc +++ b/docs/reference-indices-add_block.asciidoc @@ -41,10 +41,12 @@ Add an index block. Limits the operations allowed on an index by blocking specif ---- [discrete] -===== `IndicesAddBlockRequest` +==== IndicesAddBlockRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface IndicesAddBlockRequest extends <> {
   index: <>
   block: IndicesAddBlockIndicesBlockOptions
@@ -54,17 +56,25 @@ interface IndicesAddBlockRequest extends <> {
   master_timeout?: <>
   timeout?: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `IndicesAddBlockResponse` +==== IndicesAddBlockResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface IndicesAddBlockResponse {
   acknowledged: boolean
   shards_acknowledged: boolean
   indices: IndicesAddBlockIndicesBlockStatus[]
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-indices-analyze.asciidoc b/docs/reference-indices-analyze.asciidoc index d8e0078be..5323b1d31 100644 --- a/docs/reference-indices-analyze.asciidoc +++ b/docs/reference-indices-analyze.asciidoc @@ -41,10 +41,12 @@ Get tokens from text analysis. The analyze API performs [analysis](https://www.e ---- [discrete] -===== `IndicesAnalyzeRequest` +==== IndicesAnalyzeRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface IndicesAnalyzeRequest extends <> {
   index?: <>
   analyzer?: string
@@ -57,16 +59,24 @@ interface IndicesAnalyzeRequest extends <> {
   text?: IndicesAnalyzeTextToAnalyze
   tokenizer?: AnalysisTokenizer
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `IndicesAnalyzeResponse` +==== IndicesAnalyzeResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface IndicesAnalyzeResponse {
   detail?: IndicesAnalyzeAnalyzeDetail
   tokens?: IndicesAnalyzeAnalyzeToken[]
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-indices-clear_cache.asciidoc b/docs/reference-indices-clear_cache.asciidoc index 9c602951d..d842a9ff2 100644 --- a/docs/reference-indices-clear_cache.asciidoc +++ b/docs/reference-indices-clear_cache.asciidoc @@ -41,10 +41,12 @@ Clears the caches of one or more indices. For data streams, the API clears the c ---- [discrete] -===== `IndicesClearCacheRequest` +==== IndicesClearCacheRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface IndicesClearCacheRequest extends <> {
   index?: <>
   allow_no_indices?: boolean
@@ -55,13 +57,21 @@ interface IndicesClearCacheRequest extends <> {
   query?: boolean
   request?: boolean
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `IndicesClearCacheResponse` +==== IndicesClearCacheResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type IndicesClearCacheResponse = <>
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-indices-clone.asciidoc b/docs/reference-indices-clone.asciidoc index ed2accd29..f07ad36a5 100644 --- a/docs/reference-indices-clone.asciidoc +++ b/docs/reference-indices-clone.asciidoc @@ -41,10 +41,12 @@ Clones an existing index. ---- [discrete] -===== `IndicesCloneRequest` +==== IndicesCloneRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface IndicesCloneRequest extends <> {
   index: <>
   target: <>
@@ -54,17 +56,25 @@ interface IndicesCloneRequest extends <> {
   aliases?: Record<<>, IndicesAlias>
   settings?: Record
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `IndicesCloneResponse` +==== IndicesCloneResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface IndicesCloneResponse {
   acknowledged: boolean
   index: <>
   shards_acknowledged: boolean
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-indices-close.asciidoc b/docs/reference-indices-close.asciidoc index 3ae85506e..d4761e42b 100644 --- a/docs/reference-indices-close.asciidoc +++ b/docs/reference-indices-close.asciidoc @@ -41,10 +41,12 @@ Closes an index. ---- [discrete] -===== `IndicesCloseRequest` +==== IndicesCloseRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface IndicesCloseRequest extends <> {
   index: <>
   allow_no_indices?: boolean
@@ -54,17 +56,25 @@ interface IndicesCloseRequest extends <> {
   timeout?: <>
   wait_for_active_shards?: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `IndicesCloseResponse` +==== IndicesCloseResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface IndicesCloseResponse {
   acknowledged: boolean
   indices: Record<<>, IndicesCloseCloseIndexResult>
   shards_acknowledged: boolean
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-indices-create.asciidoc b/docs/reference-indices-create.asciidoc index 8fdf6410e..8b848eb4f 100644 --- a/docs/reference-indices-create.asciidoc +++ b/docs/reference-indices-create.asciidoc @@ -41,10 +41,12 @@ Create an index. Creates a new index. ---- [discrete] -===== `IndicesCreateRequest` +==== IndicesCreateRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface IndicesCreateRequest extends <> {
   index: <>
   master_timeout?: <>
@@ -54,17 +56,25 @@ interface IndicesCreateRequest extends <> {
   mappings?: MappingTypeMapping
   settings?: IndicesIndexSettings
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `IndicesCreateResponse` +==== IndicesCreateResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface IndicesCreateResponse {
   index: <>
   shards_acknowledged: boolean
   acknowledged: boolean
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-indices-create_data_stream.asciidoc b/docs/reference-indices-create_data_stream.asciidoc index ead27c8d6..5aad36b7b 100644 --- a/docs/reference-indices-create_data_stream.asciidoc +++ b/docs/reference-indices-create_data_stream.asciidoc @@ -41,22 +41,32 @@ Create a data stream. Creates a data stream. You must have a matching index temp ---- [discrete] -===== `IndicesCreateDataStreamRequest` +==== IndicesCreateDataStreamRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface IndicesCreateDataStreamRequest extends <> {
   name: <>
   master_timeout?: <>
   timeout?: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `IndicesCreateDataStreamResponse` +==== IndicesCreateDataStreamResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type IndicesCreateDataStreamResponse = <>
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-indices-data_streams_stats.asciidoc b/docs/reference-indices-data_streams_stats.asciidoc index ceb73336d..f9596d435 100644 --- a/docs/reference-indices-data_streams_stats.asciidoc +++ b/docs/reference-indices-data_streams_stats.asciidoc @@ -41,28 +41,38 @@ Get data stream stats. Retrieves statistics for one or more data streams. ---- [discrete] -===== `IndicesDataStreamsStatsRequest` +==== IndicesDataStreamsStatsRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface IndicesDataStreamsStatsRequest extends <> {
   name?: <>
   expand_wildcards?: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `IndicesDataStreamsStatsResponse` +==== IndicesDataStreamsStatsResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface IndicesDataStreamsStatsResponse {
   _shards: <>
-  backing_indices: <>
-  data_stream_count: <>
+  backing_indices: number
+  data_stream_count: number
   data_streams: IndicesDataStreamsStatsDataStreamsStatsItem[]
   total_store_sizes?: <>
-  total_store_size_bytes: <>
+  total_store_size_bytes: number
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-indices-delete.asciidoc b/docs/reference-indices-delete.asciidoc index b44e8efbd..f38337ab7 100644 --- a/docs/reference-indices-delete.asciidoc +++ b/docs/reference-indices-delete.asciidoc @@ -41,10 +41,12 @@ Delete indices. Deletes one or more indices. ---- [discrete] -===== `IndicesDeleteRequest` +==== IndicesDeleteRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface IndicesDeleteRequest extends <> {
   index: <>
   allow_no_indices?: boolean
@@ -53,13 +55,21 @@ interface IndicesDeleteRequest extends <> {
   master_timeout?: <>
   timeout?: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `IndicesDeleteResponse` +==== IndicesDeleteResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type IndicesDeleteResponse = <>
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-indices-delete_alias.asciidoc b/docs/reference-indices-delete_alias.asciidoc index dbeca577c..4081ef46d 100644 --- a/docs/reference-indices-delete_alias.asciidoc +++ b/docs/reference-indices-delete_alias.asciidoc @@ -41,23 +41,33 @@ Delete an alias. Removes a data stream or index from an alias. ---- [discrete] -===== `IndicesDeleteAliasRequest` +==== IndicesDeleteAliasRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface IndicesDeleteAliasRequest extends <> {
   index: <>
   name: <>
   master_timeout?: <>
   timeout?: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `IndicesDeleteAliasResponse` +==== IndicesDeleteAliasResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type IndicesDeleteAliasResponse = <>
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-indices-delete_data_lifecycle.asciidoc b/docs/reference-indices-delete_data_lifecycle.asciidoc index e0141718d..a9f5e4dc4 100644 --- a/docs/reference-indices-delete_data_lifecycle.asciidoc +++ b/docs/reference-indices-delete_data_lifecycle.asciidoc @@ -41,23 +41,33 @@ Delete data stream lifecycles. Removes the data stream lifecycle from a data str ---- [discrete] -===== `IndicesDeleteDataLifecycleRequest` +==== IndicesDeleteDataLifecycleRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface IndicesDeleteDataLifecycleRequest extends <> {
   name: <>
   expand_wildcards?: <>
   master_timeout?: <>
   timeout?: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `IndicesDeleteDataLifecycleResponse` +==== IndicesDeleteDataLifecycleResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type IndicesDeleteDataLifecycleResponse = <>
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-indices-delete_data_stream.asciidoc b/docs/reference-indices-delete_data_stream.asciidoc index 6e48d68d4..f473b20b8 100644 --- a/docs/reference-indices-delete_data_stream.asciidoc +++ b/docs/reference-indices-delete_data_stream.asciidoc @@ -41,22 +41,32 @@ Delete data streams. Deletes one or more data streams and their backing indices. ---- [discrete] -===== `IndicesDeleteDataStreamRequest` +==== IndicesDeleteDataStreamRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface IndicesDeleteDataStreamRequest extends <> {
   name: <>
   master_timeout?: <>
   expand_wildcards?: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `IndicesDeleteDataStreamResponse` +==== IndicesDeleteDataStreamResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type IndicesDeleteDataStreamResponse = <>
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-indices-delete_index_template.asciidoc b/docs/reference-indices-delete_index_template.asciidoc index 238676df4..166cab179 100644 --- a/docs/reference-indices-delete_index_template.asciidoc +++ b/docs/reference-indices-delete_index_template.asciidoc @@ -41,22 +41,32 @@ Delete an index template. The provided may contain multiple tem ---- [discrete] -===== `IndicesDeleteIndexTemplateRequest` +==== IndicesDeleteIndexTemplateRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface IndicesDeleteIndexTemplateRequest extends <> {
   name: <>
   master_timeout?: <>
   timeout?: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `IndicesDeleteIndexTemplateResponse` +==== IndicesDeleteIndexTemplateResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type IndicesDeleteIndexTemplateResponse = <>
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-indices-delete_template.asciidoc b/docs/reference-indices-delete_template.asciidoc index c75d68e68..1a928e771 100644 --- a/docs/reference-indices-delete_template.asciidoc +++ b/docs/reference-indices-delete_template.asciidoc @@ -41,22 +41,32 @@ Deletes a legacy index template. ---- [discrete] -===== `IndicesDeleteTemplateRequest` +==== IndicesDeleteTemplateRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface IndicesDeleteTemplateRequest extends <> {
   name: <>
   master_timeout?: <>
   timeout?: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `IndicesDeleteTemplateResponse` +==== IndicesDeleteTemplateResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type IndicesDeleteTemplateResponse = <>
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-indices-disk_usage.asciidoc b/docs/reference-indices-disk_usage.asciidoc index 5016b03cb..7d3711744 100644 --- a/docs/reference-indices-disk_usage.asciidoc +++ b/docs/reference-indices-disk_usage.asciidoc @@ -41,10 +41,12 @@ Analyzes the disk usage of each field of an index or data stream. ---- [discrete] -===== `IndicesDiskUsageRequest` +==== IndicesDiskUsageRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface IndicesDiskUsageRequest extends <> {
   index: <>
   allow_no_indices?: boolean
@@ -53,13 +55,21 @@ interface IndicesDiskUsageRequest extends <> {
   ignore_unavailable?: boolean
   run_expensive_tasks?: boolean
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `IndicesDiskUsageResponse` +==== IndicesDiskUsageResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type IndicesDiskUsageResponse = any
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-indices-downsample.asciidoc b/docs/reference-indices-downsample.asciidoc index 4c4e94872..ec3910994 100644 --- a/docs/reference-indices-downsample.asciidoc +++ b/docs/reference-indices-downsample.asciidoc @@ -41,22 +41,32 @@ Aggregates a time series (TSDS) index and stores pre-computed statistical summar ---- [discrete] -===== `IndicesDownsampleRequest` +==== IndicesDownsampleRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface IndicesDownsampleRequest extends <> {
   index: <>
   target_index: <>
   config?: IndicesDownsampleConfig
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `IndicesDownsampleResponse` +==== IndicesDownsampleResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type IndicesDownsampleResponse = any
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-indices-exists.asciidoc b/docs/reference-indices-exists.asciidoc index 24be1ef39..b6ddc6a0c 100644 --- a/docs/reference-indices-exists.asciidoc +++ b/docs/reference-indices-exists.asciidoc @@ -41,10 +41,12 @@ Check indices. Checks if one or more indices, index aliases, or data streams exi ---- [discrete] -===== `IndicesExistsRequest` +==== IndicesExistsRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface IndicesExistsRequest extends <> {
   index: <>
   allow_no_indices?: boolean
@@ -54,13 +56,21 @@ interface IndicesExistsRequest extends <> {
   include_defaults?: boolean
   local?: boolean
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `IndicesExistsResponse` +==== IndicesExistsResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type IndicesExistsResponse = boolean
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-indices-exists_alias.asciidoc b/docs/reference-indices-exists_alias.asciidoc index 0b9011c65..4daa8a1ef 100644 --- a/docs/reference-indices-exists_alias.asciidoc +++ b/docs/reference-indices-exists_alias.asciidoc @@ -41,10 +41,12 @@ Check aliases. Checks if one or more data stream or index aliases exist. ---- [discrete] -===== `IndicesExistsAliasRequest` +==== IndicesExistsAliasRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface IndicesExistsAliasRequest extends <> {
   name: <>
   index?: <>
@@ -53,13 +55,21 @@ interface IndicesExistsAliasRequest extends <> {
   ignore_unavailable?: boolean
   local?: boolean
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `IndicesExistsAliasResponse` +==== IndicesExistsAliasResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type IndicesExistsAliasResponse = boolean
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-indices-exists_index_template.asciidoc b/docs/reference-indices-exists_index_template.asciidoc index bd78e5a5b..808a1570c 100644 --- a/docs/reference-indices-exists_index_template.asciidoc +++ b/docs/reference-indices-exists_index_template.asciidoc @@ -41,21 +41,31 @@ Returns information about whether a particular index template exists. ---- [discrete] -===== `IndicesExistsIndexTemplateRequest` +==== IndicesExistsIndexTemplateRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface IndicesExistsIndexTemplateRequest extends <> {
   name: <>
   master_timeout?: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `IndicesExistsIndexTemplateResponse` +==== IndicesExistsIndexTemplateResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type IndicesExistsIndexTemplateResponse = boolean
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-indices-exists_template.asciidoc b/docs/reference-indices-exists_template.asciidoc index 297a462e7..59204370e 100644 --- a/docs/reference-indices-exists_template.asciidoc +++ b/docs/reference-indices-exists_template.asciidoc @@ -41,23 +41,33 @@ Check existence of index templates. Returns information about whether a particul ---- [discrete] -===== `IndicesExistsTemplateRequest` +==== IndicesExistsTemplateRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface IndicesExistsTemplateRequest extends <> {
   name: <>
   flat_settings?: boolean
   local?: boolean
   master_timeout?: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `IndicesExistsTemplateResponse` +==== IndicesExistsTemplateResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type IndicesExistsTemplateResponse = boolean
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-indices-explain_data_lifecycle.asciidoc b/docs/reference-indices-explain_data_lifecycle.asciidoc index 19edd9e5d..3a2498180 100644 --- a/docs/reference-indices-explain_data_lifecycle.asciidoc +++ b/docs/reference-indices-explain_data_lifecycle.asciidoc @@ -41,24 +41,34 @@ Get the status for a data stream lifecycle. Retrieves information about an index ---- [discrete] -===== `IndicesExplainDataLifecycleRequest` +==== IndicesExplainDataLifecycleRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface IndicesExplainDataLifecycleRequest extends <> {
   index: <>
   include_defaults?: boolean
   master_timeout?: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `IndicesExplainDataLifecycleResponse` +==== IndicesExplainDataLifecycleResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface IndicesExplainDataLifecycleResponse {
   indices: Record<<>, IndicesExplainDataLifecycleDataStreamLifecycleExplain>
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-indices-field_usage_stats.asciidoc b/docs/reference-indices-field_usage_stats.asciidoc index 75d62ae1a..32d75512c 100644 --- a/docs/reference-indices-field_usage_stats.asciidoc +++ b/docs/reference-indices-field_usage_stats.asciidoc @@ -41,10 +41,12 @@ Returns field usage information for each shard and field of an index. ---- [discrete] -===== `IndicesFieldUsageStatsRequest` +==== IndicesFieldUsageStatsRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface IndicesFieldUsageStatsRequest extends <> {
   index: <>
   allow_no_indices?: boolean
@@ -55,13 +57,21 @@ interface IndicesFieldUsageStatsRequest extends <> {
   timeout?: <>
   wait_for_active_shards?: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `IndicesFieldUsageStatsResponse` +==== IndicesFieldUsageStatsResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type IndicesFieldUsageStatsResponse = IndicesFieldUsageStatsFieldsUsageBody
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-indices-flush.asciidoc b/docs/reference-indices-flush.asciidoc index ac43d259d..50676d149 100644 --- a/docs/reference-indices-flush.asciidoc +++ b/docs/reference-indices-flush.asciidoc @@ -41,10 +41,12 @@ Flushes one or more data streams or indices. ---- [discrete] -===== `IndicesFlushRequest` +==== IndicesFlushRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface IndicesFlushRequest extends <> {
   index?: <>
   allow_no_indices?: boolean
@@ -53,13 +55,21 @@ interface IndicesFlushRequest extends <> {
   ignore_unavailable?: boolean
   wait_if_ongoing?: boolean
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `IndicesFlushResponse` +==== IndicesFlushResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type IndicesFlushResponse = <>
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-indices-forcemerge.asciidoc b/docs/reference-indices-forcemerge.asciidoc index 2b542103f..34fbd2106 100644 --- a/docs/reference-indices-forcemerge.asciidoc +++ b/docs/reference-indices-forcemerge.asciidoc @@ -41,27 +41,37 @@ Performs the force merge operation on one or more indices. ---- [discrete] -===== `IndicesForcemergeRequest` +==== IndicesForcemergeRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface IndicesForcemergeRequest extends <> {
   index?: <>
   allow_no_indices?: boolean
   expand_wildcards?: <>
   flush?: boolean
   ignore_unavailable?: boolean
-  max_num_segments?: <>
+  max_num_segments?: number
   only_expunge_deletes?: boolean
   wait_for_completion?: boolean
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `IndicesForcemergeResponse` +==== IndicesForcemergeResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type IndicesForcemergeResponse = IndicesForcemergeForceMergeResponseBody
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-indices-get.asciidoc b/docs/reference-indices-get.asciidoc index 3834a71b8..ab0ce1b7e 100644 --- a/docs/reference-indices-get.asciidoc +++ b/docs/reference-indices-get.asciidoc @@ -41,10 +41,12 @@ Get index information. Returns information about one or more indices. For data s ---- [discrete] -===== `IndicesGetRequest` +==== IndicesGetRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface IndicesGetRequest extends <> {
   index: <>
   allow_no_indices?: boolean
@@ -56,13 +58,21 @@ interface IndicesGetRequest extends <> {
   master_timeout?: <>
   features?: IndicesGetFeatures
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `IndicesGetResponse` +==== IndicesGetResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type IndicesGetResponse = Record<<>, IndicesIndexState>
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-indices-get_alias.asciidoc b/docs/reference-indices-get_alias.asciidoc index ca16ce573..af68a248c 100644 --- a/docs/reference-indices-get_alias.asciidoc +++ b/docs/reference-indices-get_alias.asciidoc @@ -41,10 +41,12 @@ Get aliases. Retrieves information for one or more data stream or index aliases. ---- [discrete] -===== `IndicesGetAliasRequest` +==== IndicesGetAliasRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface IndicesGetAliasRequest extends <> {
   name?: <>
   index?: <>
@@ -53,13 +55,21 @@ interface IndicesGetAliasRequest extends <> {
   ignore_unavailable?: boolean
   local?: boolean
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `IndicesGetAliasResponse` +==== IndicesGetAliasResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type IndicesGetAliasResponse = Record<<>, IndicesGetAliasIndexAliases>
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-indices-get_data_lifecycle.asciidoc b/docs/reference-indices-get_data_lifecycle.asciidoc index b5efebe51..31cefe140 100644 --- a/docs/reference-indices-get_data_lifecycle.asciidoc +++ b/docs/reference-indices-get_data_lifecycle.asciidoc @@ -41,25 +41,35 @@ Get data stream lifecycles. Retrieves the data stream lifecycle configuration of ---- [discrete] -===== `IndicesGetDataLifecycleRequest` +==== IndicesGetDataLifecycleRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface IndicesGetDataLifecycleRequest extends <> {
   name: <>
   expand_wildcards?: <>
   include_defaults?: boolean
   master_timeout?: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `IndicesGetDataLifecycleResponse` +==== IndicesGetDataLifecycleResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface IndicesGetDataLifecycleResponse {
   data_streams: IndicesGetDataLifecycleDataStreamWithLifecycle[]
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-indices-get_data_stream.asciidoc b/docs/reference-indices-get_data_stream.asciidoc index 8fe42fb73..1c12b6b89 100644 --- a/docs/reference-indices-get_data_stream.asciidoc +++ b/docs/reference-indices-get_data_stream.asciidoc @@ -41,10 +41,12 @@ Get data streams. Retrieves information about one or more data streams. ---- [discrete] -===== `IndicesGetDataStreamRequest` +==== IndicesGetDataStreamRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface IndicesGetDataStreamRequest extends <> {
   name?: <>
   expand_wildcards?: <>
@@ -52,15 +54,23 @@ interface IndicesGetDataStreamRequest extends <> {
   master_timeout?: <>
   verbose?: boolean
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `IndicesGetDataStreamResponse` +==== IndicesGetDataStreamResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface IndicesGetDataStreamResponse {
   data_streams: IndicesDataStream[]
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-indices-get_field_mapping.asciidoc b/docs/reference-indices-get_field_mapping.asciidoc index a7fcf1e38..798f2ddbf 100644 --- a/docs/reference-indices-get_field_mapping.asciidoc +++ b/docs/reference-indices-get_field_mapping.asciidoc @@ -41,10 +41,12 @@ Get mapping definitions. Retrieves mapping definitions for one or more fields. F ---- [discrete] -===== `IndicesGetFieldMappingRequest` +==== IndicesGetFieldMappingRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface IndicesGetFieldMappingRequest extends <> {
   fields: <>
   index?: <>
@@ -54,13 +56,21 @@ interface IndicesGetFieldMappingRequest extends <> {
   include_defaults?: boolean
   local?: boolean
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `IndicesGetFieldMappingResponse` +==== IndicesGetFieldMappingResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type IndicesGetFieldMappingResponse = Record<<>, IndicesGetFieldMappingTypeFieldMappings>
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-indices-get_index_template.asciidoc b/docs/reference-indices-get_index_template.asciidoc index a34459df3..fe4d7ea0e 100644 --- a/docs/reference-indices-get_index_template.asciidoc +++ b/docs/reference-indices-get_index_template.asciidoc @@ -41,10 +41,12 @@ Get index templates. Returns information about one or more index templates. ---- [discrete] -===== `IndicesGetIndexTemplateRequest` +==== IndicesGetIndexTemplateRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface IndicesGetIndexTemplateRequest extends <> {
   name?: <>
   local?: boolean
@@ -52,15 +54,23 @@ interface IndicesGetIndexTemplateRequest extends <> {
   master_timeout?: <>
   include_defaults?: boolean
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `IndicesGetIndexTemplateResponse` +==== IndicesGetIndexTemplateResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface IndicesGetIndexTemplateResponse {
   index_templates: IndicesGetIndexTemplateIndexTemplateItem[]
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-indices-get_mapping.asciidoc b/docs/reference-indices-get_mapping.asciidoc index 5771704b0..b9b6c8740 100644 --- a/docs/reference-indices-get_mapping.asciidoc +++ b/docs/reference-indices-get_mapping.asciidoc @@ -41,10 +41,12 @@ Get mapping definitions. Retrieves mapping definitions for one or more indices. ---- [discrete] -===== `IndicesGetMappingRequest` +==== IndicesGetMappingRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface IndicesGetMappingRequest extends <> {
   index?: <>
   allow_no_indices?: boolean
@@ -53,13 +55,21 @@ interface IndicesGetMappingRequest extends <> {
   local?: boolean
   master_timeout?: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `IndicesGetMappingResponse` +==== IndicesGetMappingResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type IndicesGetMappingResponse = Record<<>, IndicesGetMappingIndexMappingRecord>
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-indices-get_settings.asciidoc b/docs/reference-indices-get_settings.asciidoc index 9298342b7..8197231c4 100644 --- a/docs/reference-indices-get_settings.asciidoc +++ b/docs/reference-indices-get_settings.asciidoc @@ -41,10 +41,12 @@ Get index settings. Returns setting information for one or more indices. For dat ---- [discrete] -===== `IndicesGetSettingsRequest` +==== IndicesGetSettingsRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface IndicesGetSettingsRequest extends <> {
   index?: <>
   name?: <>
@@ -56,13 +58,21 @@ interface IndicesGetSettingsRequest extends <> {
   local?: boolean
   master_timeout?: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `IndicesGetSettingsResponse` +==== IndicesGetSettingsResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type IndicesGetSettingsResponse = Record<<>, IndicesIndexState>
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-indices-get_template.asciidoc b/docs/reference-indices-get_template.asciidoc index 06ee14ff0..8a6d2a0c2 100644 --- a/docs/reference-indices-get_template.asciidoc +++ b/docs/reference-indices-get_template.asciidoc @@ -41,23 +41,33 @@ Get index templates. Retrieves information about one or more index templates. ---- [discrete] -===== `IndicesGetTemplateRequest` +==== IndicesGetTemplateRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface IndicesGetTemplateRequest extends <> {
   name?: <>
   flat_settings?: boolean
   local?: boolean
   master_timeout?: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `IndicesGetTemplateResponse` +==== IndicesGetTemplateResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type IndicesGetTemplateResponse = Record
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-indices-migrate_to_data_stream.asciidoc b/docs/reference-indices-migrate_to_data_stream.asciidoc index 648e109c4..5274f471a 100644 --- a/docs/reference-indices-migrate_to_data_stream.asciidoc +++ b/docs/reference-indices-migrate_to_data_stream.asciidoc @@ -41,22 +41,32 @@ Convert an index alias to a data stream. Converts an index alias to a data strea ---- [discrete] -===== `IndicesMigrateToDataStreamRequest` +==== IndicesMigrateToDataStreamRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface IndicesMigrateToDataStreamRequest extends <> {
   name: <>
   master_timeout?: <>
   timeout?: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `IndicesMigrateToDataStreamResponse` +==== IndicesMigrateToDataStreamResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type IndicesMigrateToDataStreamResponse = <>
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-indices-modify_data_stream.asciidoc b/docs/reference-indices-modify_data_stream.asciidoc index dc78a293c..52b6c8e4f 100644 --- a/docs/reference-indices-modify_data_stream.asciidoc +++ b/docs/reference-indices-modify_data_stream.asciidoc @@ -41,20 +41,30 @@ Update data streams. Performs one or more data stream modification actions in a ---- [discrete] -===== `IndicesModifyDataStreamRequest` +==== IndicesModifyDataStreamRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface IndicesModifyDataStreamRequest extends <> {
   actions: IndicesModifyDataStreamAction[]
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `IndicesModifyDataStreamResponse` +==== IndicesModifyDataStreamResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type IndicesModifyDataStreamResponse = <>
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-indices-open.asciidoc b/docs/reference-indices-open.asciidoc index 275d6e05a..970ffeccd 100644 --- a/docs/reference-indices-open.asciidoc +++ b/docs/reference-indices-open.asciidoc @@ -41,10 +41,12 @@ Opens a closed index. For data streams, the API opens any closed backing indices ---- [discrete] -===== `IndicesOpenRequest` +==== IndicesOpenRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface IndicesOpenRequest extends <> {
   index: <>
   allow_no_indices?: boolean
@@ -54,16 +56,24 @@ interface IndicesOpenRequest extends <> {
   timeout?: <>
   wait_for_active_shards?: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `IndicesOpenResponse` +==== IndicesOpenResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface IndicesOpenResponse {
   acknowledged: boolean
   shards_acknowledged: boolean
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-indices-promote_data_stream.asciidoc b/docs/reference-indices-promote_data_stream.asciidoc index 9e9b30ceb..a4392e6b8 100644 --- a/docs/reference-indices-promote_data_stream.asciidoc +++ b/docs/reference-indices-promote_data_stream.asciidoc @@ -41,21 +41,31 @@ Promotes a data stream from a replicated data stream managed by CCR to a regular ---- [discrete] -===== `IndicesPromoteDataStreamRequest` +==== IndicesPromoteDataStreamRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface IndicesPromoteDataStreamRequest extends <> {
   name: <>
   master_timeout?: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `IndicesPromoteDataStreamResponse` +==== IndicesPromoteDataStreamResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type IndicesPromoteDataStreamResponse = any
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-indices-put_alias.asciidoc b/docs/reference-indices-put_alias.asciidoc index 132bbc268..6b47fb75b 100644 --- a/docs/reference-indices-put_alias.asciidoc +++ b/docs/reference-indices-put_alias.asciidoc @@ -41,10 +41,12 @@ Create or update an alias. Adds a data stream or index to an alias. ---- [discrete] -===== `IndicesPutAliasRequest` +==== IndicesPutAliasRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface IndicesPutAliasRequest extends <> {
   index: <>
   name: <>
@@ -56,13 +58,21 @@ interface IndicesPutAliasRequest extends <> {
   routing?: <>
   search_routing?: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `IndicesPutAliasResponse` +==== IndicesPutAliasResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type IndicesPutAliasResponse = <>
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-indices-put_data_lifecycle.asciidoc b/docs/reference-indices-put_data_lifecycle.asciidoc index 65c278d07..c8b224904 100644 --- a/docs/reference-indices-put_data_lifecycle.asciidoc +++ b/docs/reference-indices-put_data_lifecycle.asciidoc @@ -41,10 +41,12 @@ Update data stream lifecycles. Update the data stream lifecycle of the specified ---- [discrete] -===== `IndicesPutDataLifecycleRequest` +==== IndicesPutDataLifecycleRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface IndicesPutDataLifecycleRequest extends <> {
   name: <>
   expand_wildcards?: <>
@@ -53,13 +55,21 @@ interface IndicesPutDataLifecycleRequest extends <> {
   data_retention?: <>
   downsampling?: IndicesDataStreamLifecycleDownsampling
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `IndicesPutDataLifecycleResponse` +==== IndicesPutDataLifecycleResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type IndicesPutDataLifecycleResponse = <>
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-indices-put_index_template.asciidoc b/docs/reference-indices-put_index_template.asciidoc index ec471728f..67c8c88fe 100644 --- a/docs/reference-indices-put_index_template.asciidoc +++ b/docs/reference-indices-put_index_template.asciidoc @@ -41,10 +41,12 @@ Create or update an index template. Index templates define settings, mappings, a ---- [discrete] -===== `IndicesPutIndexTemplateRequest` +==== IndicesPutIndexTemplateRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface IndicesPutIndexTemplateRequest extends <> {
   name: <>
   create?: boolean
@@ -54,20 +56,28 @@ interface IndicesPutIndexTemplateRequest extends <> {
   composed_of?: <>[]
   template?: IndicesPutIndexTemplateIndexTemplateMapping
   data_stream?: IndicesDataStreamVisibility
-  priority?: <>
+  priority?: number
   version?: <>
   _meta?: <>
   allow_auto_create?: boolean
   ignore_missing_component_templates?: string[]
   deprecated?: boolean
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `IndicesPutIndexTemplateResponse` +==== IndicesPutIndexTemplateResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type IndicesPutIndexTemplateResponse = <>
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-indices-put_mapping.asciidoc b/docs/reference-indices-put_mapping.asciidoc index afb8d687f..78f058df4 100644 --- a/docs/reference-indices-put_mapping.asciidoc +++ b/docs/reference-indices-put_mapping.asciidoc @@ -41,10 +41,12 @@ Update field mappings. Adds new fields to an existing data stream or index. You ---- [discrete] -===== `IndicesPutMappingRequest` +==== IndicesPutMappingRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface IndicesPutMappingRequest extends <> {
   index: <>
   allow_no_indices?: boolean
@@ -65,13 +67,21 @@ interface IndicesPutMappingRequest extends <> {
   _source?: MappingSourceField
   runtime?: MappingRuntimeFields
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `IndicesPutMappingResponse` +==== IndicesPutMappingResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type IndicesPutMappingResponse = <>
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-indices-put_settings.asciidoc b/docs/reference-indices-put_settings.asciidoc index 9fe0434f8..a6a74f3ba 100644 --- a/docs/reference-indices-put_settings.asciidoc +++ b/docs/reference-indices-put_settings.asciidoc @@ -41,10 +41,12 @@ Update index settings. Changes dynamic index settings in real time. For data str ---- [discrete] -===== `IndicesPutSettingsRequest` +==== IndicesPutSettingsRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface IndicesPutSettingsRequest extends <> {
   index?: <>
   allow_no_indices?: boolean
@@ -56,13 +58,21 @@ interface IndicesPutSettingsRequest extends <> {
   timeout?: <>
   settings?: IndicesIndexSettings
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `IndicesPutSettingsResponse` +==== IndicesPutSettingsResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type IndicesPutSettingsResponse = <>
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-indices-put_template.asciidoc b/docs/reference-indices-put_template.asciidoc index d06e375fd..36ea8c7af 100644 --- a/docs/reference-indices-put_template.asciidoc +++ b/docs/reference-indices-put_template.asciidoc @@ -41,10 +41,12 @@ Create or update an index template. Index templates define settings, mappings, a ---- [discrete] -===== `IndicesPutTemplateRequest` +==== IndicesPutTemplateRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface IndicesPutTemplateRequest extends <> {
   name: <>
   create?: boolean
@@ -53,17 +55,25 @@ interface IndicesPutTemplateRequest extends <> {
   aliases?: Record<<>, IndicesAlias>
   index_patterns?: string | string[]
   mappings?: MappingTypeMapping
-  order?: <>
+  order?: number
   settings?: IndicesIndexSettings
   version?: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `IndicesPutTemplateResponse` +==== IndicesPutTemplateResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type IndicesPutTemplateResponse = <>
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-indices-recovery.asciidoc b/docs/reference-indices-recovery.asciidoc index 111663f08..e1432b639 100644 --- a/docs/reference-indices-recovery.asciidoc +++ b/docs/reference-indices-recovery.asciidoc @@ -41,22 +41,32 @@ Returns information about ongoing and completed shard recoveries for one or more ---- [discrete] -===== `IndicesRecoveryRequest` +==== IndicesRecoveryRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface IndicesRecoveryRequest extends <> {
   index?: <>
   active_only?: boolean
   detailed?: boolean
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `IndicesRecoveryResponse` +==== IndicesRecoveryResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type IndicesRecoveryResponse = Record<<>, IndicesRecoveryRecoveryStatus>
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-indices-refresh.asciidoc b/docs/reference-indices-refresh.asciidoc index f96305064..57af9a9b9 100644 --- a/docs/reference-indices-refresh.asciidoc +++ b/docs/reference-indices-refresh.asciidoc @@ -41,23 +41,33 @@ Refresh an index. A refresh makes recent operations performed on one or more ind ---- [discrete] -===== `IndicesRefreshRequest` +==== IndicesRefreshRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface IndicesRefreshRequest extends <> {
   index?: <>
   allow_no_indices?: boolean
   expand_wildcards?: <>
   ignore_unavailable?: boolean
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `IndicesRefreshResponse` +==== IndicesRefreshResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type IndicesRefreshResponse = <>
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-indices-reload_search_analyzers.asciidoc b/docs/reference-indices-reload_search_analyzers.asciidoc index c07a2b5c8..9b32f5979 100644 --- a/docs/reference-indices-reload_search_analyzers.asciidoc +++ b/docs/reference-indices-reload_search_analyzers.asciidoc @@ -41,23 +41,33 @@ Reloads an index's search analyzers and their resources. ---- [discrete] -===== `IndicesReloadSearchAnalyzersRequest` +==== IndicesReloadSearchAnalyzersRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface IndicesReloadSearchAnalyzersRequest extends <> {
   index: <>
   allow_no_indices?: boolean
   expand_wildcards?: <>
   ignore_unavailable?: boolean
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `IndicesReloadSearchAnalyzersResponse` +==== IndicesReloadSearchAnalyzersResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type IndicesReloadSearchAnalyzersResponse = IndicesReloadSearchAnalyzersReloadResult
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-indices-resolve_cluster.asciidoc b/docs/reference-indices-resolve_cluster.asciidoc index be0275a09..b77625af1 100644 --- a/docs/reference-indices-resolve_cluster.asciidoc +++ b/docs/reference-indices-resolve_cluster.asciidoc @@ -41,10 +41,12 @@ Resolves the specified index expressions to return information about each cluste ---- [discrete] -===== `IndicesResolveClusterRequest` +==== IndicesResolveClusterRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface IndicesResolveClusterRequest extends <> {
   name: <>
   allow_no_indices?: boolean
@@ -52,13 +54,21 @@ interface IndicesResolveClusterRequest extends <> {
   ignore_throttled?: boolean
   ignore_unavailable?: boolean
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `IndicesResolveClusterResponse` +==== IndicesResolveClusterResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type IndicesResolveClusterResponse = Record<<>, IndicesResolveClusterResolveClusterInfo>
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-indices-resolve_index.asciidoc b/docs/reference-indices-resolve_index.asciidoc index c8561b32a..8dc6e3de9 100644 --- a/docs/reference-indices-resolve_index.asciidoc +++ b/docs/reference-indices-resolve_index.asciidoc @@ -41,27 +41,37 @@ Resolves the specified name(s) and/or index patterns for indices, aliases, and d ---- [discrete] -===== `IndicesResolveIndexRequest` +==== IndicesResolveIndexRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface IndicesResolveIndexRequest extends <> {
   name: <>
   expand_wildcards?: <>
   ignore_unavailable?: boolean
   allow_no_indices?: boolean
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `IndicesResolveIndexResponse` +==== IndicesResolveIndexResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface IndicesResolveIndexResponse {
   indices: IndicesResolveIndexResolveIndexItem[]
   aliases: IndicesResolveIndexResolveIndexAliasItem[]
   data_streams: IndicesResolveIndexResolveIndexDataStreamsItem[]
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-indices-rollover.asciidoc b/docs/reference-indices-rollover.asciidoc index ac0acc3a1..5b308030f 100644 --- a/docs/reference-indices-rollover.asciidoc +++ b/docs/reference-indices-rollover.asciidoc @@ -41,10 +41,12 @@ Roll over to a new index. Creates a new index for a data stream or index alias. ---- [discrete] -===== `IndicesRolloverRequest` +==== IndicesRolloverRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface IndicesRolloverRequest extends <> {
   alias: <>
   new_index?: <>
@@ -57,13 +59,18 @@ interface IndicesRolloverRequest extends <> {
   mappings?: MappingTypeMapping
   settings?: Record
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `IndicesRolloverResponse` +==== IndicesRolloverResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface IndicesRolloverResponse {
   acknowledged: boolean
   conditions: Record
@@ -73,5 +80,8 @@ interface IndicesRolloverResponse {
   rolled_over: boolean
   shards_acknowledged: boolean
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-indices-segments.asciidoc b/docs/reference-indices-segments.asciidoc index 5de594def..856972506 100644 --- a/docs/reference-indices-segments.asciidoc +++ b/docs/reference-indices-segments.asciidoc @@ -41,10 +41,12 @@ Returns low-level information about the Lucene segments in index shards. For dat ---- [discrete] -===== `IndicesSegmentsRequest` +==== IndicesSegmentsRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface IndicesSegmentsRequest extends <> {
   index?: <>
   allow_no_indices?: boolean
@@ -52,16 +54,24 @@ interface IndicesSegmentsRequest extends <> {
   ignore_unavailable?: boolean
   verbose?: boolean
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `IndicesSegmentsResponse` +==== IndicesSegmentsResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface IndicesSegmentsResponse {
   indices: Record
   _shards: <>
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-indices-shard_stores.asciidoc b/docs/reference-indices-shard_stores.asciidoc index 55347b494..d7d172ffa 100644 --- a/docs/reference-indices-shard_stores.asciidoc +++ b/docs/reference-indices-shard_stores.asciidoc @@ -41,10 +41,12 @@ Retrieves store information about replica shards in one or more indices. For dat ---- [discrete] -===== `IndicesShardStoresRequest` +==== IndicesShardStoresRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface IndicesShardStoresRequest extends <> {
   index?: <>
   allow_no_indices?: boolean
@@ -52,15 +54,23 @@ interface IndicesShardStoresRequest extends <> {
   ignore_unavailable?: boolean
   status?: IndicesShardStoresShardStoreStatus | IndicesShardStoresShardStoreStatus[]
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `IndicesShardStoresResponse` +==== IndicesShardStoresResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface IndicesShardStoresResponse {
   indices: Record<<>, IndicesShardStoresIndicesShardStores>
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-indices-shrink.asciidoc b/docs/reference-indices-shrink.asciidoc index 96f0717d4..c43f1652b 100644 --- a/docs/reference-indices-shrink.asciidoc +++ b/docs/reference-indices-shrink.asciidoc @@ -41,10 +41,12 @@ Shrinks an existing index into a new index with fewer primary shards. ---- [discrete] -===== `IndicesShrinkRequest` +==== IndicesShrinkRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface IndicesShrinkRequest extends <> {
   index: <>
   target: <>
@@ -54,17 +56,25 @@ interface IndicesShrinkRequest extends <> {
   aliases?: Record<<>, IndicesAlias>
   settings?: Record
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `IndicesShrinkResponse` +==== IndicesShrinkResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface IndicesShrinkResponse {
   acknowledged: boolean
   shards_acknowledged: boolean
   index: <>
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-indices-simulate_index_template.asciidoc b/docs/reference-indices-simulate_index_template.asciidoc index 27d031b63..118044e31 100644 --- a/docs/reference-indices-simulate_index_template.asciidoc +++ b/docs/reference-indices-simulate_index_template.asciidoc @@ -41,25 +41,35 @@ Simulate an index. Returns the index configuration that would be applied to the ---- [discrete] -===== `IndicesSimulateIndexTemplateRequest` +==== IndicesSimulateIndexTemplateRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface IndicesSimulateIndexTemplateRequest extends <> {
   name: <>
   master_timeout?: <>
   include_defaults?: boolean
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `IndicesSimulateIndexTemplateResponse` +==== IndicesSimulateIndexTemplateResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface IndicesSimulateIndexTemplateResponse {
   overlapping?: IndicesSimulateTemplateOverlapping[]
   template: IndicesSimulateTemplateTemplate
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-indices-simulate_template.asciidoc b/docs/reference-indices-simulate_template.asciidoc index 9ea9eb8bd..ff4498031 100644 --- a/docs/reference-indices-simulate_template.asciidoc +++ b/docs/reference-indices-simulate_template.asciidoc @@ -41,10 +41,12 @@ Simulate an index template. Returns the index configuration that would be applie ---- [discrete] -===== `IndicesSimulateTemplateRequest` +==== IndicesSimulateTemplateRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface IndicesSimulateTemplateRequest extends <> {
   name?: <>
   create?: boolean
@@ -55,22 +57,30 @@ interface IndicesSimulateTemplateRequest extends <> {
   composed_of?: <>[]
   template?: IndicesPutIndexTemplateIndexTemplateMapping
   data_stream?: IndicesDataStreamVisibility
-  priority?: <>
+  priority?: number
   version?: <>
   _meta?: <>
   ignore_missing_component_templates?: string[]
   deprecated?: boolean
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `IndicesSimulateTemplateResponse` +==== IndicesSimulateTemplateResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface IndicesSimulateTemplateResponse {
   overlapping?: IndicesSimulateTemplateOverlapping[]
   template: IndicesSimulateTemplateTemplate
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-indices-split.asciidoc b/docs/reference-indices-split.asciidoc index 761d114e6..6f5b42e25 100644 --- a/docs/reference-indices-split.asciidoc +++ b/docs/reference-indices-split.asciidoc @@ -41,10 +41,12 @@ Splits an existing index into a new index with more primary shards. ---- [discrete] -===== `IndicesSplitRequest` +==== IndicesSplitRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface IndicesSplitRequest extends <> {
   index: <>
   target: <>
@@ -54,17 +56,25 @@ interface IndicesSplitRequest extends <> {
   aliases?: Record<<>, IndicesAlias>
   settings?: Record
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `IndicesSplitResponse` +==== IndicesSplitResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface IndicesSplitResponse {
   acknowledged: boolean
   shards_acknowledged: boolean
   index: <>
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-indices-stats.asciidoc b/docs/reference-indices-stats.asciidoc index d22753e4e..91eb3584f 100644 --- a/docs/reference-indices-stats.asciidoc +++ b/docs/reference-indices-stats.asciidoc @@ -41,10 +41,12 @@ Returns statistics for one or more indices. For data streams, the API retrieves ---- [discrete] -===== `IndicesStatsRequest` +==== IndicesStatsRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface IndicesStatsRequest extends <> {
   metric?: <>
   index?: <>
@@ -58,17 +60,25 @@ interface IndicesStatsRequest extends <> {
   include_unloaded_segments?: boolean
   level?: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `IndicesStatsResponse` +==== IndicesStatsResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface IndicesStatsResponse {
   indices?: Record
   _shards: <>
   _all: IndicesStatsIndicesStats
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-indices-unfreeze.asciidoc b/docs/reference-indices-unfreeze.asciidoc index f7a210f7b..fc3b34872 100644 --- a/docs/reference-indices-unfreeze.asciidoc +++ b/docs/reference-indices-unfreeze.asciidoc @@ -41,10 +41,12 @@ Unfreezes an index. ---- [discrete] -===== `IndicesUnfreezeRequest` +==== IndicesUnfreezeRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface IndicesUnfreezeRequest extends <> {
   index: <>
   allow_no_indices?: boolean
@@ -54,16 +56,24 @@ interface IndicesUnfreezeRequest extends <> {
   timeout?: <>
   wait_for_active_shards?: string
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `IndicesUnfreezeResponse` +==== IndicesUnfreezeResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface IndicesUnfreezeResponse {
   acknowledged: boolean
   shards_acknowledged: boolean
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-indices-update_aliases.asciidoc b/docs/reference-indices-update_aliases.asciidoc index d2df15f7c..97153713c 100644 --- a/docs/reference-indices-update_aliases.asciidoc +++ b/docs/reference-indices-update_aliases.asciidoc @@ -41,22 +41,32 @@ Create or update an alias. Adds a data stream or index to an alias. ---- [discrete] -===== `IndicesUpdateAliasesRequest` +==== IndicesUpdateAliasesRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface IndicesUpdateAliasesRequest extends <> {
   master_timeout?: <>
   timeout?: <>
   actions?: IndicesUpdateAliasesAction[]
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `IndicesUpdateAliasesResponse` +==== IndicesUpdateAliasesResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type IndicesUpdateAliasesResponse = <>
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-indices-validate_query.asciidoc b/docs/reference-indices-validate_query.asciidoc index c9188c8ce..999ff301f 100644 --- a/docs/reference-indices-validate_query.asciidoc +++ b/docs/reference-indices-validate_query.asciidoc @@ -41,10 +41,12 @@ Validate a query. Validates a query without running it. ---- [discrete] -===== `IndicesValidateQueryRequest` +==== IndicesValidateQueryRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface IndicesValidateQueryRequest extends <> {
   index?: <>
   allow_no_indices?: boolean
@@ -61,18 +63,26 @@ interface IndicesValidateQueryRequest extends <> {
   q?: string
   query?: QueryDslQueryContainer
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `IndicesValidateQueryResponse` +==== IndicesValidateQueryResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface IndicesValidateQueryResponse {
   explanations?: IndicesValidateQueryIndicesValidationExplanation[]
   _shards?: <>
   valid: boolean
   error?: string
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-inference-delete.asciidoc b/docs/reference-inference-delete.asciidoc index d21954153..41a2cbe9f 100644 --- a/docs/reference-inference-delete.asciidoc +++ b/docs/reference-inference-delete.asciidoc @@ -41,23 +41,33 @@ Delete an inference endpoint ---- [discrete] -===== `InferenceDeleteRequest` +==== InferenceDeleteRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface InferenceDeleteRequest extends <> {
   task_type?: InferenceTaskType
   inference_id: <>
   dry_run?: boolean
   force?: boolean
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `InferenceDeleteResponse` +==== InferenceDeleteResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type InferenceDeleteResponse = InferenceDeleteInferenceEndpointResult
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-inference-get.asciidoc b/docs/reference-inference-get.asciidoc index 22febeae4..07d23b74b 100644 --- a/docs/reference-inference-get.asciidoc +++ b/docs/reference-inference-get.asciidoc @@ -41,23 +41,33 @@ Get an inference endpoint ---- [discrete] -===== `InferenceGetRequest` +==== InferenceGetRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface InferenceGetRequest extends <> {
   task_type?: InferenceTaskType
   inference_id?: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `InferenceGetResponse` +==== InferenceGetResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface InferenceGetResponse {
   endpoints: InferenceInferenceEndpointInfo[]
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-inference-inference.asciidoc b/docs/reference-inference-inference.asciidoc index bc19290ea..215604029 100644 --- a/docs/reference-inference-inference.asciidoc +++ b/docs/reference-inference-inference.asciidoc @@ -41,10 +41,12 @@ Perform inference on the service ---- [discrete] -===== `InferenceInferenceRequest` +==== InferenceInferenceRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface InferenceInferenceRequest extends <> {
   task_type?: InferenceTaskType
   inference_id: <>
@@ -53,13 +55,21 @@ interface InferenceInferenceRequest extends <> {
   input: string | string[]
   task_settings?: InferenceTaskSettings
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `InferenceInferenceResponse` +==== InferenceInferenceResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type InferenceInferenceResponse = InferenceInferenceResult
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-inference-put.asciidoc b/docs/reference-inference-put.asciidoc index ba73f5a85..bc3e9fe8f 100644 --- a/docs/reference-inference-put.asciidoc +++ b/docs/reference-inference-put.asciidoc @@ -41,22 +41,32 @@ Create an inference endpoint ---- [discrete] -===== `InferencePutRequest` +==== InferencePutRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface InferencePutRequest extends <> {
   task_type?: InferenceTaskType
   inference_id: <>
   inference_config?: InferenceInferenceEndpoint
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `InferencePutResponse` +==== InferencePutResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type InferencePutResponse = InferenceInferenceEndpointInfo
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-inference-stream_inference.asciidoc b/docs/reference-inference-stream_inference.asciidoc index 184054640..9eaf3fc0e 100644 --- a/docs/reference-inference-stream_inference.asciidoc +++ b/docs/reference-inference-stream_inference.asciidoc @@ -38,20 +38,3 @@ Perform streaming inference (InferenceStreamInferenceRequest, options?): Promise ---- -[discrete] -===== `InferenceStreamInferenceRequest` - -[source,ts] ----- -{ -} ----- - -[discrete] -===== `InferenceStreamInferenceResponse` - -[source,ts] ----- -n/a ----- - diff --git a/docs/reference-info.asciidoc b/docs/reference-info.asciidoc index f263a3788..e15698851 100644 --- a/docs/reference-info.asciidoc +++ b/docs/reference-info.asciidoc @@ -41,19 +41,26 @@ Get cluster info. Returns basic information about the cluster. ---- [discrete] -===== `InfoRequest` +==== InfoRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface InfoRequest extends <> {
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `InfoResponse` +==== InfoResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface InfoResponse {
   cluster_name: <>
   cluster_uuid: <>
@@ -61,5 +68,8 @@ interface InfoResponse {
   tagline: string
   version: <>
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-ingest-delete_geoip_database.asciidoc b/docs/reference-ingest-delete_geoip_database.asciidoc index 8953a983b..fb2ba794c 100644 --- a/docs/reference-ingest-delete_geoip_database.asciidoc +++ b/docs/reference-ingest-delete_geoip_database.asciidoc @@ -41,22 +41,32 @@ Deletes a geoip database configuration. ---- [discrete] -===== `IngestDeleteGeoipDatabaseRequest` +==== IngestDeleteGeoipDatabaseRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface IngestDeleteGeoipDatabaseRequest extends <> {
   id: <>
   master_timeout?: <>
   timeout?: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `IngestDeleteGeoipDatabaseResponse` +==== IngestDeleteGeoipDatabaseResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type IngestDeleteGeoipDatabaseResponse = <>
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-ingest-delete_pipeline.asciidoc b/docs/reference-ingest-delete_pipeline.asciidoc index 9f70eb5d6..c6387b125 100644 --- a/docs/reference-ingest-delete_pipeline.asciidoc +++ b/docs/reference-ingest-delete_pipeline.asciidoc @@ -41,22 +41,32 @@ Deletes one or more existing ingest pipeline. ---- [discrete] -===== `IngestDeletePipelineRequest` +==== IngestDeletePipelineRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface IngestDeletePipelineRequest extends <> {
   id: <>
   master_timeout?: <>
   timeout?: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `IngestDeletePipelineResponse` +==== IngestDeletePipelineResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type IngestDeletePipelineResponse = <>
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-ingest-geo_ip_stats.asciidoc b/docs/reference-ingest-geo_ip_stats.asciidoc index 3288a67f6..6c419f0aa 100644 --- a/docs/reference-ingest-geo_ip_stats.asciidoc +++ b/docs/reference-ingest-geo_ip_stats.asciidoc @@ -41,22 +41,32 @@ Gets download statistics for GeoIP2 databases used with the geoip processor. ---- [discrete] -===== `IngestGeoIpStatsRequest` +==== IngestGeoIpStatsRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface IngestGeoIpStatsRequest extends <> {
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `IngestGeoIpStatsResponse` +==== IngestGeoIpStatsResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface IngestGeoIpStatsResponse {
   stats: IngestGeoIpStatsGeoIpDownloadStatistics
   nodes: Record<<>, IngestGeoIpStatsGeoIpNodeDatabases>
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-ingest-get_geoip_database.asciidoc b/docs/reference-ingest-get_geoip_database.asciidoc index bbe581a36..041719496 100644 --- a/docs/reference-ingest-get_geoip_database.asciidoc +++ b/docs/reference-ingest-get_geoip_database.asciidoc @@ -41,23 +41,33 @@ Returns information about one or more geoip database configurations. ---- [discrete] -===== `IngestGetGeoipDatabaseRequest` +==== IngestGetGeoipDatabaseRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface IngestGetGeoipDatabaseRequest extends <> {
   id?: <>
   master_timeout?: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `IngestGetGeoipDatabaseResponse` +==== IngestGetGeoipDatabaseResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface IngestGetGeoipDatabaseResponse {
   databases: IngestGetGeoipDatabaseDatabaseConfigurationMetadata[]
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-ingest-get_pipeline.asciidoc b/docs/reference-ingest-get_pipeline.asciidoc index 1e725e195..9ac8b6f3e 100644 --- a/docs/reference-ingest-get_pipeline.asciidoc +++ b/docs/reference-ingest-get_pipeline.asciidoc @@ -41,22 +41,32 @@ Returns information about one or more ingest pipelines. This API returns a local ---- [discrete] -===== `IngestGetPipelineRequest` +==== IngestGetPipelineRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface IngestGetPipelineRequest extends <> {
   id?: <>
   master_timeout?: <>
   summary?: boolean
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `IngestGetPipelineResponse` +==== IngestGetPipelineResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type IngestGetPipelineResponse = Record
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-ingest-processor_grok.asciidoc b/docs/reference-ingest-processor_grok.asciidoc index d51ae5c3f..17919199c 100644 --- a/docs/reference-ingest-processor_grok.asciidoc +++ b/docs/reference-ingest-processor_grok.asciidoc @@ -41,21 +41,31 @@ Extracts structured fields out of a single text field within a document. You cho ---- [discrete] -===== `IngestProcessorGrokRequest` +==== IngestProcessorGrokRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface IngestProcessorGrokRequest extends <> {
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `IngestProcessorGrokResponse` +==== IngestProcessorGrokResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface IngestProcessorGrokResponse {
   patterns: Record
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-ingest-put_geoip_database.asciidoc b/docs/reference-ingest-put_geoip_database.asciidoc index 54f71fa39..ae7e37a0e 100644 --- a/docs/reference-ingest-put_geoip_database.asciidoc +++ b/docs/reference-ingest-put_geoip_database.asciidoc @@ -41,10 +41,12 @@ Returns information about one or more geoip database configurations. ---- [discrete] -===== `IngestPutGeoipDatabaseRequest` +==== IngestPutGeoipDatabaseRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface IngestPutGeoipDatabaseRequest extends <> {
   id: <>
   master_timeout?: <>
@@ -52,13 +54,21 @@ interface IngestPutGeoipDatabaseRequest extends <> {
   name: <>
   maxmind: IngestMaxmind
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `IngestPutGeoipDatabaseResponse` +==== IngestPutGeoipDatabaseResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type IngestPutGeoipDatabaseResponse = <>
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-ingest-put_pipeline.asciidoc b/docs/reference-ingest-put_pipeline.asciidoc index 44aa2e00c..ead07aa14 100644 --- a/docs/reference-ingest-put_pipeline.asciidoc +++ b/docs/reference-ingest-put_pipeline.asciidoc @@ -41,10 +41,12 @@ Creates or updates an ingest pipeline. Changes made using this API take effect i ---- [discrete] -===== `IngestPutPipelineRequest` +==== IngestPutPipelineRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface IngestPutPipelineRequest extends <> {
   id: <>
   master_timeout?: <>
@@ -57,13 +59,21 @@ interface IngestPutPipelineRequest extends <> {
   version?: <>
   deprecated?: boolean
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `IngestPutPipelineResponse` +==== IngestPutPipelineResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type IngestPutPipelineResponse = <>
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-ingest-simulate.asciidoc b/docs/reference-ingest-simulate.asciidoc index a76a08f1d..937c1f225 100644 --- a/docs/reference-ingest-simulate.asciidoc +++ b/docs/reference-ingest-simulate.asciidoc @@ -41,25 +41,35 @@ Executes an ingest pipeline against a set of provided documents. ---- [discrete] -===== `IngestSimulateRequest` +==== IngestSimulateRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface IngestSimulateRequest extends <> {
   id?: <>
   verbose?: boolean
   docs: IngestSimulateDocument[]
   pipeline?: IngestPipeline
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `IngestSimulateResponse` +==== IngestSimulateResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface IngestSimulateResponse {
   docs: IngestSimulateSimulateDocumentResult[]
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-knn_search.asciidoc b/docs/reference-knn_search.asciidoc index 89ef33f2a..48da6c3ac 100644 --- a/docs/reference-knn_search.asciidoc +++ b/docs/reference-knn_search.asciidoc @@ -41,10 +41,12 @@ Run a knn search. NOTE: The kNN search API has been replaced by the `knn` option ---- [discrete] -===== `KnnSearchRequest` +==== KnnSearchRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface KnnSearchRequest extends <> {
   index: <>
   routing?: <>
@@ -55,20 +57,28 @@ interface KnnSearchRequest extends <> {
   filter?: QueryDslQueryContainer | QueryDslQueryContainer[]
   knn: KnnSearchQuery
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `KnnSearchResponse` +==== KnnSearchResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface KnnSearchResponse {
-  took: <>
+  took: number
   timed_out: boolean
   _shards: <>
   hits: SearchHitsMetadata
   fields?: Record
-  max_score?: <>
+  max_score?: number
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-license-delete.asciidoc b/docs/reference-license-delete.asciidoc index 514a10743..811c3bc6a 100644 --- a/docs/reference-license-delete.asciidoc +++ b/docs/reference-license-delete.asciidoc @@ -41,19 +41,29 @@ Deletes licensing information for the cluster ---- [discrete] -===== `LicenseDeleteRequest` +==== LicenseDeleteRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface LicenseDeleteRequest extends <> {
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `LicenseDeleteResponse` +==== LicenseDeleteResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type LicenseDeleteResponse = <>
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-license-get.asciidoc b/docs/reference-license-get.asciidoc index 9bc1eeef0..27316c090 100644 --- a/docs/reference-license-get.asciidoc +++ b/docs/reference-license-get.asciidoc @@ -41,23 +41,33 @@ Get license information. Returns information about your Elastic license, includi ---- [discrete] -===== `LicenseGetRequest` +==== LicenseGetRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface LicenseGetRequest extends <> {
   accept_enterprise?: boolean
   local?: boolean
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `LicenseGetResponse` +==== LicenseGetResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface LicenseGetResponse {
   license: LicenseGetLicenseInformation
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-license-get_basic_status.asciidoc b/docs/reference-license-get_basic_status.asciidoc index 82286cbab..0402d464b 100644 --- a/docs/reference-license-get_basic_status.asciidoc +++ b/docs/reference-license-get_basic_status.asciidoc @@ -41,21 +41,31 @@ Retrieves information about the status of the basic license. ---- [discrete] -===== `LicenseGetBasicStatusRequest` +==== LicenseGetBasicStatusRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface LicenseGetBasicStatusRequest extends <> {
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `LicenseGetBasicStatusResponse` +==== LicenseGetBasicStatusResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface LicenseGetBasicStatusResponse {
   eligible_to_start_basic: boolean
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-license-get_trial_status.asciidoc b/docs/reference-license-get_trial_status.asciidoc index f637fa144..49d7ec88c 100644 --- a/docs/reference-license-get_trial_status.asciidoc +++ b/docs/reference-license-get_trial_status.asciidoc @@ -41,21 +41,31 @@ Retrieves information about the status of the trial license. ---- [discrete] -===== `LicenseGetTrialStatusRequest` +==== LicenseGetTrialStatusRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface LicenseGetTrialStatusRequest extends <> {
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `LicenseGetTrialStatusResponse` +==== LicenseGetTrialStatusResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface LicenseGetTrialStatusResponse {
   eligible_to_start_trial: boolean
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-license-post.asciidoc b/docs/reference-license-post.asciidoc index 240dfe544..1ee7e4e38 100644 --- a/docs/reference-license-post.asciidoc +++ b/docs/reference-license-post.asciidoc @@ -41,26 +41,36 @@ Updates the license for the cluster. ---- [discrete] -===== `LicensePostRequest` +==== LicensePostRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface LicensePostRequest extends <> {
   acknowledge?: boolean
   license?: LicenseLicense
   licenses?: LicenseLicense[]
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `LicensePostResponse` +==== LicensePostResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface LicensePostResponse {
   acknowledge?: LicensePostAcknowledgement
   acknowledged: boolean
   license_status: LicenseLicenseStatus
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-license-post_start_basic.asciidoc b/docs/reference-license-post_start_basic.asciidoc index 571e98b57..0c0f2ae38 100644 --- a/docs/reference-license-post_start_basic.asciidoc +++ b/docs/reference-license-post_start_basic.asciidoc @@ -41,20 +41,27 @@ The start basic API enables you to initiate an indefinite basic license, which g ---- [discrete] -===== `LicensePostStartBasicRequest` +==== LicensePostStartBasicRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface LicensePostStartBasicRequest extends <> {
   acknowledge?: boolean
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `LicensePostStartBasicResponse` +==== LicensePostStartBasicResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface LicensePostStartBasicResponse {
   acknowledged: boolean
   basic_was_started: boolean
@@ -62,5 +69,8 @@ interface LicensePostStartBasicResponse {
   type?: LicenseLicenseType
   acknowledge?: Record
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-license-post_start_trial.asciidoc b/docs/reference-license-post_start_trial.asciidoc index e86871eb5..76cf37447 100644 --- a/docs/reference-license-post_start_trial.asciidoc +++ b/docs/reference-license-post_start_trial.asciidoc @@ -41,26 +41,36 @@ The start trial API enables you to start a 30-day trial, which gives access to a ---- [discrete] -===== `LicensePostStartTrialRequest` +==== LicensePostStartTrialRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface LicensePostStartTrialRequest extends <> {
   acknowledge?: boolean
   type_query_string?: string
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `LicensePostStartTrialResponse` +==== LicensePostStartTrialResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface LicensePostStartTrialResponse {
   acknowledged: boolean
   error_message?: string
   trial_was_started: boolean
   type?: LicenseLicenseType
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-logstash-delete_pipeline.asciidoc b/docs/reference-logstash-delete_pipeline.asciidoc index 700c74454..dd228c84e 100644 --- a/docs/reference-logstash-delete_pipeline.asciidoc +++ b/docs/reference-logstash-delete_pipeline.asciidoc @@ -41,20 +41,30 @@ Deletes a pipeline used for Logstash Central Management. ---- [discrete] -===== `LogstashDeletePipelineRequest` +==== LogstashDeletePipelineRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface LogstashDeletePipelineRequest extends <> {
   id: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `LogstashDeletePipelineResponse` +==== LogstashDeletePipelineResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type LogstashDeletePipelineResponse = boolean
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-logstash-get_pipeline.asciidoc b/docs/reference-logstash-get_pipeline.asciidoc index 70beea717..d4c90b087 100644 --- a/docs/reference-logstash-get_pipeline.asciidoc +++ b/docs/reference-logstash-get_pipeline.asciidoc @@ -41,20 +41,30 @@ Retrieves pipelines used for Logstash Central Management. ---- [discrete] -===== `LogstashGetPipelineRequest` +==== LogstashGetPipelineRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface LogstashGetPipelineRequest extends <> {
   id?: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `LogstashGetPipelineResponse` +==== LogstashGetPipelineResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type LogstashGetPipelineResponse = Record<<>, LogstashPipeline>
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-logstash-put_pipeline.asciidoc b/docs/reference-logstash-put_pipeline.asciidoc index 0f60773d7..e5d892813 100644 --- a/docs/reference-logstash-put_pipeline.asciidoc +++ b/docs/reference-logstash-put_pipeline.asciidoc @@ -41,21 +41,31 @@ Creates or updates a pipeline used for Logstash Central Management. ---- [discrete] -===== `LogstashPutPipelineRequest` +==== LogstashPutPipelineRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface LogstashPutPipelineRequest extends <> {
   id: <>
   pipeline?: LogstashPipeline
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `LogstashPutPipelineResponse` +==== LogstashPutPipelineResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type LogstashPutPipelineResponse = boolean
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-main-index.asciidoc b/docs/reference-main-index.asciidoc index ee010859c..e82300820 100644 --- a/docs/reference-main-index.asciidoc +++ b/docs/reference-main-index.asciidoc @@ -1,5 +1,5 @@ [[reference-main-index]] -== API reference +== API Reference include::reference-shared-types.asciidoc[] include::reference-async_search-delete.asciidoc[] @@ -503,502 +503,502 @@ include::reference-xpack-info.asciidoc[] include::reference-xpack-usage.asciidoc[] -* asyncSearch.delete: <> -* asyncSearch.get: <> -* asyncSearch.status: <> -* asyncSearch.submit: <> -* autoscaling.deleteAutoscalingPolicy: <> -* autoscaling.getAutoscalingCapacity: <> -* autoscaling.getAutoscalingPolicy: <> -* autoscaling.putAutoscalingPolicy: <> -* bulk: <> -* cat.aliases: <> -* cat.allocation: <> -* cat.componentTemplates: <> -* cat.count: <> -* cat.fielddata: <> -* cat.health: <> -* cat.help: <> -* cat.indices: <> -* cat.master: <> -* cat.mlDataFrameAnalytics: <> -* cat.mlDatafeeds: <> -* cat.mlJobs: <> -* cat.mlTrainedModels: <> -* cat.nodeattrs: <> -* cat.nodes: <> -* cat.pendingTasks: <> -* cat.plugins: <> -* cat.recovery: <> -* cat.repositories: <> -* cat.segments: <> -* cat.shards: <> -* cat.snapshots: <> -* cat.tasks: <> -* cat.templates: <> -* cat.threadPool: <> -* cat.transforms: <> -* ccr.deleteAutoFollowPattern: <> -* ccr.follow: <> -* ccr.followInfo: <> -* ccr.followStats: <> -* ccr.forgetFollower: <> -* ccr.getAutoFollowPattern: <> -* ccr.pauseAutoFollowPattern: <> -* ccr.pauseFollow: <> -* ccr.putAutoFollowPattern: <> -* ccr.resumeAutoFollowPattern: <> -* ccr.resumeFollow: <> -* ccr.stats: <> -* ccr.unfollow: <> -* clearScroll: <> -* closePointInTime: <> -* cluster.allocationExplain: <> -* cluster.deleteComponentTemplate: <> -* cluster.deleteVotingConfigExclusions: <> -* cluster.existsComponentTemplate: <> -* cluster.getComponentTemplate: <> -* cluster.getSettings: <> -* cluster.health: <> -* cluster.info: <> -* cluster.pendingTasks: <> -* cluster.postVotingConfigExclusions: <> -* cluster.putComponentTemplate: <> -* cluster.putSettings: <> -* cluster.remoteInfo: <> -* cluster.reroute: <> -* cluster.state: <> -* cluster.stats: <> -* connector.checkIn: <> -* connector.delete: <> -* connector.get: <> -* connector.list: <> -* connector.post: <> -* connector.put: <> -* connector.syncJobCancel: <> -* connector.syncJobCheckIn: <> -* connector.syncJobClaim: <> -* connector.syncJobDelete: <> -* connector.syncJobError: <> -* connector.syncJobGet: <> -* connector.syncJobList: <> -* connector.syncJobPost: <> -* connector.syncJobUpdateStats: <> -* connector.updateActiveFiltering: <> -* connector.updateApiKeyId: <> -* connector.updateConfiguration: <> -* connector.updateError: <> -* connector.updateFeatures: <> -* connector.updateFiltering: <> -* connector.updateFilteringValidation: <> -* connector.updateIndexName: <> -* connector.updateName: <> -* connector.updateNative: <> -* connector.updatePipeline: <> -* connector.updateScheduling: <> -* connector.updateServiceType: <> -* connector.updateStatus: <> -* count: <> -* create: <> -* danglingIndices.deleteDanglingIndex: <> -* danglingIndices.importDanglingIndex: <> -* danglingIndices.listDanglingIndices: <> -* delete: <> -* deleteByQuery: <> -* deleteByQueryRethrottle: <> -* deleteScript: <> -* enrich.deletePolicy: <> -* enrich.executePolicy: <> -* enrich.getPolicy: <> -* enrich.putPolicy: <> -* enrich.stats: <> -* eql.delete: <> -* eql.get: <> -* eql.getStatus: <> -* eql.search: <> -* esql.asyncQuery: <> -* esql.asyncQueryGet: <> -* esql.query: <> -* exists: <> -* existsSource: <> -* explain: <> -* features.getFeatures: <> -* features.resetFeatures: <> -* fieldCaps: <> -* fleet.globalCheckpoints: <> -* fleet.msearch: <> -* fleet.search: <> -* get: <> -* getScript: <> -* getScriptContext: <> -* getScriptLanguages: <> -* getSource: <> -* graph.explore: <> -* healthReport: <> -* ilm.deleteLifecycle: <> -* ilm.explainLifecycle: <> -* ilm.getLifecycle: <> -* ilm.getStatus: <> -* ilm.migrateToDataTiers: <> -* ilm.moveToStep: <> -* ilm.putLifecycle: <> -* ilm.removePolicy: <> -* ilm.retry: <> -* ilm.start: <> -* ilm.stop: <> -* index: <> -* indices.addBlock: <> -* indices.analyze: <> -* indices.clearCache: <> -* indices.clone: <> -* indices.close: <> -* indices.create: <> -* indices.createDataStream: <> -* indices.dataStreamsStats: <> -* indices.delete: <> -* indices.deleteAlias: <> -* indices.deleteDataLifecycle: <> -* indices.deleteDataStream: <> -* indices.deleteIndexTemplate: <> -* indices.deleteTemplate: <> -* indices.diskUsage: <> -* indices.downsample: <> -* indices.exists: <> -* indices.existsAlias: <> -* indices.existsIndexTemplate: <> -* indices.existsTemplate: <> -* indices.explainDataLifecycle: <> -* indices.fieldUsageStats: <> -* indices.flush: <> -* indices.forcemerge: <> -* indices.get: <> -* indices.getAlias: <> -* indices.getDataLifecycle: <> -* indices.getDataStream: <> -* indices.getFieldMapping: <> -* indices.getIndexTemplate: <> -* indices.getMapping: <> -* indices.getSettings: <> -* indices.getTemplate: <> -* indices.migrateToDataStream: <> -* indices.modifyDataStream: <> -* indices.open: <> -* indices.promoteDataStream: <> -* indices.putAlias: <> -* indices.putDataLifecycle: <> -* indices.putIndexTemplate: <> -* indices.putMapping: <> -* indices.putSettings: <> -* indices.putTemplate: <> -* indices.recovery: <> -* indices.refresh: <> -* indices.reloadSearchAnalyzers: <> -* indices.resolveCluster: <> -* indices.resolveIndex: <> -* indices.rollover: <> -* indices.segments: <> -* indices.shardStores: <> -* indices.shrink: <> -* indices.simulateIndexTemplate: <> -* indices.simulateTemplate: <> -* indices.split: <> -* indices.stats: <> -* indices.unfreeze: <> -* indices.updateAliases: <> -* indices.validateQuery: <> -* inference.delete: <> -* inference.get: <> -* inference.inference: <> -* inference.put: <> -* inference.streamInference: <> -* info: <> -* ingest.deleteGeoipDatabase: <> -* ingest.deletePipeline: <> -* ingest.geoIpStats: <> -* ingest.getGeoipDatabase: <> -* ingest.getPipeline: <> -* ingest.processorGrok: <> -* ingest.putGeoipDatabase: <> -* ingest.putPipeline: <> -* ingest.simulate: <> -* knnSearch: <> -* license.delete: <> -* license.get: <> -* license.getBasicStatus: <> -* license.getTrialStatus: <> -* license.post: <> -* license.postStartBasic: <> -* license.postStartTrial: <> -* logstash.deletePipeline: <> -* logstash.getPipeline: <> -* logstash.putPipeline: <> -* mget: <> -* migration.deprecations: <> -* migration.getFeatureUpgradeStatus: <> -* migration.postFeatureUpgrade: <> -* ml.clearTrainedModelDeploymentCache: <> -* ml.closeJob: <> -* ml.deleteCalendar: <> -* ml.deleteCalendarEvent: <> -* ml.deleteCalendarJob: <> -* ml.deleteDataFrameAnalytics: <> -* ml.deleteDatafeed: <> -* ml.deleteExpiredData: <> -* ml.deleteFilter: <> -* ml.deleteForecast: <> -* ml.deleteJob: <> -* ml.deleteModelSnapshot: <> -* ml.deleteTrainedModel: <> -* ml.deleteTrainedModelAlias: <> -* ml.estimateModelMemory: <> -* ml.evaluateDataFrame: <> -* ml.explainDataFrameAnalytics: <> -* ml.flushJob: <> -* ml.forecast: <> -* ml.getBuckets: <> -* ml.getCalendarEvents: <> -* ml.getCalendars: <> -* ml.getCategories: <> -* ml.getDataFrameAnalytics: <> -* ml.getDataFrameAnalyticsStats: <> -* ml.getDatafeedStats: <> -* ml.getDatafeeds: <> -* ml.getFilters: <> -* ml.getInfluencers: <> -* ml.getJobStats: <> -* ml.getJobs: <> -* ml.getMemoryStats: <> -* ml.getModelSnapshotUpgradeStats: <> -* ml.getModelSnapshots: <> -* ml.getOverallBuckets: <> -* ml.getRecords: <> -* ml.getTrainedModels: <> -* ml.getTrainedModelsStats: <> -* ml.inferTrainedModel: <> -* ml.info: <> -* ml.openJob: <> -* ml.postCalendarEvents: <> -* ml.postData: <> -* ml.previewDataFrameAnalytics: <> -* ml.previewDatafeed: <> -* ml.putCalendar: <> -* ml.putCalendarJob: <> -* ml.putDataFrameAnalytics: <> -* ml.putDatafeed: <> -* ml.putFilter: <> -* ml.putJob: <> -* ml.putTrainedModel: <> -* ml.putTrainedModelAlias: <> -* ml.putTrainedModelDefinitionPart: <> -* ml.putTrainedModelVocabulary: <> -* ml.resetJob: <> -* ml.revertModelSnapshot: <> -* ml.setUpgradeMode: <> -* ml.startDataFrameAnalytics: <> -* ml.startDatafeed: <> -* ml.startTrainedModelDeployment: <> -* ml.stopDataFrameAnalytics: <> -* ml.stopDatafeed: <> -* ml.stopTrainedModelDeployment: <> -* ml.updateDataFrameAnalytics: <> -* ml.updateDatafeed: <> -* ml.updateFilter: <> -* ml.updateJob: <> -* ml.updateModelSnapshot: <> -* ml.updateTrainedModelDeployment: <> -* ml.upgradeJobSnapshot: <> -* monitoring.bulk: <> -* msearch: <> -* msearchTemplate: <> -* mtermvectors: <> -* nodes.clearRepositoriesMeteringArchive: <> -* nodes.getRepositoriesMeteringInfo: <> -* nodes.hotThreads: <> -* nodes.info: <> -* nodes.reloadSecureSettings: <> -* nodes.stats: <> -* nodes.usage: <> -* openPointInTime: <> -* ping: <> -* putScript: <> -* queryRules.deleteRule: <> -* queryRules.deleteRuleset: <> -* queryRules.getRule: <> -* queryRules.getRuleset: <> -* queryRules.listRulesets: <> -* queryRules.putRule: <> -* queryRules.putRuleset: <> -* queryRules.test: <> -* rankEval: <> -* reindex: <> -* reindexRethrottle: <> -* renderSearchTemplate: <> -* rollup.deleteJob: <> -* rollup.getJobs: <> -* rollup.getRollupCaps: <> -* rollup.getRollupIndexCaps: <> -* rollup.putJob: <> -* rollup.rollupSearch: <> -* rollup.startJob: <> -* rollup.stopJob: <> -* scriptsPainlessExecute: <> -* scroll: <> -* search: <> -* searchApplication.delete: <> -* searchApplication.deleteBehavioralAnalytics: <> -* searchApplication.get: <> -* searchApplication.getBehavioralAnalytics: <> -* searchApplication.list: <> -* searchApplication.postBehavioralAnalyticsEvent: <> -* searchApplication.put: <> -* searchApplication.putBehavioralAnalytics: <> -* searchApplication.renderQuery: <> -* searchApplication.search: <> -* searchMvt: <> -* searchShards: <> -* searchTemplate: <> -* searchableSnapshots.cacheStats: <> -* searchableSnapshots.clearCache: <> -* searchableSnapshots.mount: <> -* searchableSnapshots.stats: <> -* security.activateUserProfile: <> -* security.authenticate: <> -* security.bulkDeleteRole: <> -* security.bulkPutRole: <> -* security.bulkUpdateApiKeys: <> -* security.changePassword: <> -* security.clearApiKeyCache: <> -* security.clearCachedPrivileges: <> -* security.clearCachedRealms: <> -* security.clearCachedRoles: <> -* security.clearCachedServiceTokens: <> -* security.createApiKey: <> -* security.createCrossClusterApiKey: <> -* security.createServiceToken: <> -* security.deletePrivileges: <> -* security.deleteRole: <> -* security.deleteRoleMapping: <> -* security.deleteServiceToken: <> -* security.deleteUser: <> -* security.disableUser: <> -* security.disableUserProfile: <> -* security.enableUser: <> -* security.enableUserProfile: <> -* security.enrollKibana: <> -* security.enrollNode: <> -* security.getApiKey: <> -* security.getBuiltinPrivileges: <> -* security.getPrivileges: <> -* security.getRole: <> -* security.getRoleMapping: <> -* security.getServiceAccounts: <> -* security.getServiceCredentials: <> -* security.getSettings: <> -* security.getToken: <> -* security.getUser: <> -* security.getUserPrivileges: <> -* security.getUserProfile: <> -* security.grantApiKey: <> -* security.hasPrivileges: <> -* security.hasPrivilegesUserProfile: <> -* security.invalidateApiKey: <> -* security.invalidateToken: <> -* security.oidcAuthenticate: <> -* security.oidcLogout: <> -* security.oidcPrepareAuthentication: <> -* security.putPrivileges: <> -* security.putRole: <> -* security.putRoleMapping: <> -* security.putUser: <> -* security.queryApiKeys: <> -* security.queryRole: <> -* security.queryUser: <> -* security.samlAuthenticate: <> -* security.samlCompleteLogout: <> -* security.samlInvalidate: <> -* security.samlLogout: <> -* security.samlPrepareAuthentication: <> -* security.samlServiceProviderMetadata: <> -* security.suggestUserProfiles: <> -* security.updateApiKey: <> -* security.updateCrossClusterApiKey: <> -* security.updateSettings: <> -* security.updateUserProfileData: <> -* shutdown.deleteNode: <> -* shutdown.getNode: <> -* shutdown.putNode: <> -* simulate.ingest: <> -* slm.deleteLifecycle: <> -* slm.executeLifecycle: <> -* slm.executeRetention: <> -* slm.getLifecycle: <> -* slm.getStats: <> -* slm.getStatus: <> -* slm.putLifecycle: <> -* slm.start: <> -* slm.stop: <> -* snapshot.cleanupRepository: <> -* snapshot.clone: <> -* snapshot.create: <> -* snapshot.createRepository: <> -* snapshot.delete: <> -* snapshot.deleteRepository: <> -* snapshot.get: <> -* snapshot.getRepository: <> -* snapshot.repositoryAnalyze: <> -* snapshot.restore: <> -* snapshot.status: <> -* snapshot.verifyRepository: <> -* sql.clearCursor: <> -* sql.deleteAsync: <> -* sql.getAsync: <> -* sql.getAsyncStatus: <> -* sql.query: <> -* sql.translate: <> -* ssl.certificates: <> -* synonyms.deleteSynonym: <> -* synonyms.deleteSynonymRule: <> -* synonyms.getSynonym: <> -* synonyms.getSynonymRule: <> -* synonyms.getSynonymsSets: <> -* synonyms.putSynonym: <> -* synonyms.putSynonymRule: <> -* tasks.cancel: <> -* tasks.get: <> -* tasks.list: <> -* termsEnum: <> -* termvectors: <> -* textStructure.findFieldStructure: <> -* textStructure.findMessageStructure: <> -* textStructure.findStructure: <> -* textStructure.testGrokPattern: <> -* transform.deleteTransform: <> -* transform.getNodeStats: <> -* transform.getTransform: <> -* transform.getTransformStats: <> -* transform.previewTransform: <> -* transform.putTransform: <> -* transform.resetTransform: <> -* transform.scheduleNowTransform: <> -* transform.startTransform: <> -* transform.stopTransform: <> -* transform.updateTransform: <> -* transform.upgradeTransforms: <> -* update: <> -* updateByQuery: <> -* updateByQueryRethrottle: <> -* watcher.ackWatch: <> -* watcher.activateWatch: <> -* watcher.deactivateWatch: <> -* watcher.deleteWatch: <> -* watcher.executeWatch: <> -* watcher.getSettings: <> -* watcher.getWatch: <> -* watcher.putWatch: <> -* watcher.queryWatches: <> -* watcher.start: <> -* watcher.stats: <> -* watcher.stop: <> -* watcher.updateSettings: <> -* xpack.info: <> -* xpack.usage: <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> diff --git a/docs/reference-mget.asciidoc b/docs/reference-mget.asciidoc index a13dbe74c..434502208 100644 --- a/docs/reference-mget.asciidoc +++ b/docs/reference-mget.asciidoc @@ -41,10 +41,12 @@ Get multiple documents. Get multiple JSON documents by ID from one or more indic ---- [discrete] -===== `MgetRequest` +==== MgetRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface MgetRequest extends <> {
   index?: <>
   force_synthetic_source?: boolean
@@ -59,15 +61,23 @@ interface MgetRequest extends <> {
   docs?: MgetOperation[]
   ids?: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `MgetResponse` +==== MgetResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface MgetResponse {
   docs: MgetResponseItem[]
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-migration-deprecations.asciidoc b/docs/reference-migration-deprecations.asciidoc index 87484c13f..59a2c2360 100644 --- a/docs/reference-migration-deprecations.asciidoc +++ b/docs/reference-migration-deprecations.asciidoc @@ -41,25 +41,35 @@ Retrieves information about different cluster, node, and index level settings th ---- [discrete] -===== `MigrationDeprecationsRequest` +==== MigrationDeprecationsRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface MigrationDeprecationsRequest extends <> {
   index?: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `MigrationDeprecationsResponse` +==== MigrationDeprecationsResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface MigrationDeprecationsResponse {
   cluster_settings: MigrationDeprecationsDeprecation[]
   index_settings: Record
   node_settings: MigrationDeprecationsDeprecation[]
   ml_settings: MigrationDeprecationsDeprecation[]
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-migration-get_feature_upgrade_status.asciidoc b/docs/reference-migration-get_feature_upgrade_status.asciidoc index 0a65e594c..3f0eca5d1 100644 --- a/docs/reference-migration-get_feature_upgrade_status.asciidoc +++ b/docs/reference-migration-get_feature_upgrade_status.asciidoc @@ -41,22 +41,32 @@ Find out whether system features need to be upgraded or not ---- [discrete] -===== `MigrationGetFeatureUpgradeStatusRequest` +==== MigrationGetFeatureUpgradeStatusRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface MigrationGetFeatureUpgradeStatusRequest extends <> {
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `MigrationGetFeatureUpgradeStatusResponse` +==== MigrationGetFeatureUpgradeStatusResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface MigrationGetFeatureUpgradeStatusResponse {
   features: MigrationGetFeatureUpgradeStatusMigrationFeature[]
   migration_status: MigrationGetFeatureUpgradeStatusMigrationStatus
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-migration-post_feature_upgrade.asciidoc b/docs/reference-migration-post_feature_upgrade.asciidoc index d87824965..d67ffb753 100644 --- a/docs/reference-migration-post_feature_upgrade.asciidoc +++ b/docs/reference-migration-post_feature_upgrade.asciidoc @@ -41,22 +41,32 @@ Begin upgrades for system features ---- [discrete] -===== `MigrationPostFeatureUpgradeRequest` +==== MigrationPostFeatureUpgradeRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface MigrationPostFeatureUpgradeRequest extends <> {
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `MigrationPostFeatureUpgradeResponse` +==== MigrationPostFeatureUpgradeResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface MigrationPostFeatureUpgradeResponse {
   accepted: boolean
   features: MigrationPostFeatureUpgradeMigrationFeature[]
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-ml-clear_trained_model_deployment_cache.asciidoc b/docs/reference-ml-clear_trained_model_deployment_cache.asciidoc index f7bd67dd0..53854eae4 100644 --- a/docs/reference-ml-clear_trained_model_deployment_cache.asciidoc +++ b/docs/reference-ml-clear_trained_model_deployment_cache.asciidoc @@ -41,22 +41,32 @@ Clear trained model deployment cache. Cache will be cleared on all nodes where t ---- [discrete] -===== `MlClearTrainedModelDeploymentCacheRequest` +==== MlClearTrainedModelDeploymentCacheRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlClearTrainedModelDeploymentCacheRequest extends <> {
   model_id: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `MlClearTrainedModelDeploymentCacheResponse` +==== MlClearTrainedModelDeploymentCacheResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlClearTrainedModelDeploymentCacheResponse {
   cleared: boolean
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-ml-close_job.asciidoc b/docs/reference-ml-close_job.asciidoc index b76e076f4..438ce9082 100644 --- a/docs/reference-ml-close_job.asciidoc +++ b/docs/reference-ml-close_job.asciidoc @@ -41,25 +41,35 @@ Close anomaly detection jobs. A job can be opened and closed multiple times thro ---- [discrete] -===== `MlCloseJobRequest` +==== MlCloseJobRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlCloseJobRequest extends <> {
   job_id: <>
   allow_no_match?: boolean
   force?: boolean
   timeout?: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `MlCloseJobResponse` +==== MlCloseJobResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlCloseJobResponse {
   closed: boolean
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-ml-delete_calendar.asciidoc b/docs/reference-ml-delete_calendar.asciidoc index 3231d4339..d7f6aebc2 100644 --- a/docs/reference-ml-delete_calendar.asciidoc +++ b/docs/reference-ml-delete_calendar.asciidoc @@ -41,20 +41,30 @@ Delete a calendar. Removes all scheduled events from a calendar, then deletes it ---- [discrete] -===== `MlDeleteCalendarRequest` +==== MlDeleteCalendarRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlDeleteCalendarRequest extends <> {
   calendar_id: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `MlDeleteCalendarResponse` +==== MlDeleteCalendarResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type MlDeleteCalendarResponse = <>
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-ml-delete_calendar_event.asciidoc b/docs/reference-ml-delete_calendar_event.asciidoc index 7bb2095e9..838122288 100644 --- a/docs/reference-ml-delete_calendar_event.asciidoc +++ b/docs/reference-ml-delete_calendar_event.asciidoc @@ -41,21 +41,31 @@ Delete events from a calendar. ---- [discrete] -===== `MlDeleteCalendarEventRequest` +==== MlDeleteCalendarEventRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlDeleteCalendarEventRequest extends <> {
   calendar_id: <>
   event_id: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `MlDeleteCalendarEventResponse` +==== MlDeleteCalendarEventResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type MlDeleteCalendarEventResponse = <>
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-ml-delete_calendar_job.asciidoc b/docs/reference-ml-delete_calendar_job.asciidoc index fa20dcac6..79fe37e4a 100644 --- a/docs/reference-ml-delete_calendar_job.asciidoc +++ b/docs/reference-ml-delete_calendar_job.asciidoc @@ -41,25 +41,35 @@ Delete anomaly jobs from a calendar. ---- [discrete] -===== `MlDeleteCalendarJobRequest` +==== MlDeleteCalendarJobRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlDeleteCalendarJobRequest extends <> {
   calendar_id: <>
   job_id: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `MlDeleteCalendarJobResponse` +==== MlDeleteCalendarJobResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlDeleteCalendarJobResponse {
   calendar_id: <>
   description?: string
   job_ids: <>
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-ml-delete_data_frame_analytics.asciidoc b/docs/reference-ml-delete_data_frame_analytics.asciidoc index 5d99e98e7..63f60a3bc 100644 --- a/docs/reference-ml-delete_data_frame_analytics.asciidoc +++ b/docs/reference-ml-delete_data_frame_analytics.asciidoc @@ -41,22 +41,32 @@ Delete a data frame analytics job. ---- [discrete] -===== `MlDeleteDataFrameAnalyticsRequest` +==== MlDeleteDataFrameAnalyticsRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlDeleteDataFrameAnalyticsRequest extends <> {
   id: <>
   force?: boolean
   timeout?: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `MlDeleteDataFrameAnalyticsResponse` +==== MlDeleteDataFrameAnalyticsResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type MlDeleteDataFrameAnalyticsResponse = <>
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-ml-delete_datafeed.asciidoc b/docs/reference-ml-delete_datafeed.asciidoc index 5abbadb88..9f63453e0 100644 --- a/docs/reference-ml-delete_datafeed.asciidoc +++ b/docs/reference-ml-delete_datafeed.asciidoc @@ -41,21 +41,31 @@ Delete a datafeed. ---- [discrete] -===== `MlDeleteDatafeedRequest` +==== MlDeleteDatafeedRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlDeleteDatafeedRequest extends <> {
   datafeed_id: <>
   force?: boolean
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `MlDeleteDatafeedResponse` +==== MlDeleteDatafeedResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type MlDeleteDatafeedResponse = <>
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-ml-delete_expired_data.asciidoc b/docs/reference-ml-delete_expired_data.asciidoc index 35d8dcb10..18c56c428 100644 --- a/docs/reference-ml-delete_expired_data.asciidoc +++ b/docs/reference-ml-delete_expired_data.asciidoc @@ -41,24 +41,34 @@ Delete expired ML data. Deletes all job results, model snapshots and forecast da ---- [discrete] -===== `MlDeleteExpiredDataRequest` +==== MlDeleteExpiredDataRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlDeleteExpiredDataRequest extends <> {
   job_id?: <>
-  requests_per_second?: <>
+  requests_per_second?: number
   timeout?: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `MlDeleteExpiredDataResponse` +==== MlDeleteExpiredDataResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlDeleteExpiredDataResponse {
   deleted: boolean
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-ml-delete_filter.asciidoc b/docs/reference-ml-delete_filter.asciidoc index f6039ad19..baeb62e8a 100644 --- a/docs/reference-ml-delete_filter.asciidoc +++ b/docs/reference-ml-delete_filter.asciidoc @@ -41,20 +41,30 @@ Delete a filter. If an anomaly detection job references the filter, you cannot d ---- [discrete] -===== `MlDeleteFilterRequest` +==== MlDeleteFilterRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlDeleteFilterRequest extends <> {
   filter_id: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `MlDeleteFilterResponse` +==== MlDeleteFilterResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type MlDeleteFilterResponse = <>
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-ml-delete_forecast.asciidoc b/docs/reference-ml-delete_forecast.asciidoc index 6fc36217b..ffa50a6b5 100644 --- a/docs/reference-ml-delete_forecast.asciidoc +++ b/docs/reference-ml-delete_forecast.asciidoc @@ -41,23 +41,33 @@ Delete forecasts from a job. By default, forecasts are retained for 14 days. You ---- [discrete] -===== `MlDeleteForecastRequest` +==== MlDeleteForecastRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlDeleteForecastRequest extends <> {
   job_id: <>
   forecast_id?: <>
   allow_no_forecasts?: boolean
   timeout?: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `MlDeleteForecastResponse` +==== MlDeleteForecastResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type MlDeleteForecastResponse = <>
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-ml-delete_job.asciidoc b/docs/reference-ml-delete_job.asciidoc index 91d35f79e..922d0ab07 100644 --- a/docs/reference-ml-delete_job.asciidoc +++ b/docs/reference-ml-delete_job.asciidoc @@ -41,23 +41,33 @@ Delete an anomaly detection job. All job configuration, model state and results ---- [discrete] -===== `MlDeleteJobRequest` +==== MlDeleteJobRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlDeleteJobRequest extends <> {
   job_id: <>
   force?: boolean
   delete_user_annotations?: boolean
   wait_for_completion?: boolean
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `MlDeleteJobResponse` +==== MlDeleteJobResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type MlDeleteJobResponse = <>
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-ml-delete_model_snapshot.asciidoc b/docs/reference-ml-delete_model_snapshot.asciidoc index 5dfe3c275..1dc1119f3 100644 --- a/docs/reference-ml-delete_model_snapshot.asciidoc +++ b/docs/reference-ml-delete_model_snapshot.asciidoc @@ -41,21 +41,31 @@ Delete a model snapshot. You cannot delete the active model snapshot. To delete ---- [discrete] -===== `MlDeleteModelSnapshotRequest` +==== MlDeleteModelSnapshotRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlDeleteModelSnapshotRequest extends <> {
   job_id: <>
   snapshot_id: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `MlDeleteModelSnapshotResponse` +==== MlDeleteModelSnapshotResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type MlDeleteModelSnapshotResponse = <>
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-ml-delete_trained_model.asciidoc b/docs/reference-ml-delete_trained_model.asciidoc index f4f85448d..f613c48f9 100644 --- a/docs/reference-ml-delete_trained_model.asciidoc +++ b/docs/reference-ml-delete_trained_model.asciidoc @@ -41,21 +41,31 @@ Delete an unreferenced trained model. The request deletes a trained inference mo ---- [discrete] -===== `MlDeleteTrainedModelRequest` +==== MlDeleteTrainedModelRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlDeleteTrainedModelRequest extends <> {
   model_id: <>
   force?: boolean
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `MlDeleteTrainedModelResponse` +==== MlDeleteTrainedModelResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type MlDeleteTrainedModelResponse = <>
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-ml-delete_trained_model_alias.asciidoc b/docs/reference-ml-delete_trained_model_alias.asciidoc index ff03cfd03..a1468695f 100644 --- a/docs/reference-ml-delete_trained_model_alias.asciidoc +++ b/docs/reference-ml-delete_trained_model_alias.asciidoc @@ -41,21 +41,31 @@ Delete a trained model alias. This API deletes an existing model alias that refe ---- [discrete] -===== `MlDeleteTrainedModelAliasRequest` +==== MlDeleteTrainedModelAliasRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlDeleteTrainedModelAliasRequest extends <> {
   model_alias: <>
   model_id: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `MlDeleteTrainedModelAliasResponse` +==== MlDeleteTrainedModelAliasResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type MlDeleteTrainedModelAliasResponse = <>
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-ml-estimate_model_memory.asciidoc b/docs/reference-ml-estimate_model_memory.asciidoc index 4421d3c10..52980fcd4 100644 --- a/docs/reference-ml-estimate_model_memory.asciidoc +++ b/docs/reference-ml-estimate_model_memory.asciidoc @@ -41,24 +41,34 @@ Estimate job model memory usage. Makes an estimation of the memory usage for an ---- [discrete] -===== `MlEstimateModelMemoryRequest` +==== MlEstimateModelMemoryRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlEstimateModelMemoryRequest extends <> {
   analysis_config?: MlAnalysisConfig
-  max_bucket_cardinality?: Record<<>, <>>
-  overall_cardinality?: Record<<>, <>>
+  max_bucket_cardinality?: Record<<>, number>
+  overall_cardinality?: Record<<>, number>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `MlEstimateModelMemoryResponse` +==== MlEstimateModelMemoryResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlEstimateModelMemoryResponse {
   model_memory_estimate: string
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-ml-evaluate_data_frame.asciidoc b/docs/reference-ml-evaluate_data_frame.asciidoc index 52ceb0738..f3412c50c 100644 --- a/docs/reference-ml-evaluate_data_frame.asciidoc +++ b/docs/reference-ml-evaluate_data_frame.asciidoc @@ -41,26 +41,36 @@ Evaluate data frame analytics. The API packages together commonly used evaluatio ---- [discrete] -===== `MlEvaluateDataFrameRequest` +==== MlEvaluateDataFrameRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlEvaluateDataFrameRequest extends <> {
   evaluation: MlDataframeEvaluationContainer
   index: <>
   query?: QueryDslQueryContainer
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `MlEvaluateDataFrameResponse` +==== MlEvaluateDataFrameResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlEvaluateDataFrameResponse {
   classification?: MlEvaluateDataFrameDataframeClassificationSummary
   outlier_detection?: MlEvaluateDataFrameDataframeOutlierDetectionSummary
   regression?: MlEvaluateDataFrameDataframeRegressionSummary
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-ml-explain_data_frame_analytics.asciidoc b/docs/reference-ml-explain_data_frame_analytics.asciidoc index 2dc6a346c..0e920934e 100644 --- a/docs/reference-ml-explain_data_frame_analytics.asciidoc +++ b/docs/reference-ml-explain_data_frame_analytics.asciidoc @@ -41,10 +41,12 @@ Explain data frame analytics config. This API provides explanations for a data f ---- [discrete] -===== `MlExplainDataFrameAnalyticsRequest` +==== MlExplainDataFrameAnalyticsRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlExplainDataFrameAnalyticsRequest extends <> {
   id?: <>
   source?: MlDataframeAnalyticsSource
@@ -52,20 +54,28 @@ interface MlExplainDataFrameAnalyticsRequest extends <> {
   analysis?: MlDataframeAnalysisContainer
   description?: string
   model_memory_limit?: string
-  max_num_threads?: <>
+  max_num_threads?: number
   analyzed_fields?: MlDataframeAnalysisAnalyzedFields | string[]
   allow_lazy_start?: boolean
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `MlExplainDataFrameAnalyticsResponse` +==== MlExplainDataFrameAnalyticsResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlExplainDataFrameAnalyticsResponse {
   field_selection: MlDataframeAnalyticsFieldSelection[]
   memory_estimation: MlDataframeAnalyticsMemoryEstimation
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-ml-flush_job.asciidoc b/docs/reference-ml-flush_job.asciidoc index ae3d460ef..643e642e0 100644 --- a/docs/reference-ml-flush_job.asciidoc +++ b/docs/reference-ml-flush_job.asciidoc @@ -41,10 +41,12 @@ Force buffered data to be processed. The flush jobs API is only applicable when ---- [discrete] -===== `MlFlushJobRequest` +==== MlFlushJobRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlFlushJobRequest extends <> {
   job_id: <>
   advance_time?: <>
@@ -53,16 +55,24 @@ interface MlFlushJobRequest extends <> {
   skip_time?: <>
   start?: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `MlFlushJobResponse` +==== MlFlushJobResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlFlushJobResponse {
   flushed: boolean
-  last_finalized_bucket_end?: <>
+  last_finalized_bucket_end?: number
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-ml-forecast.asciidoc b/docs/reference-ml-forecast.asciidoc index 51ad314c5..1b8dca64b 100644 --- a/docs/reference-ml-forecast.asciidoc +++ b/docs/reference-ml-forecast.asciidoc @@ -41,26 +41,36 @@ Predict future behavior of a time series. Forecasts are not supported for jobs t ---- [discrete] -===== `MlForecastRequest` +==== MlForecastRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlForecastRequest extends <> {
   job_id: <>
   duration?: <>
   expires_in?: <>
   max_model_memory?: string
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `MlForecastResponse` +==== MlForecastResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlForecastResponse {
   acknowledged: boolean
   forecast_id: <>
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-ml-get_buckets.asciidoc b/docs/reference-ml-get_buckets.asciidoc index 418d4a12f..44c4bc5e4 100644 --- a/docs/reference-ml-get_buckets.asciidoc +++ b/docs/reference-ml-get_buckets.asciidoc @@ -41,16 +41,18 @@ Get anomaly detection job results for buckets. The API presents a chronological ---- [discrete] -===== `MlGetBucketsRequest` +==== MlGetBucketsRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlGetBucketsRequest extends <> {
   job_id: <>
   timestamp?: <>
-  from?: <>
-  size?: <>
-  anomaly_score?: <>
+  from?: number
+  size?: number
+  anomaly_score?: number
   desc?: boolean
   end?: <>
   exclude_interim?: boolean
@@ -59,16 +61,24 @@ interface MlGetBucketsRequest extends <> {
   sort?: <>
   start?: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `MlGetBucketsResponse` +==== MlGetBucketsResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlGetBucketsResponse {
   buckets: MlBucketSummary[]
-  count: <>
+  count: number
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-ml-get_calendar_events.asciidoc b/docs/reference-ml-get_calendar_events.asciidoc index afec2b503..a8423fcaa 100644 --- a/docs/reference-ml-get_calendar_events.asciidoc +++ b/docs/reference-ml-get_calendar_events.asciidoc @@ -41,28 +41,38 @@ Get info about events in calendars. ---- [discrete] -===== `MlGetCalendarEventsRequest` +==== MlGetCalendarEventsRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlGetCalendarEventsRequest extends <> {
   calendar_id: <>
   end?: <>
-  from?: <>
+  from?: number
   job_id?: <>
-  size?: <>
+  size?: number
   start?: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `MlGetCalendarEventsResponse` +==== MlGetCalendarEventsResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlGetCalendarEventsResponse {
-  count: <>
+  count: number
   events: MlCalendarEvent[]
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-ml-get_calendars.asciidoc b/docs/reference-ml-get_calendars.asciidoc index e726b0fdd..875450bd1 100644 --- a/docs/reference-ml-get_calendars.asciidoc +++ b/docs/reference-ml-get_calendars.asciidoc @@ -41,26 +41,36 @@ Get calendar configuration info. ---- [discrete] -===== `MlGetCalendarsRequest` +==== MlGetCalendarsRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlGetCalendarsRequest extends <> {
   calendar_id?: <>
-  from?: <>
-  size?: <>
+  from?: number
+  size?: number
   page?: MlPage
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `MlGetCalendarsResponse` +==== MlGetCalendarsResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlGetCalendarsResponse {
   calendars: MlGetCalendarsCalendar[]
-  count: <>
+  count: number
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-ml-get_categories.asciidoc b/docs/reference-ml-get_categories.asciidoc index 7bbc1a862..5da0b92e9 100644 --- a/docs/reference-ml-get_categories.asciidoc +++ b/docs/reference-ml-get_categories.asciidoc @@ -41,28 +41,38 @@ Get anomaly detection job results for categories. ---- [discrete] -===== `MlGetCategoriesRequest` +==== MlGetCategoriesRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlGetCategoriesRequest extends <> {
   job_id: <>
   category_id?: <>
-  from?: <>
+  from?: number
   partition_field_value?: string
-  size?: <>
+  size?: number
   page?: MlPage
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `MlGetCategoriesResponse` +==== MlGetCategoriesResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlGetCategoriesResponse {
   categories: MlCategory[]
-  count: <>
+  count: number
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-ml-get_data_frame_analytics.asciidoc b/docs/reference-ml-get_data_frame_analytics.asciidoc index 0a0be2f9d..b174fff37 100644 --- a/docs/reference-ml-get_data_frame_analytics.asciidoc +++ b/docs/reference-ml-get_data_frame_analytics.asciidoc @@ -41,27 +41,37 @@ Get data frame analytics job configuration info. You can get information for mul ---- [discrete] -===== `MlGetDataFrameAnalyticsRequest` +==== MlGetDataFrameAnalyticsRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlGetDataFrameAnalyticsRequest extends <> {
   id?: <>
   allow_no_match?: boolean
-  from?: <>
-  size?: <>
+  from?: number
+  size?: number
   exclude_generated?: boolean
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `MlGetDataFrameAnalyticsResponse` +==== MlGetDataFrameAnalyticsResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlGetDataFrameAnalyticsResponse {
-  count: <>
+  count: number
   data_frame_analytics: MlDataframeAnalyticsSummary[]
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-ml-get_data_frame_analytics_stats.asciidoc b/docs/reference-ml-get_data_frame_analytics_stats.asciidoc index e7c96cacf..b70a1484e 100644 --- a/docs/reference-ml-get_data_frame_analytics_stats.asciidoc +++ b/docs/reference-ml-get_data_frame_analytics_stats.asciidoc @@ -41,27 +41,37 @@ Get data frame analytics jobs usage info. ---- [discrete] -===== `MlGetDataFrameAnalyticsStatsRequest` +==== MlGetDataFrameAnalyticsStatsRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlGetDataFrameAnalyticsStatsRequest extends <> {
   id?: <>
   allow_no_match?: boolean
-  from?: <>
-  size?: <>
+  from?: number
+  size?: number
   verbose?: boolean
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `MlGetDataFrameAnalyticsStatsResponse` +==== MlGetDataFrameAnalyticsStatsResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlGetDataFrameAnalyticsStatsResponse {
-  count: <>
+  count: number
   data_frame_analytics: MlDataframeAnalytics[]
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-ml-get_datafeed_stats.asciidoc b/docs/reference-ml-get_datafeed_stats.asciidoc index 9ca22ddd3..863347524 100644 --- a/docs/reference-ml-get_datafeed_stats.asciidoc +++ b/docs/reference-ml-get_datafeed_stats.asciidoc @@ -41,24 +41,34 @@ Get datafeeds usage info. You can get statistics for multiple datafeeds in a sin ---- [discrete] -===== `MlGetDatafeedStatsRequest` +==== MlGetDatafeedStatsRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlGetDatafeedStatsRequest extends <> {
   datafeed_id?: <>
   allow_no_match?: boolean
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `MlGetDatafeedStatsResponse` +==== MlGetDatafeedStatsResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlGetDatafeedStatsResponse {
-  count: <>
+  count: number
   datafeeds: MlDatafeedStats[]
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-ml-get_datafeeds.asciidoc b/docs/reference-ml-get_datafeeds.asciidoc index 8b3d7e397..5f88170fc 100644 --- a/docs/reference-ml-get_datafeeds.asciidoc +++ b/docs/reference-ml-get_datafeeds.asciidoc @@ -41,25 +41,35 @@ Get datafeeds configuration info. You can get information for multiple datafeeds ---- [discrete] -===== `MlGetDatafeedsRequest` +==== MlGetDatafeedsRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlGetDatafeedsRequest extends <> {
   datafeed_id?: <>
   allow_no_match?: boolean
   exclude_generated?: boolean
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `MlGetDatafeedsResponse` +==== MlGetDatafeedsResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlGetDatafeedsResponse {
-  count: <>
+  count: number
   datafeeds: MlDatafeed[]
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-ml-get_filters.asciidoc b/docs/reference-ml-get_filters.asciidoc index 405443ba3..a2a868d98 100644 --- a/docs/reference-ml-get_filters.asciidoc +++ b/docs/reference-ml-get_filters.asciidoc @@ -41,25 +41,35 @@ Get filters. You can get a single filter or all filters. ---- [discrete] -===== `MlGetFiltersRequest` +==== MlGetFiltersRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlGetFiltersRequest extends <> {
   filter_id?: <>
-  from?: <>
-  size?: <>
+  from?: number
+  size?: number
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `MlGetFiltersResponse` +==== MlGetFiltersResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlGetFiltersResponse {
-  count: <>
+  count: number
   filters: MlFilter[]
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-ml-get_influencers.asciidoc b/docs/reference-ml-get_influencers.asciidoc index 2f30abc7b..4f39ec405 100644 --- a/docs/reference-ml-get_influencers.asciidoc +++ b/docs/reference-ml-get_influencers.asciidoc @@ -41,32 +41,42 @@ Get anomaly detection job results for influencers. Influencers are the entities ---- [discrete] -===== `MlGetInfluencersRequest` +==== MlGetInfluencersRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlGetInfluencersRequest extends <> {
   job_id: <>
   desc?: boolean
   end?: <>
   exclude_interim?: boolean
-  influencer_score?: <>
-  from?: <>
-  size?: <>
+  influencer_score?: number
+  from?: number
+  size?: number
   sort?: <>
   start?: <>
   page?: MlPage
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `MlGetInfluencersResponse` +==== MlGetInfluencersResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlGetInfluencersResponse {
-  count: <>
+  count: number
   influencers: MlInfluencer[]
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-ml-get_job_stats.asciidoc b/docs/reference-ml-get_job_stats.asciidoc index a4b6e9f57..2c3e25dee 100644 --- a/docs/reference-ml-get_job_stats.asciidoc +++ b/docs/reference-ml-get_job_stats.asciidoc @@ -41,24 +41,34 @@ Get anomaly detection jobs usage info. ---- [discrete] -===== `MlGetJobStatsRequest` +==== MlGetJobStatsRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlGetJobStatsRequest extends <> {
   job_id?: <>
   allow_no_match?: boolean
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `MlGetJobStatsResponse` +==== MlGetJobStatsResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlGetJobStatsResponse {
-  count: <>
+  count: number
   jobs: MlJobStats[]
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-ml-get_jobs.asciidoc b/docs/reference-ml-get_jobs.asciidoc index 92b273aca..7a181ae68 100644 --- a/docs/reference-ml-get_jobs.asciidoc +++ b/docs/reference-ml-get_jobs.asciidoc @@ -41,25 +41,35 @@ Get anomaly detection jobs configuration info. You can get information for multi ---- [discrete] -===== `MlGetJobsRequest` +==== MlGetJobsRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlGetJobsRequest extends <> {
   job_id?: <>
   allow_no_match?: boolean
   exclude_generated?: boolean
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `MlGetJobsResponse` +==== MlGetJobsResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlGetJobsResponse {
-  count: <>
+  count: number
   jobs: MlJob[]
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-ml-get_memory_stats.asciidoc b/docs/reference-ml-get_memory_stats.asciidoc index 07398464d..25438172e 100644 --- a/docs/reference-ml-get_memory_stats.asciidoc +++ b/docs/reference-ml-get_memory_stats.asciidoc @@ -41,27 +41,37 @@ Get machine learning memory usage info. Get information about how machine learni ---- [discrete] -===== `MlGetMemoryStatsRequest` +==== MlGetMemoryStatsRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlGetMemoryStatsRequest extends <> {
   node_id?: <>
   human?: boolean
   master_timeout?: <>
   timeout?: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `MlGetMemoryStatsResponse` +==== MlGetMemoryStatsResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlGetMemoryStatsResponse {
   _nodes: <>
   cluster_name: <>
   nodes: Record<<>, MlGetMemoryStatsMemory>
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-ml-get_model_snapshot_upgrade_stats.asciidoc b/docs/reference-ml-get_model_snapshot_upgrade_stats.asciidoc index 44950c2db..cfb64c070 100644 --- a/docs/reference-ml-get_model_snapshot_upgrade_stats.asciidoc +++ b/docs/reference-ml-get_model_snapshot_upgrade_stats.asciidoc @@ -41,25 +41,35 @@ Get anomaly detection job model snapshot upgrade usage info. ---- [discrete] -===== `MlGetModelSnapshotUpgradeStatsRequest` +==== MlGetModelSnapshotUpgradeStatsRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlGetModelSnapshotUpgradeStatsRequest extends <> {
   job_id: <>
   snapshot_id: <>
   allow_no_match?: boolean
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `MlGetModelSnapshotUpgradeStatsResponse` +==== MlGetModelSnapshotUpgradeStatsResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlGetModelSnapshotUpgradeStatsResponse {
-  count: <>
+  count: number
   model_snapshot_upgrades: MlModelSnapshotUpgrade[]
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-ml-get_model_snapshots.asciidoc b/docs/reference-ml-get_model_snapshots.asciidoc index fc12ce62b..9d76f4aed 100644 --- a/docs/reference-ml-get_model_snapshots.asciidoc +++ b/docs/reference-ml-get_model_snapshots.asciidoc @@ -41,31 +41,41 @@ Get model snapshots info. ---- [discrete] -===== `MlGetModelSnapshotsRequest` +==== MlGetModelSnapshotsRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlGetModelSnapshotsRequest extends <> {
   job_id: <>
   snapshot_id?: <>
-  from?: <>
-  size?: <>
+  from?: number
+  size?: number
   desc?: boolean
   end?: <>
   page?: MlPage
   sort?: <>
   start?: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `MlGetModelSnapshotsResponse` +==== MlGetModelSnapshotsResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlGetModelSnapshotsResponse {
-  count: <>
+  count: number
   model_snapshots: MlModelSnapshot[]
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-ml-get_overall_buckets.asciidoc b/docs/reference-ml-get_overall_buckets.asciidoc index 28772e3d0..a2dedb6b7 100644 --- a/docs/reference-ml-get_overall_buckets.asciidoc +++ b/docs/reference-ml-get_overall_buckets.asciidoc @@ -41,30 +41,40 @@ Get overall bucket results. Retrievs overall bucket results that summarize the b ---- [discrete] -===== `MlGetOverallBucketsRequest` +==== MlGetOverallBucketsRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlGetOverallBucketsRequest extends <> {
   job_id: <>
   allow_no_match?: boolean
   bucket_span?: <>
   end?: <>
   exclude_interim?: boolean
-  overall_score?: <> | string
+  overall_score?: number | string
   start?: <>
-  top_n?: <>
+  top_n?: number
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `MlGetOverallBucketsResponse` +==== MlGetOverallBucketsResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlGetOverallBucketsResponse {
-  count: <>
+  count: number
   overall_buckets: MlOverallBucket[]
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-ml-get_records.asciidoc b/docs/reference-ml-get_records.asciidoc index 34f562c89..c4442c681 100644 --- a/docs/reference-ml-get_records.asciidoc +++ b/docs/reference-ml-get_records.asciidoc @@ -41,32 +41,42 @@ Get anomaly records for an anomaly detection job. Records contain the detailed a ---- [discrete] -===== `MlGetRecordsRequest` +==== MlGetRecordsRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlGetRecordsRequest extends <> {
   job_id: <>
-  from?: <>
-  size?: <>
+  from?: number
+  size?: number
   desc?: boolean
   end?: <>
   exclude_interim?: boolean
   page?: MlPage
-  record_score?: <>
+  record_score?: number
   sort?: <>
   start?: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `MlGetRecordsResponse` +==== MlGetRecordsResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlGetRecordsResponse {
-  count: <>
+  count: number
   records: MlAnomaly[]
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-ml-get_trained_models.asciidoc b/docs/reference-ml-get_trained_models.asciidoc index 5355996d9..516680068 100644 --- a/docs/reference-ml-get_trained_models.asciidoc +++ b/docs/reference-ml-get_trained_models.asciidoc @@ -41,30 +41,40 @@ Get trained model configuration info. ---- [discrete] -===== `MlGetTrainedModelsRequest` +==== MlGetTrainedModelsRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlGetTrainedModelsRequest extends <> {
   model_id?: <>
   allow_no_match?: boolean
   decompress_definition?: boolean
   exclude_generated?: boolean
-  from?: <>
+  from?: number
   include?: MlInclude
-  size?: <>
+  size?: number
   tags?: string | string[]
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `MlGetTrainedModelsResponse` +==== MlGetTrainedModelsResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlGetTrainedModelsResponse {
-  count: <>
+  count: number
   trained_model_configs: MlTrainedModelConfig[]
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-ml-get_trained_models_stats.asciidoc b/docs/reference-ml-get_trained_models_stats.asciidoc index 9a50bf1a6..a34f35b2a 100644 --- a/docs/reference-ml-get_trained_models_stats.asciidoc +++ b/docs/reference-ml-get_trained_models_stats.asciidoc @@ -41,26 +41,36 @@ Get trained models usage info. You can get usage information for multiple traine ---- [discrete] -===== `MlGetTrainedModelsStatsRequest` +==== MlGetTrainedModelsStatsRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlGetTrainedModelsStatsRequest extends <> {
   model_id?: <>
   allow_no_match?: boolean
-  from?: <>
-  size?: <>
+  from?: number
+  size?: number
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `MlGetTrainedModelsStatsResponse` +==== MlGetTrainedModelsStatsResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlGetTrainedModelsStatsResponse {
-  count: <>
+  count: number
   trained_model_stats: MlTrainedModelStats[]
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-ml-infer_trained_model.asciidoc b/docs/reference-ml-infer_trained_model.asciidoc index cffd2526c..311870acb 100644 --- a/docs/reference-ml-infer_trained_model.asciidoc +++ b/docs/reference-ml-infer_trained_model.asciidoc @@ -41,25 +41,35 @@ Evaluate a trained model. ---- [discrete] -===== `MlInferTrainedModelRequest` +==== MlInferTrainedModelRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlInferTrainedModelRequest extends <> {
   model_id: <>
   timeout?: <>
   docs: Record[]
   inference_config?: MlInferenceConfigUpdateContainer
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `MlInferTrainedModelResponse` +==== MlInferTrainedModelResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlInferTrainedModelResponse {
   inference_results: MlInferenceResponseResult[]
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-ml-info.asciidoc b/docs/reference-ml-info.asciidoc index e6a691023..39b1cef94 100644 --- a/docs/reference-ml-info.asciidoc +++ b/docs/reference-ml-info.asciidoc @@ -41,24 +41,34 @@ Return ML defaults and limits. Returns defaults and limits used by machine learn ---- [discrete] -===== `MlInfoRequest` +==== MlInfoRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlInfoRequest extends <> {
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `MlInfoResponse` +==== MlInfoResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlInfoResponse {
   defaults: MlInfoDefaults
   limits: MlInfoLimits
   upgrade_mode: boolean
   native_code: MlInfoNativeCode
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-ml-open_job.asciidoc b/docs/reference-ml-open_job.asciidoc index d855a50d9..ba2387302 100644 --- a/docs/reference-ml-open_job.asciidoc +++ b/docs/reference-ml-open_job.asciidoc @@ -41,24 +41,34 @@ Open anomaly detection jobs. An anomaly detection job must be opened to be ready ---- [discrete] -===== `MlOpenJobRequest` +==== MlOpenJobRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlOpenJobRequest extends <> {
   job_id: <>
   timeout?: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `MlOpenJobResponse` +==== MlOpenJobResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlOpenJobResponse {
   opened: boolean
   node: <>
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-ml-post_calendar_events.asciidoc b/docs/reference-ml-post_calendar_events.asciidoc index 28a1cb875..be8e1c100 100644 --- a/docs/reference-ml-post_calendar_events.asciidoc +++ b/docs/reference-ml-post_calendar_events.asciidoc @@ -41,23 +41,33 @@ Add scheduled events to the calendar. ---- [discrete] -===== `MlPostCalendarEventsRequest` +==== MlPostCalendarEventsRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlPostCalendarEventsRequest extends <> {
   calendar_id: <>
   events: MlCalendarEvent[]
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `MlPostCalendarEventsResponse` +==== MlPostCalendarEventsResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlPostCalendarEventsResponse {
   events: MlCalendarEvent[]
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-ml-post_data.asciidoc b/docs/reference-ml-post_data.asciidoc index 4a63a2a98..6c5cda46c 100644 --- a/docs/reference-ml-post_data.asciidoc +++ b/docs/reference-ml-post_data.asciidoc @@ -41,39 +41,49 @@ Send data to an anomaly detection job for analysis. IMPORTANT: For each job, dat ---- [discrete] -===== `MlPostDataRequest` +==== MlPostDataRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlPostDataRequest extends <> {
   job_id: <>
   reset_end?: <>
   reset_start?: <>
   data?: TData[]
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `MlPostDataResponse` +==== MlPostDataResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlPostDataResponse {
-  bucket_count: <>
-  earliest_record_timestamp: <>
-  empty_bucket_count: <>
-  input_bytes: <>
-  input_field_count: <>
-  input_record_count: <>
-  invalid_date_count: <>
+  bucket_count: number
+  earliest_record_timestamp: number
+  empty_bucket_count: number
+  input_bytes: number
+  input_field_count: number
+  input_record_count: number
+  invalid_date_count: number
   job_id: <>
-  last_data_time: <>
-  latest_record_timestamp: <>
-  missing_field_count: <>
-  out_of_order_timestamp_count: <>
-  processed_field_count: <>
-  processed_record_count: <>
-  sparse_bucket_count: <>
+  last_data_time: number
+  latest_record_timestamp: number
+  missing_field_count: number
+  out_of_order_timestamp_count: number
+  processed_field_count: number
+  processed_record_count: number
+  sparse_bucket_count: number
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-ml-preview_data_frame_analytics.asciidoc b/docs/reference-ml-preview_data_frame_analytics.asciidoc index 749423ae8..e33a9479c 100644 --- a/docs/reference-ml-preview_data_frame_analytics.asciidoc +++ b/docs/reference-ml-preview_data_frame_analytics.asciidoc @@ -41,23 +41,33 @@ Preview features used by data frame analytics. Previews the extracted features u ---- [discrete] -===== `MlPreviewDataFrameAnalyticsRequest` +==== MlPreviewDataFrameAnalyticsRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlPreviewDataFrameAnalyticsRequest extends <> {
   id?: <>
   config?: MlPreviewDataFrameAnalyticsDataframePreviewConfig
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `MlPreviewDataFrameAnalyticsResponse` +==== MlPreviewDataFrameAnalyticsResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlPreviewDataFrameAnalyticsResponse {
   feature_values: Record<<>, string>[]
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-ml-preview_datafeed.asciidoc b/docs/reference-ml-preview_datafeed.asciidoc index adb9b4351..c005b8393 100644 --- a/docs/reference-ml-preview_datafeed.asciidoc +++ b/docs/reference-ml-preview_datafeed.asciidoc @@ -41,10 +41,12 @@ Preview a datafeed. This API returns the first "page" of search results from a d ---- [discrete] -===== `MlPreviewDatafeedRequest` +==== MlPreviewDatafeedRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlPreviewDatafeedRequest extends <> {
   datafeed_id?: <>
   start?: <>
@@ -52,13 +54,21 @@ interface MlPreviewDatafeedRequest extends <> {
   datafeed_config?: MlDatafeedConfig
   job_config?: MlJobConfig
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `MlPreviewDatafeedResponse` +==== MlPreviewDatafeedResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type MlPreviewDatafeedResponse = TDocument[]
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-ml-put_calendar.asciidoc b/docs/reference-ml-put_calendar.asciidoc index b2dd76abf..c604d4642 100644 --- a/docs/reference-ml-put_calendar.asciidoc +++ b/docs/reference-ml-put_calendar.asciidoc @@ -41,26 +41,36 @@ Create a calendar. ---- [discrete] -===== `MlPutCalendarRequest` +==== MlPutCalendarRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlPutCalendarRequest extends <> {
   calendar_id: <>
   job_ids?: <>[]
   description?: string
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `MlPutCalendarResponse` +==== MlPutCalendarResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlPutCalendarResponse {
   calendar_id: <>
   description?: string
   job_ids: <>
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-ml-put_calendar_job.asciidoc b/docs/reference-ml-put_calendar_job.asciidoc index 8d7f1a53e..f3311cdee 100644 --- a/docs/reference-ml-put_calendar_job.asciidoc +++ b/docs/reference-ml-put_calendar_job.asciidoc @@ -41,25 +41,35 @@ Add anomaly detection job to calendar. ---- [discrete] -===== `MlPutCalendarJobRequest` +==== MlPutCalendarJobRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlPutCalendarJobRequest extends <> {
   calendar_id: <>
   job_id: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `MlPutCalendarJobResponse` +==== MlPutCalendarJobResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlPutCalendarJobResponse {
   calendar_id: <>
   description?: string
   job_ids: <>
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-ml-put_data_frame_analytics.asciidoc b/docs/reference-ml-put_data_frame_analytics.asciidoc index 7840618da..10b929665 100644 --- a/docs/reference-ml-put_data_frame_analytics.asciidoc +++ b/docs/reference-ml-put_data_frame_analytics.asciidoc @@ -41,10 +41,12 @@ Create a data frame analytics job. This API creates a data frame analytics job t ---- [discrete] -===== `MlPutDataFrameAnalyticsRequest` +==== MlPutDataFrameAnalyticsRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlPutDataFrameAnalyticsRequest extends <> {
   id: <>
   allow_lazy_start?: boolean
@@ -52,19 +54,24 @@ interface MlPutDataFrameAnalyticsRequest extends <> {
   analyzed_fields?: MlDataframeAnalysisAnalyzedFields | string[]
   description?: string
   dest: MlDataframeAnalyticsDestination
-  max_num_threads?: <>
+  max_num_threads?: number
   model_memory_limit?: string
   source: MlDataframeAnalyticsSource
   headers?: <>
   version?: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `MlPutDataFrameAnalyticsResponse` +==== MlPutDataFrameAnalyticsResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlPutDataFrameAnalyticsResponse {
   authorization?: MlDataframeAnalyticsAuthorization
   allow_lazy_start: boolean
@@ -74,10 +81,13 @@ interface MlPutDataFrameAnalyticsResponse {
   description?: string
   dest: MlDataframeAnalyticsDestination
   id: <>
-  max_num_threads: <>
+  max_num_threads: number
   model_memory_limit: string
   source: MlDataframeAnalyticsSource
   version: <>
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-ml-put_datafeed.asciidoc b/docs/reference-ml-put_datafeed.asciidoc index b108420f3..e60dfb941 100644 --- a/docs/reference-ml-put_datafeed.asciidoc +++ b/docs/reference-ml-put_datafeed.asciidoc @@ -41,10 +41,12 @@ Create a datafeed. Datafeeds retrieve data from Elasticsearch for analysis by an ---- [discrete] -===== `MlPutDatafeedRequest` +==== MlPutDatafeedRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlPutDatafeedRequest extends <> {
   datafeed_id: <>
   allow_no_indices?: boolean
@@ -60,21 +62,26 @@ interface MlPutDatafeedRequest extends <> {
   indexes?: <>
   indices_options?: <>
   job_id?: <>
-  max_empty_searches?: <>
+  max_empty_searches?: number
   query?: QueryDslQueryContainer
   query_delay?: <>
   runtime_mappings?: MappingRuntimeFields
   script_fields?: Record>>
-  scroll_size?: <>
+  scroll_size?: number
   headers?: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `MlPutDatafeedResponse` +==== MlPutDatafeedResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlPutDatafeedResponse {
   aggregations?: Record
   authorization?: MlDatafeedAuthorization
@@ -85,12 +92,15 @@ interface MlPutDatafeedResponse {
   indices: string[]
   job_id: <>
   indices_options?: <>
-  max_empty_searches?: <>
+  max_empty_searches?: number
   query: QueryDslQueryContainer
   query_delay: <>
   runtime_mappings?: MappingRuntimeFields
   script_fields?: Record>>
-  scroll_size: <>
+  scroll_size: number
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-ml-put_filter.asciidoc b/docs/reference-ml-put_filter.asciidoc index 0198d4726..f617ac245 100644 --- a/docs/reference-ml-put_filter.asciidoc +++ b/docs/reference-ml-put_filter.asciidoc @@ -41,26 +41,36 @@ Create a filter. A filter contains a list of strings. It can be used by one or m ---- [discrete] -===== `MlPutFilterRequest` +==== MlPutFilterRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlPutFilterRequest extends <> {
   filter_id: <>
   description?: string
   items?: string[]
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `MlPutFilterResponse` +==== MlPutFilterResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlPutFilterResponse {
   description: string
   filter_id: <>
   items: string[]
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-ml-put_job.asciidoc b/docs/reference-ml-put_job.asciidoc index caf04d47c..320c9bbd2 100644 --- a/docs/reference-ml-put_job.asciidoc +++ b/docs/reference-ml-put_job.asciidoc @@ -41,10 +41,12 @@ Create an anomaly detection job. If you include a `datafeed_config`, you must ha ---- [discrete] -===== `MlPutJobRequest` +==== MlPutJobRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlPutJobRequest extends <> {
   job_id: <>
   allow_lazy_open?: boolean
@@ -52,24 +54,29 @@ interface MlPutJobRequest extends <> {
   analysis_limits?: MlAnalysisLimits
   background_persist_interval?: <>
   custom_settings?: MlCustomSettings
-  daily_model_snapshot_retention_after_days?: <>
+  daily_model_snapshot_retention_after_days?: number
   data_description: MlDataDescription
   datafeed_config?: MlDatafeedConfig
   description?: string
   groups?: string[]
   model_plot_config?: MlModelPlotConfig
-  model_snapshot_retention_days?: <>
-  renormalization_window_days?: <>
+  model_snapshot_retention_days?: number
+  renormalization_window_days?: number
   results_index_name?: <>
-  results_retention_days?: <>
+  results_retention_days?: number
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `MlPutJobResponse` +==== MlPutJobResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlPutJobResponse {
   allow_lazy_open: boolean
   analysis_config: MlAnalysisConfigRead
@@ -77,7 +84,7 @@ interface MlPutJobResponse {
   background_persist_interval?: <>
   create_time: <>
   custom_settings?: MlCustomSettings
-  daily_model_snapshot_retention_after_days: <>
+  daily_model_snapshot_retention_after_days: number
   data_description: MlDataDescription
   datafeed_config?: MlDatafeed
   description?: string
@@ -87,10 +94,13 @@ interface MlPutJobResponse {
   job_version: string
   model_plot_config?: MlModelPlotConfig
   model_snapshot_id?: <>
-  model_snapshot_retention_days: <>
-  renormalization_window_days?: <>
+  model_snapshot_retention_days: number
+  renormalization_window_days?: number
   results_index_name: string
-  results_retention_days?: <>
+  results_retention_days?: number
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-ml-put_trained_model.asciidoc b/docs/reference-ml-put_trained_model.asciidoc index 0a46ba12f..64c398c66 100644 --- a/docs/reference-ml-put_trained_model.asciidoc +++ b/docs/reference-ml-put_trained_model.asciidoc @@ -41,10 +41,12 @@ Create a trained model. Enable you to supply a trained model that is not created ---- [discrete] -===== `MlPutTrainedModelRequest` +==== MlPutTrainedModelRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlPutTrainedModelRequest extends <> {
   model_id: <>
   defer_definition_decompression?: boolean
@@ -56,18 +58,26 @@ interface MlPutTrainedModelRequest extends <> {
   input?: MlPutTrainedModelInput
   metadata?: any
   model_type?: MlTrainedModelType
-  model_size_bytes?: <>
+  model_size_bytes?: number
   platform_architecture?: string
   tags?: string[]
   prefix_strings?: MlTrainedModelPrefixStrings
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `MlPutTrainedModelResponse` +==== MlPutTrainedModelResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type MlPutTrainedModelResponse = MlTrainedModelConfig
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-ml-put_trained_model_alias.asciidoc b/docs/reference-ml-put_trained_model_alias.asciidoc index 6a1c6c1d4..7523b7997 100644 --- a/docs/reference-ml-put_trained_model_alias.asciidoc +++ b/docs/reference-ml-put_trained_model_alias.asciidoc @@ -41,22 +41,32 @@ Create or update a trained model alias. A trained model alias is a logical name ---- [discrete] -===== `MlPutTrainedModelAliasRequest` +==== MlPutTrainedModelAliasRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlPutTrainedModelAliasRequest extends <> {
   model_alias: <>
   model_id: <>
   reassign?: boolean
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `MlPutTrainedModelAliasResponse` +==== MlPutTrainedModelAliasResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type MlPutTrainedModelAliasResponse = <>
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-ml-put_trained_model_definition_part.asciidoc b/docs/reference-ml-put_trained_model_definition_part.asciidoc index 40c239f70..7183f8402 100644 --- a/docs/reference-ml-put_trained_model_definition_part.asciidoc +++ b/docs/reference-ml-put_trained_model_definition_part.asciidoc @@ -41,24 +41,34 @@ Create part of a trained model definition. ---- [discrete] -===== `MlPutTrainedModelDefinitionPartRequest` +==== MlPutTrainedModelDefinitionPartRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlPutTrainedModelDefinitionPartRequest extends <> {
   model_id: <>
-  part: <>
+  part: number
   definition: string
-  total_definition_length: <>
-  total_parts: <>
+  total_definition_length: number
+  total_parts: number
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `MlPutTrainedModelDefinitionPartResponse` +==== MlPutTrainedModelDefinitionPartResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type MlPutTrainedModelDefinitionPartResponse = <>
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-ml-put_trained_model_vocabulary.asciidoc b/docs/reference-ml-put_trained_model_vocabulary.asciidoc index b2cc75a41..1e5ff141a 100644 --- a/docs/reference-ml-put_trained_model_vocabulary.asciidoc +++ b/docs/reference-ml-put_trained_model_vocabulary.asciidoc @@ -41,23 +41,33 @@ Create a trained model vocabulary. This API is supported only for natural langua ---- [discrete] -===== `MlPutTrainedModelVocabularyRequest` +==== MlPutTrainedModelVocabularyRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlPutTrainedModelVocabularyRequest extends <> {
   model_id: <>
   vocabulary: string[]
   merges?: string[]
-  scores?: <>[]
+  scores?: number[]
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `MlPutTrainedModelVocabularyResponse` +==== MlPutTrainedModelVocabularyResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type MlPutTrainedModelVocabularyResponse = <>
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-ml-reset_job.asciidoc b/docs/reference-ml-reset_job.asciidoc index f3749687e..a9f3a3953 100644 --- a/docs/reference-ml-reset_job.asciidoc +++ b/docs/reference-ml-reset_job.asciidoc @@ -41,22 +41,32 @@ Reset an anomaly detection job. All model state and results are deleted. The job ---- [discrete] -===== `MlResetJobRequest` +==== MlResetJobRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlResetJobRequest extends <> {
   job_id: <>
   wait_for_completion?: boolean
   delete_user_annotations?: boolean
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `MlResetJobResponse` +==== MlResetJobResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type MlResetJobResponse = <>
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-ml-revert_model_snapshot.asciidoc b/docs/reference-ml-revert_model_snapshot.asciidoc index 9b7fbcd54..dd39663f0 100644 --- a/docs/reference-ml-revert_model_snapshot.asciidoc +++ b/docs/reference-ml-revert_model_snapshot.asciidoc @@ -41,24 +41,34 @@ Revert to a snapshot. The machine learning features react quickly to anomalous i ---- [discrete] -===== `MlRevertModelSnapshotRequest` +==== MlRevertModelSnapshotRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlRevertModelSnapshotRequest extends <> {
   job_id: <>
   snapshot_id: <>
   delete_intervening_results?: boolean
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `MlRevertModelSnapshotResponse` +==== MlRevertModelSnapshotResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlRevertModelSnapshotResponse {
   model: MlModelSnapshot
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-ml-set_upgrade_mode.asciidoc b/docs/reference-ml-set_upgrade_mode.asciidoc index 9a5cdc887..96226ab87 100644 --- a/docs/reference-ml-set_upgrade_mode.asciidoc +++ b/docs/reference-ml-set_upgrade_mode.asciidoc @@ -41,21 +41,31 @@ Set upgrade_mode for ML indices. Sets a cluster wide upgrade_mode setting that p ---- [discrete] -===== `MlSetUpgradeModeRequest` +==== MlSetUpgradeModeRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlSetUpgradeModeRequest extends <> {
   enabled?: boolean
   timeout?: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `MlSetUpgradeModeResponse` +==== MlSetUpgradeModeResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type MlSetUpgradeModeResponse = <>
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-ml-start_data_frame_analytics.asciidoc b/docs/reference-ml-start_data_frame_analytics.asciidoc index f418e4173..547ae3841 100644 --- a/docs/reference-ml-start_data_frame_analytics.asciidoc +++ b/docs/reference-ml-start_data_frame_analytics.asciidoc @@ -41,24 +41,34 @@ Start a data frame analytics job. A data frame analytics job can be started and ---- [discrete] -===== `MlStartDataFrameAnalyticsRequest` +==== MlStartDataFrameAnalyticsRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlStartDataFrameAnalyticsRequest extends <> {
   id: <>
   timeout?: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `MlStartDataFrameAnalyticsResponse` +==== MlStartDataFrameAnalyticsResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlStartDataFrameAnalyticsResponse {
   acknowledged: boolean
   node: <>
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-ml-start_datafeed.asciidoc b/docs/reference-ml-start_datafeed.asciidoc index a9276a479..0c70b1767 100644 --- a/docs/reference-ml-start_datafeed.asciidoc +++ b/docs/reference-ml-start_datafeed.asciidoc @@ -41,26 +41,36 @@ Start datafeeds. A datafeed must be started in order to retrieve data from Elast ---- [discrete] -===== `MlStartDatafeedRequest` +==== MlStartDatafeedRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlStartDatafeedRequest extends <> {
   datafeed_id: <>
   end?: <>
   start?: <>
   timeout?: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `MlStartDatafeedResponse` +==== MlStartDatafeedResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlStartDatafeedResponse {
   node: <>
   started: boolean
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-ml-start_trained_model_deployment.asciidoc b/docs/reference-ml-start_trained_model_deployment.asciidoc index b7abb99d4..5e1761a0a 100644 --- a/docs/reference-ml-start_trained_model_deployment.asciidoc +++ b/docs/reference-ml-start_trained_model_deployment.asciidoc @@ -41,30 +41,40 @@ Start a trained model deployment. It allocates the model to every machine learni ---- [discrete] -===== `MlStartTrainedModelDeploymentRequest` +==== MlStartTrainedModelDeploymentRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlStartTrainedModelDeploymentRequest extends <> {
   model_id: <>
   cache_size?: <>
   deployment_id?: string
-  number_of_allocations?: <>
+  number_of_allocations?: number
   priority?: MlTrainingPriority
-  queue_capacity?: <>
-  threads_per_allocation?: <>
+  queue_capacity?: number
+  threads_per_allocation?: number
   timeout?: <>
   wait_for?: MlDeploymentAllocationState
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `MlStartTrainedModelDeploymentResponse` +==== MlStartTrainedModelDeploymentResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlStartTrainedModelDeploymentResponse {
   assignment: MlTrainedModelAssignment
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-ml-stop_data_frame_analytics.asciidoc b/docs/reference-ml-stop_data_frame_analytics.asciidoc index 088d19342..7ca568f38 100644 --- a/docs/reference-ml-stop_data_frame_analytics.asciidoc +++ b/docs/reference-ml-stop_data_frame_analytics.asciidoc @@ -41,25 +41,35 @@ Stop data frame analytics jobs. A data frame analytics job can be started and st ---- [discrete] -===== `MlStopDataFrameAnalyticsRequest` +==== MlStopDataFrameAnalyticsRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlStopDataFrameAnalyticsRequest extends <> {
   id: <>
   allow_no_match?: boolean
   force?: boolean
   timeout?: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `MlStopDataFrameAnalyticsResponse` +==== MlStopDataFrameAnalyticsResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlStopDataFrameAnalyticsResponse {
   stopped: boolean
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-ml-stop_datafeed.asciidoc b/docs/reference-ml-stop_datafeed.asciidoc index f4000e1bf..727bc55fa 100644 --- a/docs/reference-ml-stop_datafeed.asciidoc +++ b/docs/reference-ml-stop_datafeed.asciidoc @@ -41,25 +41,35 @@ Stop datafeeds. A datafeed that is stopped ceases to retrieve data from Elastics ---- [discrete] -===== `MlStopDatafeedRequest` +==== MlStopDatafeedRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlStopDatafeedRequest extends <> {
   datafeed_id: <>
   allow_no_match?: boolean
   force?: boolean
   timeout?: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `MlStopDatafeedResponse` +==== MlStopDatafeedResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlStopDatafeedResponse {
   stopped: boolean
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-ml-stop_trained_model_deployment.asciidoc b/docs/reference-ml-stop_trained_model_deployment.asciidoc index 2043fa50b..b1d43dc5f 100644 --- a/docs/reference-ml-stop_trained_model_deployment.asciidoc +++ b/docs/reference-ml-stop_trained_model_deployment.asciidoc @@ -41,24 +41,34 @@ Stop a trained model deployment. ---- [discrete] -===== `MlStopTrainedModelDeploymentRequest` +==== MlStopTrainedModelDeploymentRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlStopTrainedModelDeploymentRequest extends <> {
   model_id: <>
   allow_no_match?: boolean
   force?: boolean
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `MlStopTrainedModelDeploymentResponse` +==== MlStopTrainedModelDeploymentResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlStopTrainedModelDeploymentResponse {
   stopped: boolean
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-ml-update_data_frame_analytics.asciidoc b/docs/reference-ml-update_data_frame_analytics.asciidoc index 4381c8610..e8b70f7f5 100644 --- a/docs/reference-ml-update_data_frame_analytics.asciidoc +++ b/docs/reference-ml-update_data_frame_analytics.asciidoc @@ -41,37 +41,47 @@ Update a data frame analytics job. ---- [discrete] -===== `MlUpdateDataFrameAnalyticsRequest` +==== MlUpdateDataFrameAnalyticsRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlUpdateDataFrameAnalyticsRequest extends <> {
   id: <>
   description?: string
   model_memory_limit?: string
-  max_num_threads?: <>
+  max_num_threads?: number
   allow_lazy_start?: boolean
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `MlUpdateDataFrameAnalyticsResponse` +==== MlUpdateDataFrameAnalyticsResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlUpdateDataFrameAnalyticsResponse {
   authorization?: MlDataframeAnalyticsAuthorization
   allow_lazy_start: boolean
   analysis: MlDataframeAnalysisContainer
   analyzed_fields?: MlDataframeAnalysisAnalyzedFields | string[]
-  create_time: <>
+  create_time: number
   description?: string
   dest: MlDataframeAnalyticsDestination
   id: <>
-  max_num_threads: <>
+  max_num_threads: number
   model_memory_limit: string
   source: MlDataframeAnalyticsSource
   version: <>
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-ml-update_datafeed.asciidoc b/docs/reference-ml-update_datafeed.asciidoc index 764aff65e..a8df6e85b 100644 --- a/docs/reference-ml-update_datafeed.asciidoc +++ b/docs/reference-ml-update_datafeed.asciidoc @@ -41,10 +41,12 @@ Update a datafeed. You must stop and start the datafeed for the changes to be ap ---- [discrete] -===== `MlUpdateDatafeedRequest` +==== MlUpdateDatafeedRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlUpdateDatafeedRequest extends <> {
   datafeed_id: <>
   allow_no_indices?: boolean
@@ -60,20 +62,25 @@ interface MlUpdateDatafeedRequest extends <> {
   indexes?: string[]
   indices_options?: <>
   job_id?: <>
-  max_empty_searches?: <>
+  max_empty_searches?: number
   query?: QueryDslQueryContainer
   query_delay?: <>
   runtime_mappings?: MappingRuntimeFields
   script_fields?: Record>>
-  scroll_size?: <>
+  scroll_size?: number
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `MlUpdateDatafeedResponse` +==== MlUpdateDatafeedResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlUpdateDatafeedResponse {
   authorization?: MlDatafeedAuthorization
   aggregations?: Record
@@ -84,12 +91,15 @@ interface MlUpdateDatafeedResponse {
   indices: string[]
   indices_options?: <>
   job_id: <>
-  max_empty_searches?: <>
+  max_empty_searches?: number
   query: QueryDslQueryContainer
   query_delay: <>
   runtime_mappings?: MappingRuntimeFields
   script_fields?: Record>>
-  scroll_size: <>
+  scroll_size: number
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-ml-update_filter.asciidoc b/docs/reference-ml-update_filter.asciidoc index cb71024e7..5c000895d 100644 --- a/docs/reference-ml-update_filter.asciidoc +++ b/docs/reference-ml-update_filter.asciidoc @@ -41,27 +41,37 @@ Update a filter. Updates the description of a filter, adds items, or removes ite ---- [discrete] -===== `MlUpdateFilterRequest` +==== MlUpdateFilterRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlUpdateFilterRequest extends <> {
   filter_id: <>
   add_items?: string[]
   description?: string
   remove_items?: string[]
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `MlUpdateFilterResponse` +==== MlUpdateFilterResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlUpdateFilterResponse {
   description: string
   filter_id: <>
   items: string[]
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-ml-update_job.asciidoc b/docs/reference-ml-update_job.asciidoc index 0ecce3234..ce33f0c9b 100644 --- a/docs/reference-ml-update_job.asciidoc +++ b/docs/reference-ml-update_job.asciidoc @@ -41,10 +41,12 @@ Update an anomaly detection job. Updates certain properties of an anomaly detect ---- [discrete] -===== `MlUpdateJobRequest` +==== MlUpdateJobRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlUpdateJobRequest extends <> {
   job_id: <>
   allow_lazy_open?: boolean
@@ -55,21 +57,26 @@ interface MlUpdateJobRequest extends <> {
   description?: string
   model_plot_config?: MlModelPlotConfig
   model_prune_window?: <>
-  daily_model_snapshot_retention_after_days?: <>
-  model_snapshot_retention_days?: <>
-  renormalization_window_days?: <>
-  results_retention_days?: <>
+  daily_model_snapshot_retention_after_days?: number
+  model_snapshot_retention_days?: number
+  renormalization_window_days?: number
+  results_retention_days?: number
   groups?: string[]
   detectors?: MlDetector[]
   per_partition_categorization?: MlPerPartitionCategorization
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `MlUpdateJobResponse` +==== MlUpdateJobResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlUpdateJobResponse {
   allow_lazy_open: boolean
   analysis_config: MlAnalysisConfigRead
@@ -78,7 +85,7 @@ interface MlUpdateJobResponse {
   create_time: <><<>>
   finished_time?: <><<>>
   custom_settings?: Record
-  daily_model_snapshot_retention_after_days: <>
+  daily_model_snapshot_retention_after_days: number
   data_description: MlDataDescription
   datafeed_config?: MlDatafeed
   description?: string
@@ -88,10 +95,13 @@ interface MlUpdateJobResponse {
   job_version: <>
   model_plot_config?: MlModelPlotConfig
   model_snapshot_id?: <>
-  model_snapshot_retention_days: <>
-  renormalization_window_days?: <>
+  model_snapshot_retention_days: number
+  renormalization_window_days?: number
   results_index_name: <>
-  results_retention_days?: <>
+  results_retention_days?: number
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-ml-update_model_snapshot.asciidoc b/docs/reference-ml-update_model_snapshot.asciidoc index ff237e236..b68ace1a9 100644 --- a/docs/reference-ml-update_model_snapshot.asciidoc +++ b/docs/reference-ml-update_model_snapshot.asciidoc @@ -41,26 +41,36 @@ Update a snapshot. Updates certain properties of a snapshot. ---- [discrete] -===== `MlUpdateModelSnapshotRequest` +==== MlUpdateModelSnapshotRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlUpdateModelSnapshotRequest extends <> {
   job_id: <>
   snapshot_id: <>
   description?: string
   retain?: boolean
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `MlUpdateModelSnapshotResponse` +==== MlUpdateModelSnapshotResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlUpdateModelSnapshotResponse {
   acknowledged: boolean
   model: MlModelSnapshot
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-ml-update_trained_model_deployment.asciidoc b/docs/reference-ml-update_trained_model_deployment.asciidoc index dac9d7017..74cdd7928 100644 --- a/docs/reference-ml-update_trained_model_deployment.asciidoc +++ b/docs/reference-ml-update_trained_model_deployment.asciidoc @@ -41,23 +41,33 @@ Update a trained model deployment. ---- [discrete] -===== `MlUpdateTrainedModelDeploymentRequest` +==== MlUpdateTrainedModelDeploymentRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlUpdateTrainedModelDeploymentRequest extends <> {
   model_id: <>
-  number_of_allocations?: <>
+  number_of_allocations?: number
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `MlUpdateTrainedModelDeploymentResponse` +==== MlUpdateTrainedModelDeploymentResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlUpdateTrainedModelDeploymentResponse {
   assignment: MlTrainedModelAssignment
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-ml-upgrade_job_snapshot.asciidoc b/docs/reference-ml-upgrade_job_snapshot.asciidoc index 4eb46b4d0..8acb22770 100644 --- a/docs/reference-ml-upgrade_job_snapshot.asciidoc +++ b/docs/reference-ml-upgrade_job_snapshot.asciidoc @@ -41,26 +41,36 @@ Upgrade a snapshot. Upgrades an anomaly detection model snapshot to the latest m ---- [discrete] -===== `MlUpgradeJobSnapshotRequest` +==== MlUpgradeJobSnapshotRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlUpgradeJobSnapshotRequest extends <> {
   job_id: <>
   snapshot_id: <>
   wait_for_completion?: boolean
   timeout?: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `MlUpgradeJobSnapshotResponse` +==== MlUpgradeJobSnapshotResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface MlUpgradeJobSnapshotResponse {
   node: <>
   completed: boolean
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-monitoring-bulk.asciidoc b/docs/reference-monitoring-bulk.asciidoc index e323983ea..9f025aae6 100644 --- a/docs/reference-monitoring-bulk.asciidoc +++ b/docs/reference-monitoring-bulk.asciidoc @@ -41,10 +41,12 @@ Used by the monitoring features to send monitoring data. ---- [discrete] -===== `MonitoringBulkRequest` +==== MonitoringBulkRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface MonitoringBulkRequest extends <> {
   type?: string
   system_id: string
@@ -52,18 +54,26 @@ interface MonitoringBulkRequest
   interval: <>
   operations?: (BulkOperationContainer | BulkUpdateAction | TDocument)[]
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `MonitoringBulkResponse` +==== MonitoringBulkResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface MonitoringBulkResponse {
   error?: <>
   errors: boolean
   ignored: boolean
-  took: <>
+  took: number
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-msearch.asciidoc b/docs/reference-msearch.asciidoc index 30ebb8126..131166955 100644 --- a/docs/reference-msearch.asciidoc +++ b/docs/reference-msearch.asciidoc @@ -41,10 +41,12 @@ Run multiple searches. The format of the request is similar to the bulk API form ---- [discrete] -===== `MsearchRequest` +==== MsearchRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface MsearchRequest extends <> {
   index?: <>
   allow_no_indices?: boolean
@@ -53,22 +55,30 @@ interface MsearchRequest extends <> {
   ignore_throttled?: boolean
   ignore_unavailable?: boolean
   include_named_queries_score?: boolean
-  max_concurrent_searches?: <>
-  max_concurrent_shard_requests?: <>
-  pre_filter_shard_size?: <>
+  max_concurrent_searches?: number
+  max_concurrent_shard_requests?: number
+  pre_filter_shard_size?: number
   rest_total_hits_as_int?: boolean
   routing?: <>
   search_type?: <>
   typed_keys?: boolean
   searches?: MsearchRequestItem[]
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `MsearchResponse` +==== MsearchResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type MsearchResponse>, AggregationsAggregate>> = MsearchMultiSearchResult
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-msearch_template.asciidoc b/docs/reference-msearch_template.asciidoc index 21ff5ce8f..ba906aa08 100644 --- a/docs/reference-msearch_template.asciidoc +++ b/docs/reference-msearch_template.asciidoc @@ -41,26 +41,36 @@ Run multiple templated searches. ---- [discrete] -===== `MsearchTemplateRequest` +==== MsearchTemplateRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface MsearchTemplateRequest extends <> {
   index?: <>
   ccs_minimize_roundtrips?: boolean
-  max_concurrent_searches?: <>
+  max_concurrent_searches?: number
   search_type?: <>
   rest_total_hits_as_int?: boolean
   typed_keys?: boolean
   search_templates?: MsearchTemplateRequestItem[]
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `MsearchTemplateResponse` +==== MsearchTemplateResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type MsearchTemplateResponse>, AggregationsAggregate>> = MsearchMultiSearchResult
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-mtermvectors.asciidoc b/docs/reference-mtermvectors.asciidoc index d16d81fbc..8e235ba65 100644 --- a/docs/reference-mtermvectors.asciidoc +++ b/docs/reference-mtermvectors.asciidoc @@ -41,10 +41,12 @@ Get multiple term vectors. You can specify existing documents by index and ID or ---- [discrete] -===== `MtermvectorsRequest` +==== MtermvectorsRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface MtermvectorsRequest extends <> {
   index?: <>
   fields?: <>
@@ -61,15 +63,23 @@ interface MtermvectorsRequest extends <> {
   docs?: MtermvectorsOperation[]
   ids?: <>[]
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `MtermvectorsResponse` +==== MtermvectorsResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface MtermvectorsResponse {
   docs: MtermvectorsTermVectorsResult[]
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-nodes-clear_repositories_metering_archive.asciidoc b/docs/reference-nodes-clear_repositories_metering_archive.asciidoc index e90e8e81b..abff50a26 100644 --- a/docs/reference-nodes-clear_repositories_metering_archive.asciidoc +++ b/docs/reference-nodes-clear_repositories_metering_archive.asciidoc @@ -41,21 +41,31 @@ You can use this API to clear the archived repositories metering information in ---- [discrete] -===== `NodesClearRepositoriesMeteringArchiveRequest` +==== NodesClearRepositoriesMeteringArchiveRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface NodesClearRepositoriesMeteringArchiveRequest extends <> {
   node_id: <>
-  max_archive_version: <>
+  max_archive_version: number
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `NodesClearRepositoriesMeteringArchiveResponse` +==== NodesClearRepositoriesMeteringArchiveResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type NodesClearRepositoriesMeteringArchiveResponse = NodesClearRepositoriesMeteringArchiveResponseBase
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-nodes-get_repositories_metering_info.asciidoc b/docs/reference-nodes-get_repositories_metering_info.asciidoc index f72fba76d..2c269ed44 100644 --- a/docs/reference-nodes-get_repositories_metering_info.asciidoc +++ b/docs/reference-nodes-get_repositories_metering_info.asciidoc @@ -41,20 +41,30 @@ You can use the cluster repositories metering API to retrieve repositories meter ---- [discrete] -===== `NodesGetRepositoriesMeteringInfoRequest` +==== NodesGetRepositoriesMeteringInfoRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface NodesGetRepositoriesMeteringInfoRequest extends <> {
   node_id: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `NodesGetRepositoriesMeteringInfoResponse` +==== NodesGetRepositoriesMeteringInfoResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type NodesGetRepositoriesMeteringInfoResponse = NodesGetRepositoriesMeteringInfoResponseBase
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-nodes-hot_threads.asciidoc b/docs/reference-nodes-hot_threads.asciidoc index e2cb71538..9c375ec37 100644 --- a/docs/reference-nodes-hot_threads.asciidoc +++ b/docs/reference-nodes-hot_threads.asciidoc @@ -41,29 +41,39 @@ This API yields a breakdown of the hot threads on each selected node in the clus ---- [discrete] -===== `NodesHotThreadsRequest` +==== NodesHotThreadsRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface NodesHotThreadsRequest extends <> {
   node_id?: <>
   ignore_idle_threads?: boolean
   interval?: <>
-  snapshots?: <>
+  snapshots?: number
   master_timeout?: <>
-  threads?: <>
+  threads?: number
   timeout?: <>
   type?: <>
   sort?: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `NodesHotThreadsResponse` +==== NodesHotThreadsResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface NodesHotThreadsResponse {
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-nodes-info.asciidoc b/docs/reference-nodes-info.asciidoc index 303b5904d..8fabbbb81 100644 --- a/docs/reference-nodes-info.asciidoc +++ b/docs/reference-nodes-info.asciidoc @@ -41,10 +41,12 @@ Returns cluster nodes information. ---- [discrete] -===== `NodesInfoRequest` +==== NodesInfoRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface NodesInfoRequest extends <> {
   node_id?: <>
   metric?: <>
@@ -52,13 +54,21 @@ interface NodesInfoRequest extends <> {
   master_timeout?: <>
   timeout?: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `NodesInfoResponse` +==== NodesInfoResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type NodesInfoResponse = NodesInfoResponseBase
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-nodes-reload_secure_settings.asciidoc b/docs/reference-nodes-reload_secure_settings.asciidoc index 73a50430f..5a0d30e1f 100644 --- a/docs/reference-nodes-reload_secure_settings.asciidoc +++ b/docs/reference-nodes-reload_secure_settings.asciidoc @@ -41,22 +41,32 @@ Reloads the keystore on nodes in the cluster. ---- [discrete] -===== `NodesReloadSecureSettingsRequest` +==== NodesReloadSecureSettingsRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface NodesReloadSecureSettingsRequest extends <> {
   node_id?: <>
   timeout?: <>
   secure_settings_password?: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `NodesReloadSecureSettingsResponse` +==== NodesReloadSecureSettingsResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type NodesReloadSecureSettingsResponse = NodesReloadSecureSettingsResponseBase
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-nodes-stats.asciidoc b/docs/reference-nodes-stats.asciidoc index ec45cc45b..35a06ff32 100644 --- a/docs/reference-nodes-stats.asciidoc +++ b/docs/reference-nodes-stats.asciidoc @@ -41,10 +41,12 @@ Returns cluster nodes statistics. ---- [discrete] -===== `NodesStatsRequest` +==== NodesStatsRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface NodesStatsRequest extends <> {
   node_id?: <>
   metric?: <>
@@ -60,13 +62,21 @@ interface NodesStatsRequest extends <> {
   types?: string[]
   include_unloaded_segments?: boolean
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `NodesStatsResponse` +==== NodesStatsResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type NodesStatsResponse = NodesStatsResponseBase
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-nodes-usage.asciidoc b/docs/reference-nodes-usage.asciidoc index 0d62e2fdb..762be00c4 100644 --- a/docs/reference-nodes-usage.asciidoc +++ b/docs/reference-nodes-usage.asciidoc @@ -41,22 +41,32 @@ Returns information on the usage of features. ---- [discrete] -===== `NodesUsageRequest` +==== NodesUsageRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface NodesUsageRequest extends <> {
   node_id?: <>
   metric?: <>
   timeout?: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `NodesUsageResponse` +==== NodesUsageResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type NodesUsageResponse = NodesUsageResponseBase
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-open_point_in_time.asciidoc b/docs/reference-open_point_in_time.asciidoc index 223b8d079..35b8a18da 100644 --- a/docs/reference-open_point_in_time.asciidoc +++ b/docs/reference-open_point_in_time.asciidoc @@ -41,10 +41,12 @@ Open a point in time. A search request by default runs against the most recent v ---- [discrete] -===== `OpenPointInTimeRequest` +==== OpenPointInTimeRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface OpenPointInTimeRequest extends <> {
   index: <>
   keep_alive: <>
@@ -54,16 +56,24 @@ interface OpenPointInTimeRequest extends <> {
   expand_wildcards?: <>
   index_filter?: QueryDslQueryContainer
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `OpenPointInTimeResponse` +==== OpenPointInTimeResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface OpenPointInTimeResponse {
   _shards: <>
   id: <>
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-ping.asciidoc b/docs/reference-ping.asciidoc index eb9f4070d..1086b59b7 100644 --- a/docs/reference-ping.asciidoc +++ b/docs/reference-ping.asciidoc @@ -41,19 +41,29 @@ Ping the cluster. Returns whether the cluster is running. ---- [discrete] -===== `PingRequest` +==== PingRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface PingRequest extends <> {
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `PingResponse` +==== PingResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type PingResponse = boolean
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-put_script.asciidoc b/docs/reference-put_script.asciidoc index 6a62ac436..8f0d18a51 100644 --- a/docs/reference-put_script.asciidoc +++ b/docs/reference-put_script.asciidoc @@ -41,10 +41,12 @@ Create or update a script or search template. Creates or updates a stored script ---- [discrete] -===== `PutScriptRequest` +==== PutScriptRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface PutScriptRequest extends <> {
   id: <>
   context?: <>
@@ -52,13 +54,21 @@ interface PutScriptRequest extends <> {
   timeout?: <>
   script: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `PutScriptResponse` +==== PutScriptResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type PutScriptResponse = <>
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-query_rules-delete_rule.asciidoc b/docs/reference-query_rules-delete_rule.asciidoc index 66ee560de..081e8659b 100644 --- a/docs/reference-query_rules-delete_rule.asciidoc +++ b/docs/reference-query_rules-delete_rule.asciidoc @@ -41,21 +41,31 @@ Deletes a query rule within a query ruleset. ---- [discrete] -===== `QueryRulesDeleteRuleRequest` +==== QueryRulesDeleteRuleRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface QueryRulesDeleteRuleRequest extends <> {
   ruleset_id: <>
   rule_id: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `QueryRulesDeleteRuleResponse` +==== QueryRulesDeleteRuleResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type QueryRulesDeleteRuleResponse = <>
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-query_rules-delete_ruleset.asciidoc b/docs/reference-query_rules-delete_ruleset.asciidoc index 34f3b03a2..3383cb7bc 100644 --- a/docs/reference-query_rules-delete_ruleset.asciidoc +++ b/docs/reference-query_rules-delete_ruleset.asciidoc @@ -41,20 +41,30 @@ Deletes a query ruleset. ---- [discrete] -===== `QueryRulesDeleteRulesetRequest` +==== QueryRulesDeleteRulesetRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface QueryRulesDeleteRulesetRequest extends <> {
   ruleset_id: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `QueryRulesDeleteRulesetResponse` +==== QueryRulesDeleteRulesetResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type QueryRulesDeleteRulesetResponse = <>
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-query_rules-get_rule.asciidoc b/docs/reference-query_rules-get_rule.asciidoc index 02b9a9f1e..7c6ef229b 100644 --- a/docs/reference-query_rules-get_rule.asciidoc +++ b/docs/reference-query_rules-get_rule.asciidoc @@ -41,21 +41,31 @@ Returns the details about a query rule within a query ruleset ---- [discrete] -===== `QueryRulesGetRuleRequest` +==== QueryRulesGetRuleRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface QueryRulesGetRuleRequest extends <> {
   ruleset_id: <>
   rule_id: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `QueryRulesGetRuleResponse` +==== QueryRulesGetRuleResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type QueryRulesGetRuleResponse = QueryRulesQueryRule
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-query_rules-get_ruleset.asciidoc b/docs/reference-query_rules-get_ruleset.asciidoc index 498f9bdd2..8b09de86e 100644 --- a/docs/reference-query_rules-get_ruleset.asciidoc +++ b/docs/reference-query_rules-get_ruleset.asciidoc @@ -41,20 +41,30 @@ Returns the details about a query ruleset ---- [discrete] -===== `QueryRulesGetRulesetRequest` +==== QueryRulesGetRulesetRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface QueryRulesGetRulesetRequest extends <> {
   ruleset_id: <>
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `QueryRulesGetRulesetResponse` +==== QueryRulesGetRulesetResponse -[source,ts] ----- +[pass] +++++ +
+++++
 type QueryRulesGetRulesetResponse = QueryRulesQueryRuleset
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-query_rules-list_rulesets.asciidoc b/docs/reference-query_rules-list_rulesets.asciidoc index 0952cbd3b..d6eb9a92a 100644 --- a/docs/reference-query_rules-list_rulesets.asciidoc +++ b/docs/reference-query_rules-list_rulesets.asciidoc @@ -41,24 +41,34 @@ Returns summarized information about existing query rulesets. ---- [discrete] -===== `QueryRulesListRulesetsRequest` +==== QueryRulesListRulesetsRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface QueryRulesListRulesetsRequest extends <> {
-  from?: <>
-  size?: <>
+  from?: number
+  size?: number
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `QueryRulesListRulesetsResponse` +==== QueryRulesListRulesetsResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface QueryRulesListRulesetsResponse {
-  count: <>
+  count: number
   results: QueryRulesListRulesetsQueryRulesetListItem[]
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-query_rules-put_rule.asciidoc b/docs/reference-query_rules-put_rule.asciidoc index 8fa094e17..4c60e7fc1 100644 --- a/docs/reference-query_rules-put_rule.asciidoc +++ b/docs/reference-query_rules-put_rule.asciidoc @@ -41,27 +41,37 @@ Creates or updates a query rule within a query ruleset. ---- [discrete] -===== `QueryRulesPutRuleRequest` +==== QueryRulesPutRuleRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface QueryRulesPutRuleRequest extends <> {
   ruleset_id: <>
   rule_id: <>
   type: QueryRulesQueryRuleType
   criteria: QueryRulesQueryRuleCriteria | QueryRulesQueryRuleCriteria[]
   actions: QueryRulesQueryRuleActions
-  priority?: <>
+  priority?: number
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `QueryRulesPutRuleResponse` +==== QueryRulesPutRuleResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface QueryRulesPutRuleResponse {
   result: <>
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-query_rules-put_ruleset.asciidoc b/docs/reference-query_rules-put_ruleset.asciidoc index 74f0f16cb..297be4384 100644 --- a/docs/reference-query_rules-put_ruleset.asciidoc +++ b/docs/reference-query_rules-put_ruleset.asciidoc @@ -41,23 +41,33 @@ Creates or updates a query ruleset. ---- [discrete] -===== `QueryRulesPutRulesetRequest` +==== QueryRulesPutRulesetRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface QueryRulesPutRulesetRequest extends <> {
   ruleset_id: <>
   rules: QueryRulesQueryRule | QueryRulesQueryRule[]
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `QueryRulesPutRulesetResponse` +==== QueryRulesPutRulesetResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface QueryRulesPutRulesetResponse {
   result: <>
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-query_rules-test.asciidoc b/docs/reference-query_rules-test.asciidoc index 21a51b28d..87f6a375d 100644 --- a/docs/reference-query_rules-test.asciidoc +++ b/docs/reference-query_rules-test.asciidoc @@ -41,24 +41,34 @@ Creates or updates a query ruleset. ---- [discrete] -===== `QueryRulesTestRequest` +==== QueryRulesTestRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface QueryRulesTestRequest extends <> {
   ruleset_id: <>
   match_criteria: Record
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `QueryRulesTestResponse` +==== QueryRulesTestResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface QueryRulesTestResponse {
-  total_matched_rules: <>
+  total_matched_rules: number
   matched_rules: QueryRulesTestQueryRulesetMatchedRule[]
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-rank_eval.asciidoc b/docs/reference-rank_eval.asciidoc index e5642685f..d4e45d66f 100644 --- a/docs/reference-rank_eval.asciidoc +++ b/docs/reference-rank_eval.asciidoc @@ -41,10 +41,12 @@ Evaluate ranked search results. Evaluate the quality of ranked search results ov ---- [discrete] -===== `RankEvalRequest` +==== RankEvalRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface RankEvalRequest extends <> {
   index?: <>
   allow_no_indices?: boolean
@@ -54,17 +56,25 @@ interface RankEvalRequest extends <> {
   requests: RankEvalRankEvalRequestItem[]
   metric?: RankEvalRankEvalMetric
 }
-----
 
+[pass]
+++++
+
+++++ [discrete] -===== `RankEvalResponse` +==== RankEvalResponse -[source,ts] ----- +[pass] +++++ +
+++++
 interface RankEvalResponse {
-  metric_score: <>
+  metric_score: number
   details: Record<<>, RankEvalRankEvalMetricDetail>
   failures: Record
 }
-----
 
+[pass]
+++++
+
+++++ diff --git a/docs/reference-reindex.asciidoc b/docs/reference-reindex.asciidoc index f0bac428c..46b1a0a99 100644 --- a/docs/reference-reindex.asciidoc +++ b/docs/reference-reindex.asciidoc @@ -41,13 +41,15 @@ Reindex documents. Copies documents from a source to a destination. The source c ---- [discrete] -===== `ReindexRequest` +==== ReindexRequest -[source,ts] ----- +[pass] +++++ +
+++++
 interface ReindexRequest extends <> {
   refresh?: boolean
-  requests_per_second?: <>
+  requests_per_second?: number
   scroll?: <>
   slices?: <>
   timeout?: <>
@@ -56,35 +58,43 @@ interface ReindexRequest extends <> {
   require_alias?: boolean
   conflicts?: <>
   dest: ReindexDestination
-  max_docs?: <>
+  max_docs?: number
   script?: <