From 27873b56f31945f473de4120318dab0aecf87fe8 Mon Sep 17 00:00:00 2001 From: Lisa Cawley Date: Mon, 16 Dec 2024 17:00:32 -0800 Subject: [PATCH] [DOCS] Fix monitoring operation summary and visibility (#3301) (cherry picked from commit 7cf7656ca1ce195f08b70aa4a97a947a250a3068) --- output/openapi/elasticsearch-openapi.json | 12 ++++++++---- output/schema/schema.json | 9 +++++---- .../monitoring/bulk/BulkMonitoringRequest.ts | 4 +++- 3 files changed, 16 insertions(+), 9 deletions(-) diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index dab4c1c175..d8ee3351c7 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -22526,7 +22526,8 @@ "tags": [ "monitoring" ], - "summary": "Used by the monitoring features to send monitoring data", + "summary": "Send monitoring data", + "description": "This API is used by the monitoring features to send monitoring data.", "operationId": "monitoring-bulk-1", "parameters": [ { @@ -22553,7 +22554,8 @@ "tags": [ "monitoring" ], - "summary": "Used by the monitoring features to send monitoring data", + "summary": "Send monitoring data", + "description": "This API is used by the monitoring features to send monitoring data.", "operationId": "monitoring-bulk", "parameters": [ { @@ -22582,7 +22584,8 @@ "tags": [ "monitoring" ], - "summary": "Used by the monitoring features to send monitoring data", + "summary": "Send monitoring data", + "description": "This API is used by the monitoring features to send monitoring data.", "operationId": "monitoring-bulk-3", "parameters": [ { @@ -22612,7 +22615,8 @@ "tags": [ "monitoring" ], - "summary": "Used by the monitoring features to send monitoring data", + "summary": "Send monitoring data", + "description": "This API is used by the monitoring features to send monitoring data.", "operationId": "monitoring-bulk-2", "parameters": [ { diff --git a/output/schema/schema.json b/output/schema/schema.json index c713a96855..ed5c9e7642 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -12955,10 +12955,11 @@ "availability": { "stack": { "since": "6.3.0", - "stability": "stable" + "stability": "stable", + "visibility": "private" } }, - "description": "Used by the monitoring features to send monitoring data.", + "description": "Send monitoring data.\nThis API is used by the monitoring features to send monitoring data.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/monitor-elasticsearch-cluster.html", "name": "monitoring.bulk", "request": { @@ -174932,7 +174933,7 @@ } } }, - "description": "Used by the monitoring features to send monitoring data.", + "description": "Send monitoring data.\nThis API is used by the monitoring features to send monitoring data.", "generics": [ { "name": "TDocument", @@ -175009,7 +175010,7 @@ } } ], - "specLocation": "monitoring/bulk/BulkMonitoringRequest.ts#L24-L59" + "specLocation": "monitoring/bulk/BulkMonitoringRequest.ts#L24-L61" }, { "kind": "response", diff --git a/specification/monitoring/bulk/BulkMonitoringRequest.ts b/specification/monitoring/bulk/BulkMonitoringRequest.ts index b991d9010e..90346fa55b 100644 --- a/specification/monitoring/bulk/BulkMonitoringRequest.ts +++ b/specification/monitoring/bulk/BulkMonitoringRequest.ts @@ -22,8 +22,10 @@ import { RequestBase } from '@_types/Base' import { Duration } from '@_types/Time' /** + * Send monitoring data. + * This API is used by the monitoring features to send monitoring data. * @rest_spec_name monitoring.bulk - * @availability stack since=6.3.0 stability=stable + * @availability stack since=6.3.0 stability=stable visibility=private */ export interface Request extends RequestBase { path_parts: {