Skip to content

Commit

Permalink
[codegen] updated to latest api spec
Browse files Browse the repository at this point in the history
  • Loading branch information
l-trotta committed Aug 1, 2024
1 parent 23ac082 commit 79754d0
Show file tree
Hide file tree
Showing 41 changed files with 2,956 additions and 908 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -59,15 +59,11 @@
/**
* Get aliases. Retrieves the cluster’s index aliases, including filter and
* routing information. The API does not return data stream aliases.
* <blockquote>
* <p>
* info CAT APIs are only intended for human consumption using the command line
* or the Kibana console. They are not intended for use by applications. For
* application consumption, use <a href="#endpoint-alias">the /_alias
* endpoints</a>.
* </p>
* </blockquote>
*
* CAT APIs are only intended for human consumption using the command line or
* the Kibana console. They are not intended for use by applications. For
* application consumption, use the /_alias endpoints.
*
* @see <a href="../doc-files/api-spec.html#cat.aliases.Request">API
* specification</a>
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -55,15 +55,12 @@
/**
* Get component templates. Returns information about component templates in a
* cluster. Component templates are building blocks for constructing index
* templates that specify index mappings, settings, and aliases. <blockquote>
* templates that specify index mappings, settings, and aliases.
* <p>
* info CAT APIs are only intended for human consumption using the command line
* or Kibana console. They are not intended for use by applications. For
* application consumption, use <a href="#endpoint-component-template">the
* /_component_template endpoints</a>.
* </p>
* </blockquote>
*
* CAT APIs are only intended for human consumption using the command line or
* Kibana console. They are not intended for use by applications. For
* application consumption, use the /_component_template endpoints.
*
* @see <a href="../doc-files/api-spec.html#cat.component_templates.Request">API
* specification</a>
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -59,15 +59,12 @@
* Get a document count. Provides quick access to a document count for a data
* stream, an index, or an entire cluster.n/ The document count only includes
* live documents, not deleted documents which have not yet been removed by the
* merge process. <blockquote>
* merge process.
* <p>
* info CAT APIs are only intended for human consumption using the command line
* or Kibana console. They are not intended for use by applications. For
* application consumption, use <a href="#endpoint-count">the /_count
* endpoints</a>.
* </p>
* </blockquote>
*
* CAT APIs are only intended for human consumption using the command line or
* Kibana console. They are not intended for use by applications. For
* application consumption, use /_count endpoints.
*
* @see <a href="../doc-files/api-spec.html#cat.count.Request">API
* specification</a>
*/
Expand Down

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -62,13 +62,7 @@

/**
* Get index information. Returns high-level information about indices in a
* cluster, including backing indices for data streams. <blockquote>
* <p>
* info CAT APIs are only intended for human consumption using the command line
* or Kibana console. They are not intended for use by applications. For
* application consumption, use an index endpoint.
* </p>
* </blockquote>
* cluster, including backing indices for data streams.
* <p>
* Use this request to get the following information for each index in a
* cluster:
Expand All @@ -83,8 +77,11 @@
* These metrics are retrieved directly from Lucene, which Elasticsearch uses
* internally to power indexing and search. As a result, all document counts
* include hidden nested documents. To get an accurate count of Elasticsearch
* documents, use the <a href="#operation-cat-count">/_cat/count</a> or
* <a href="#endpoint-count">count</a> endpoints.
* documents, use the /_cat/count or _count endpoints.
* <p>
* CAT APIs are only intended for human consumption using the command line or
* Kibana console. They are not intended for use by applications. For
* application consumption, use an index endpoint.
*
* @see <a href="../doc-files/api-spec.html#cat.indices.Request">API
* specification</a>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -60,15 +60,12 @@

/**
* Get data frame analytics jobs. Returns configuration and usage information
* about data frame analytics jobs. <blockquote>
* about data frame analytics jobs.
* <p>
* info CAT APIs are only intended for human consumption using the Kibana
* console or command line. They are not intended for use by applications. For
* application consumption, use <a href="#endpoint-ml">the
* /_ml/data_frame/analytics endpoints</a>.
* </p>
* </blockquote>
*
* CAT APIs are only intended for human consumption using the Kibana console or
* command line. They are not intended for use by applications. For application
* consumption, use the /_ml/data_frame/analytics endpoints.
*
* @see <a href=
* "../doc-files/api-spec.html#cat.ml_data_frame_analytics.Request">API
* specification</a>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -62,15 +62,12 @@
* This API returns a maximum of 10,000 datafeeds. If the Elasticsearch security
* features are enabled, you must have <code>monitor_ml</code>,
* <code>monitor</code>, <code>manage_ml</code>, or <code>manage</code> cluster
* privileges to use this API. <blockquote>
* privileges to use this API.
* <p>
* info CAT APIs are only intended for human consumption using the Kibana
* console or command line. They are not intended for use by applications. For
* application consumption, use <a href="#endpoint-ml">the /_ml/datafeeds
* endpoints</a>.
* </p>
* </blockquote>
*
* CAT APIs are only intended for human consumption using the Kibana console or
* command line. They are not intended for use by applications. For application
* consumption, use the /_ml/datafeeds endpoints.
*
* @see <a href="../doc-files/api-spec.html#cat.ml_datafeeds.Request">API
* specification</a>
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -63,15 +63,12 @@
* anomaly detection jobs. This API returns a maximum of 10,000 jobs. If the
* Elasticsearch security features are enabled, you must have
* <code>monitor_ml</code>, <code>monitor</code>, <code>manage_ml</code>, or
* <code>manage</code> cluster privileges to use this API. <blockquote>
* <code>manage</code> cluster privileges to use this API.
* <p>
* info CAT APIs are only intended for human consumption using the Kibana
* console or command line. They are not intended for use by applications. For
* application consumption, use <a href="#endpoint-ml">the
* /_ml/anomaly_detectors endpoints</a>.
* </p>
* </blockquote>
*
* CAT APIs are only intended for human consumption using the Kibana console or
* command line. They are not intended for use by applications. For application
* consumption, use the /_ml/anomaly_detectors endpoints.
*
* @see <a href="../doc-files/api-spec.html#cat.ml_jobs.Request">API
* specification</a>
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -60,15 +60,12 @@

/**
* Get trained models. Returns configuration and usage information about
* inference trained models. <blockquote>
* inference trained models.
* <p>
* info CAT APIs are only intended for human consumption using the Kibana
* console or command line. They are not intended for use by applications. For
* application consumption, use <a href="#endpoint-ml">the /_ml/trained_models
* endpoints</a>.
* </p>
* </blockquote>
*
* CAT APIs are only intended for human consumption using the Kibana console or
* command line. They are not intended for use by applications. For application
* consumption, use the /_ml/trained_models endpoints.
*
* @see <a href="../doc-files/api-spec.html#cat.ml_trained_models.Request">API
* specification</a>
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -60,15 +60,11 @@

/**
* Get transforms. Returns configuration and usage information about transforms.
* <blockquote>
* <p>
* info CAT APIs are only intended for human consumption using the Kibana
* console or command line. They are not intended for use by applications. For
* application consumption, use <a href="#endpoint-transform">the /_transform
* endpoints</a>.
* </p>
* </blockquote>
*
* CAT APIs are only intended for human consumption using the Kibana console or
* command line. They are not intended for use by applications. For application
* consumption, use the /_transform endpoints.
*
* @see <a href="../doc-files/api-spec.html#cat.transforms.Request">API
* specification</a>
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -986,15 +986,15 @@
'cat.master.Request': 'cat/master/CatMasterRequest.ts#L22-L31',
'cat.master.Response': 'cat/master/CatMasterResponse.ts#L22-L24',
'cat.ml_data_frame_analytics.DataFrameAnalyticsRecord': 'cat/ml_data_frame_analytics/types.ts#L22-L102',
'cat.ml_data_frame_analytics.Request': 'cat/ml_data_frame_analytics/CatDataFrameAnalyticsRequest.ts#L24-L60',
'cat.ml_data_frame_analytics.Request': 'cat/ml_data_frame_analytics/CatDataFrameAnalyticsRequest.ts#L24-L59',
'cat.ml_data_frame_analytics.Response': 'cat/ml_data_frame_analytics/CatDataFrameAnalyticsResponse.ts#L22-L24',
'cat.ml_datafeeds.DatafeedsRecord': 'cat/ml_datafeeds/types.ts#L22-L87',
'cat.ml_datafeeds.Request': 'cat/ml_datafeeds/CatDatafeedsRequest.ts#L24-L75',
'cat.ml_datafeeds.Request': 'cat/ml_datafeeds/CatDatafeedsRequest.ts#L24-L74',
'cat.ml_datafeeds.Response': 'cat/ml_datafeeds/CatDatafeedsResponse.ts#L22-L24',
'cat.ml_jobs.JobsRecord': 'cat/ml_jobs/types.ts#L24-L347',
'cat.ml_jobs.Request': 'cat/ml_jobs/CatJobsRequest.ts#L24-L79',
'cat.ml_jobs.Request': 'cat/ml_jobs/CatJobsRequest.ts#L24-L78',
'cat.ml_jobs.Response': 'cat/ml_jobs/CatJobsResponse.ts#L22-L24',
'cat.ml_trained_models.Request': 'cat/ml_trained_models/CatTrainedModelsRequest.ts#L24-L65',
'cat.ml_trained_models.Request': 'cat/ml_trained_models/CatTrainedModelsRequest.ts#L24-L64',
'cat.ml_trained_models.Response': 'cat/ml_trained_models/CatTrainedModelsResponse.ts#L22-L24',
'cat.ml_trained_models.TrainedModelsRecord': 'cat/ml_trained_models/types.ts#L23-L115',
'cat.nodeattrs.NodeAttributesRecord': 'cat/nodeattrs/types.ts#L20-L55',
Expand Down Expand Up @@ -1033,7 +1033,7 @@
'cat.thread_pool.Request': 'cat/thread_pool/CatThreadPoolRequest.ts#L24-L48',
'cat.thread_pool.Response': 'cat/thread_pool/CatThreadPoolResponse.ts#L22-L24',
'cat.thread_pool.ThreadPoolRecord': 'cat/thread_pool/types.ts#L22-L124',
'cat.transforms.Request': 'cat/transforms/CatTransformsRequest.ts#L25-L79',
'cat.transforms.Request': 'cat/transforms/CatTransformsRequest.ts#L25-L78',
'cat.transforms.Response': 'cat/transforms/CatTransformsResponse.ts#L22-L24',
'cat.transforms.TransformsRecord': 'cat/transforms/types.ts#L22-L197',
'ccr._types.FollowIndexStats': 'ccr/_types/FollowIndexStats.ts#L30-L33',
Expand Down Expand Up @@ -1303,12 +1303,20 @@
'graph._types.VertexInclude': 'graph/_types/Vertex.ts#L61-L64',
'graph.explore.Request': 'graph/explore/GraphExploreRequest.ts#L28-L72',
'graph.explore.Response': 'graph/explore/GraphExploreResponse.ts#L25-L33',
'ilm._types.Configurations': 'ilm/_types/Phase.ts#L50-L54',
'ilm._types.ForceMergeConfiguration': 'ilm/_types/Phase.ts#L56-L58',
'ilm._types.Phase': 'ilm/_types/Phase.ts#L25-L36',
'ilm._types.Phases': 'ilm/_types/Phase.ts#L38-L44',
'ilm._types.Actions': 'ilm/_types/Phase.ts#L42-L91',
'ilm._types.AllocateAction': 'ilm/_types/Phase.ts#L131-L137',
'ilm._types.DeleteAction': 'ilm/_types/Phase.ts#L147-L149',
'ilm._types.DownsampleAction': 'ilm/_types/Phase.ts#L110-L113',
'ilm._types.ForceMergeAction': 'ilm/_types/Phase.ts#L121-L124',
'ilm._types.MigrateAction': 'ilm/_types/Phase.ts#L139-L141',
'ilm._types.Phase': 'ilm/_types/Phase.ts#L26-L32',
'ilm._types.Phases': 'ilm/_types/Phase.ts#L34-L40',
'ilm._types.Policy': 'ilm/_types/Policy.ts#L23-L26',
'ilm._types.ShrinkConfiguration': 'ilm/_types/Phase.ts#L60-L62',
'ilm._types.RolloverAction': 'ilm/_types/Phase.ts#L97-L108',
'ilm._types.SearchableSnapshotAction': 'ilm/_types/Phase.ts#L126-L129',
'ilm._types.SetPriorityAction': 'ilm/_types/Phase.ts#L93-L95',
'ilm._types.ShrinkAction': 'ilm/_types/Phase.ts#L115-L119',
'ilm._types.WaitForSnapshotAction': 'ilm/_types/Phase.ts#L143-L145',
'ilm.delete_lifecycle.Request': 'ilm/delete_lifecycle/DeleteLifecycleRequest.ts#L24-L51',
'ilm.delete_lifecycle.Response': 'ilm/delete_lifecycle/DeleteLifecycleResponse.ts#L22-L24',
'ilm.explain_lifecycle.LifecycleExplain': 'ilm/explain_lifecycle/types.ts#L59-L62',
Expand Down Expand Up @@ -1890,11 +1898,11 @@
'ml._types.Vocabulary': 'ml/_types/inference.ts#L233-L235',
'ml._types.ZeroShotClassificationInferenceOptions': 'ml/_types/inference.ts#L201-L222',
'ml._types.ZeroShotClassificationInferenceUpdateOptions': 'ml/_types/inference.ts#L374-L383',
'ml.clear_trained_model_deployment_cache.Request': 'ml/clear_trained_model_deployment_cache/MlClearTrainedModelDeploymentCacheRequest.ts#L25-L42',
'ml.clear_trained_model_deployment_cache.Request': 'ml/clear_trained_model_deployment_cache/MlClearTrainedModelDeploymentCacheRequest.ts#L25-L43',
'ml.clear_trained_model_deployment_cache.Response': 'ml/clear_trained_model_deployment_cache/MlClearTrainedModelDeploymentCacheResponse.ts#L20-L24',
'ml.close_job.Request': 'ml/close_job/MlCloseJobRequest.ts#L24-L77',
'ml.close_job.Response': 'ml/close_job/MlCloseJobResponse.ts#L20-L22',
'ml.delete_calendar.Request': 'ml/delete_calendar/MlDeleteCalendarRequest.ts#L23-L36',
'ml.delete_calendar.Request': 'ml/delete_calendar/MlDeleteCalendarRequest.ts#L23-L37',
'ml.delete_calendar.Response': 'ml/delete_calendar/MlDeleteCalendarResponse.ts#L22-L24',
'ml.delete_calendar_event.Request': 'ml/delete_calendar_event/MlDeleteCalendarEventRequest.ts#L23-L42',
'ml.delete_calendar_event.Response': 'ml/delete_calendar_event/MlDeleteCalendarEventResponse.ts#L22-L24',
Expand All @@ -1918,7 +1926,7 @@
'ml.delete_trained_model.Response': 'ml/delete_trained_model/MlDeleteTrainedModelResponse.ts#L22-L24',
'ml.delete_trained_model_alias.Request': 'ml/delete_trained_model_alias/MlDeleteTrainedModelAliasRequest.ts#L23-L44',
'ml.delete_trained_model_alias.Response': 'ml/delete_trained_model_alias/MlDeleteTrainedModelAliasResponse.ts#L22-L24',
'ml.estimate_model_memory.Request': 'ml/estimate_model_memory/MlEstimateModelMemoryRequest.ts#L26-L61',
'ml.estimate_model_memory.Request': 'ml/estimate_model_memory/MlEstimateModelMemoryRequest.ts#L26-L62',
'ml.estimate_model_memory.Response': 'ml/estimate_model_memory/MlEstimateModelMemoryResponse.ts#L20-L24',
'ml.evaluate_data_frame.ConfusionMatrixItem': 'ml/evaluate_data_frame/types.ts#L125-L130',
'ml.evaluate_data_frame.ConfusionMatrixPrediction': 'ml/evaluate_data_frame/types.ts#L132-L135',
Expand Down Expand Up @@ -2836,10 +2844,10 @@
if (hash.length > 1) {
hash = hash.substring(1);
}
window.location = "https://github.com/elastic/elasticsearch-specification/tree/75481439fa126fbe9699e1d46e90cd9d1b27014e/specification/" + (paths[hash] || "");
window.location = "https://github.com/elastic/elasticsearch-specification/tree/8c1229882b27bb8a9d61460d518c8aeb827e06ff/specification/" + (paths[hash] || "");
</script>
</head>
<body>
Please see the <a href="https://github.com/elastic/elasticsearch-specification/tree/75481439fa126fbe9699e1d46e90cd9d1b27014e/specification/">Elasticsearch API specification</a>.
Please see the <a href="https://github.com/elastic/elasticsearch-specification/tree/8c1229882b27bb8a9d61460d518c8aeb827e06ff/specification/">Elasticsearch API specification</a>.
</body>
</html>
Loading

0 comments on commit 79754d0

Please sign in to comment.