Skip to content

Commit

Permalink
Add indices.get_data_lifecycle_stats (#3418)
Browse files Browse the repository at this point in the history
Co-authored-by: Josh Mock <[email protected]>
Co-authored-by: Florian Bernd <[email protected]>
  • Loading branch information
3 people authored Jan 8, 2025
1 parent fd32ef0 commit bc0cb5b
Show file tree
Hide file tree
Showing 9 changed files with 413 additions and 0 deletions.
12 changes: 12 additions & 0 deletions docs/overlays/elasticsearch-openapi-overlays.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -394,6 +394,7 @@ actions:
examples:
indicesLegacyPutTemplateRequestExample1:
$ref: "../../specification/indices/put_template/indicesPutTemplateRequestExample1.yaml"

## Examples for behavioral analytics
- target: "$.paths['/_application/analytics/{collection_name}/event/{event_type}']['post']"
description: "Add examples for post analytics collection event operation"
Expand All @@ -404,6 +405,17 @@ actions:
examples:
postBehavioralAnalyticsEventRequestExample1:
$ref: "../../specification/search_application/post_behavioral_analytics_event/BehavioralAnalyticsEventPostRequestExample1.yaml"
## Examples for indices
- target: "$.paths['/_lifecycle/stats']['get']"
description: "Add examples for get lifecycle stats operation"
update:
responses:
200:
content:
application/json:
examples:
dataStreamLifecycleStatsResponseExample1:
$ref: "../../specification/indices/get_data_lifecycle_stats/examples/response/IndicesGetDataLifecycleStatsResponseExample1.yaml"
## Examples for licensing
- target: "$.paths['/_license/basic_status']['get']"
description: "Add example for get basic status response"
Expand Down
67 changes: 67 additions & 0 deletions output/openapi/elasticsearch-openapi.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

189 changes: 189 additions & 0 deletions output/schema/schema.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

16 changes: 16 additions & 0 deletions output/typescript/types.ts

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions specification/_doc_ids/table.csv
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,7 @@ dangling-index-delete,https://www.elastic.co/guide/en/elasticsearch/reference/{b
dangling-index-import,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/dangling-index-import.html
dangling-indices-list,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/dangling-indices-list.html
data-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/date-processor.html
data-stream-lifecycle-stats,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/data-streams-get-lifecycle-stats.html
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
data-streams,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/data-streams.html
date-index-name-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/date-index-name-processor.html
Expand Down
21 changes: 21 additions & 0 deletions specification/_json_spec/indices.get_data_lifecycle_stats.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
{
"indices.get_data_lifecycle_stats": {
"documentation": {
"url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams-get-lifecycle-stats.html",
"description": "Get data stream lifecycle statistics."
},
"stability": "stable",
"visibility": "public",
"headers": {
"accept": ["application/json"]
},
"url": {
"paths": [
{
"path": "/_lifecycle/stats",
"methods": ["GET"]
}
]
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
/*
* Licensed to Elasticsearch B.V. under one or more contributor
* license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright
* ownership. Elasticsearch B.V. licenses this file to you under
* the Apache License, Version 2.0 (the "License"); you may
* not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/

import { RequestBase } from '@_types/Base'

/**
* Get data stream lifecycle stats.
* Get statistics about the data streams that are managed by a data stream lifecycle.
* @rest_spec_name indices.get_data_lifecycle_stats
* @availability stack since=8.12.0 stability=stable
* @cluster_privileges monitor
* @doc_tag data stream
* @doc_id data-stream-lifecycle-stats
*/
export interface Request extends RequestBase {}
Loading

0 comments on commit bc0cb5b

Please sign in to comment.