Skip to content

Commit 834995f

Browse files
Add indices.get_data_lifecycle_stats (#3418) (#3482)
Co-authored-by: Josh Mock <[email protected]> Co-authored-by: Florian Bernd <[email protected]> (cherry picked from commit bc0cb5b) Co-authored-by: Lisa Cawley <[email protected]>
1 parent 5cea09e commit 834995f

File tree

9 files changed

+413
-0
lines changed

9 files changed

+413
-0
lines changed

docs/overlays/elasticsearch-openapi-overlays.yaml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -394,6 +394,7 @@ actions:
394394
examples:
395395
indicesLegacyPutTemplateRequestExample1:
396396
$ref: "../../specification/indices/put_template/indicesPutTemplateRequestExample1.yaml"
397+
397398
## Examples for behavioral analytics
398399
- target: "$.paths['/_application/analytics/{collection_name}/event/{event_type}']['post']"
399400
description: "Add examples for post analytics collection event operation"
@@ -404,6 +405,17 @@ actions:
404405
examples:
405406
postBehavioralAnalyticsEventRequestExample1:
406407
$ref: "../../specification/search_application/post_behavioral_analytics_event/BehavioralAnalyticsEventPostRequestExample1.yaml"
408+
## Examples for indices
409+
- target: "$.paths['/_lifecycle/stats']['get']"
410+
description: "Add examples for get lifecycle stats operation"
411+
update:
412+
responses:
413+
200:
414+
content:
415+
application/json:
416+
examples:
417+
dataStreamLifecycleStatsResponseExample1:
418+
$ref: "../../specification/indices/get_data_lifecycle_stats/examples/response/IndicesGetDataLifecycleStatsResponseExample1.yaml"
407419
## Examples for licensing
408420
- target: "$.paths['/_license/basic_status']['get']"
409421
description: "Add example for get basic status response"

output/openapi/elasticsearch-openapi.json

Lines changed: 67 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

output/schema/schema.json

Lines changed: 189 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

output/typescript/types.ts

Lines changed: 16 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

specification/_doc_ids/table.csv

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -124,6 +124,7 @@ dangling-index-delete,https://www.elastic.co/guide/en/elasticsearch/reference/{b
124124
dangling-index-import,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/dangling-index-import.html
125125
dangling-indices-list,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/dangling-indices-list.html
126126
data-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/date-processor.html
127+
data-stream-lifecycle-stats,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/data-streams-get-lifecycle-stats.html
127128
data-stream-path-param,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-create-data-stream.html#indices-create-data-stream-api-path-params
128129
data-streams,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/data-streams.html
129130
date-index-name-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/date-index-name-processor.html
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
{
2+
"indices.get_data_lifecycle_stats": {
3+
"documentation": {
4+
"url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams-get-lifecycle-stats.html",
5+
"description": "Get data stream lifecycle statistics."
6+
},
7+
"stability": "stable",
8+
"visibility": "public",
9+
"headers": {
10+
"accept": ["application/json"]
11+
},
12+
"url": {
13+
"paths": [
14+
{
15+
"path": "/_lifecycle/stats",
16+
"methods": ["GET"]
17+
}
18+
]
19+
}
20+
}
21+
}
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
/*
2+
* Licensed to Elasticsearch B.V. under one or more contributor
3+
* license agreements. See the NOTICE file distributed with
4+
* this work for additional information regarding copyright
5+
* ownership. Elasticsearch B.V. licenses this file to you under
6+
* the Apache License, Version 2.0 (the "License"); you may
7+
* not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing,
13+
* software distributed under the License is distributed on an
14+
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15+
* KIND, either express or implied. See the License for the
16+
* specific language governing permissions and limitations
17+
* under the License.
18+
*/
19+
20+
import { RequestBase } from '@_types/Base'
21+
22+
/**
23+
* Get data stream lifecycle stats.
24+
* Get statistics about the data streams that are managed by a data stream lifecycle.
25+
* @rest_spec_name indices.get_data_lifecycle_stats
26+
* @availability stack since=8.12.0 stability=stable
27+
* @cluster_privileges monitor
28+
* @doc_tag data stream
29+
* @doc_id data-stream-lifecycle-stats
30+
*/
31+
export interface Request extends RequestBase {}

0 commit comments

Comments
 (0)