From bb2d87c0c2ae9f3f06a974986e67f78b7dee7769 Mon Sep 17 00:00:00 2001 From: Tim Vernum Date: Thu, 10 Aug 2023 12:56:43 +1000 Subject: [PATCH] Update visibility for serverless This commit reconciles the spec against the server implementation. The specification's '@available serverless' annotations now match the @ServerlessScope annotations in the Elasticsearch Java code. --- .../DeleteByQueryRethrottleRequest.ts | 1 + specification/_global/explain/ExplainRequest.ts | 1 + specification/_global/health_report/Request.ts | 1 + specification/_global/reindex/ReindexRequest.ts | 1 + .../_global/reindex_rethrottle/ReindexRethrottleRequest.ts | 1 + specification/_global/search_mvt/SearchMvtRequest.ts | 1 + .../UpdateByQueryRethrottleRequest.ts | 1 + specification/cat/health/CatHealthRequest.ts | 1 + specification/cat/recovery/CatRecoveryRequest.ts | 1 + specification/cat/repositories/CatRepositoriesRequest.ts | 1 + specification/cluster/get_settings/ClusterGetSettingsRequest.ts | 2 +- .../cluster/pending_tasks/ClusterPendingTasksRequest.ts | 2 +- specification/cluster/put_settings/ClusterPutSettingsRequest.ts | 2 +- specification/cluster/stats/ClusterStatsRequest.ts | 2 +- specification/eql/delete/EqlDeleteRequest.ts | 1 + specification/eql/get/EqlGetRequest.ts | 1 + specification/eql/get_status/EqlGetStatusRequest.ts | 1 + specification/eql/search/EqlSearchRequest.ts | 1 + specification/features/reset_features/ResetFeaturesRequest.ts | 1 + specification/indices/add_block/IndicesAddBlockRequest.ts | 1 + .../indices/clear_cache/IndicesIndicesClearCacheRequest.ts | 1 + .../indices/delete_template/IndicesDeleteTemplateRequest.ts | 1 - specification/indices/disk_usage/IndicesDiskUsageRequest.ts | 2 +- .../indices/exists_template/IndicesExistsTemplateRequest.ts | 1 - .../indices/field_usage_stats/IndicesFieldUsageStatsRequest.ts | 1 + specification/indices/flush/IndicesFlushRequest.ts | 1 + specification/indices/forcemerge/IndicesForceMergeRequest.ts | 1 + specification/indices/get_template/IndicesGetTemplateRequest.ts | 1 - specification/indices/refresh/IndicesRefreshRequest.ts | 1 + specification/indices/segments/IndicesSegmentsRequest.ts | 1 + specification/license/get/GetLicenseRequest.ts | 1 + .../ClearRepositoriesMeteringArchiveRequest.ts | 1 + .../GetRepositoriesMeteringInfoRequest.ts | 1 + .../clear_api_key_cache/SecurityClearApiKeyCacheRequest.ts | 2 +- .../security/has_privileges/SecurityHasPrivilegesRequest.ts | 2 +- .../slm/delete_lifecycle/DeleteSnapshotLifecycleRequest.ts | 1 + .../slm/execute_lifecycle/ExecuteSnapshotLifecycleRequest.ts | 1 + specification/slm/execute_retention/ExecuteRetentionRequest.ts | 1 + specification/slm/get_lifecycle/GetSnapshotLifecycleRequest.ts | 1 + specification/slm/get_stats/GetSnapshotLifecycleStatsRequest.ts | 1 + .../get_status/GetSnapshotLifecycleManagementStatusRequest.ts | 1 + specification/slm/put_lifecycle/PutSnapshotLifecycleRequest.ts | 1 + .../slm/start/StartSnapshotLifecycleManagementRequest.ts | 1 + .../slm/stop/StopSnapshotLifecycleManagementRequest.ts | 1 + .../cleanup_repository/SnapshotCleanupRepositoryRequest.ts | 1 + specification/snapshot/clone/SnapshotCloneRequest.ts | 1 + specification/snapshot/create/SnapshotCreateRequest.ts | 1 + .../create_repository/SnapshotCreateRepositoryRequest.ts | 2 +- specification/snapshot/delete/SnapshotDeleteRequest.ts | 1 + .../delete_repository/SnapshotDeleteRepositoryRequest.ts | 1 + specification/snapshot/get/SnapshotGetRequest.ts | 1 + .../snapshot/get_repository/SnapshotGetRepositoryRequest.ts | 1 + specification/snapshot/restore/SnapshotRestoreRequest.ts | 1 + specification/snapshot/status/SnapshotStatusRequest.ts | 1 + .../verify_repository/SnapshotVerifyRepositoryRequest.ts | 1 + specification/sql/clear_cursor/ClearSqlCursorRequest.ts | 1 + specification/sql/delete_async/SqlDeleteAsyncRequest.ts | 1 + specification/sql/get_async/SqlGetAsyncRequest.ts | 1 + specification/sql/get_async_status/SqlGetAsyncStatusRequest.ts | 1 + specification/sql/query/QuerySqlRequest.ts | 1 + specification/sql/translate/TranslateSqlRequest.ts | 1 + specification/tasks/cancel/CancelTasksRequest.ts | 1 + specification/tasks/get/GetTaskRequest.ts | 1 + specification/tasks/list/ListTasksRequest.ts | 1 + specification/xpack/usage/XPackUsageRequest.ts | 1 + 65 files changed, 62 insertions(+), 11 deletions(-) diff --git a/specification/_global/delete_by_query_rethrottle/DeleteByQueryRethrottleRequest.ts b/specification/_global/delete_by_query_rethrottle/DeleteByQueryRethrottleRequest.ts index 3056fba4b7..8a3f964ab5 100644 --- a/specification/_global/delete_by_query_rethrottle/DeleteByQueryRethrottleRequest.ts +++ b/specification/_global/delete_by_query_rethrottle/DeleteByQueryRethrottleRequest.ts @@ -24,6 +24,7 @@ import { float } from '@_types/Numeric' /** * @rest_spec_name delete_by_query_rethrottle * @availability stack since=6.5.0 stability=stable + * @availability serverless stability=stable visibility=private */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/_global/explain/ExplainRequest.ts b/specification/_global/explain/ExplainRequest.ts index 1e79ba8148..d3b9122147 100644 --- a/specification/_global/explain/ExplainRequest.ts +++ b/specification/_global/explain/ExplainRequest.ts @@ -26,6 +26,7 @@ import { Operator } from '@_types/query_dsl/Operator' /** * @rest_spec_name explain * @availability stack since=0.0.0 stability=stable + * @availability serverless stability=stable visibility=public */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/_global/health_report/Request.ts b/specification/_global/health_report/Request.ts index 122c7e52fe..dad3fdb5ae 100644 --- a/specification/_global/health_report/Request.ts +++ b/specification/_global/health_report/Request.ts @@ -24,6 +24,7 @@ import { Duration } from '@_types/Time' /** * @rest_spec_name health_report * @availability stack since=8.7.0 stability=stable + * @availability serverless stability=stable visibility=private */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/_global/reindex/ReindexRequest.ts b/specification/_global/reindex/ReindexRequest.ts index c5736bf2ae..8570e54e95 100644 --- a/specification/_global/reindex/ReindexRequest.ts +++ b/specification/_global/reindex/ReindexRequest.ts @@ -27,6 +27,7 @@ import { Destination, Source } from './types' /** * @rest_spec_name reindex * @availability stack since=2.3.0 stability=stable + * @availability serverless stability=stable visibility=public */ export interface Request extends RequestBase { query_parameters: { diff --git a/specification/_global/reindex_rethrottle/ReindexRethrottleRequest.ts b/specification/_global/reindex_rethrottle/ReindexRethrottleRequest.ts index 7087131747..b762ce3119 100644 --- a/specification/_global/reindex_rethrottle/ReindexRethrottleRequest.ts +++ b/specification/_global/reindex_rethrottle/ReindexRethrottleRequest.ts @@ -24,6 +24,7 @@ import { float } from '@_types/Numeric' /** * @rest_spec_name reindex_rethrottle * @availability stack since=2.4.0 stability=stable + * @availability serverless stability=stable visibility=private */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/_global/search_mvt/SearchMvtRequest.ts b/specification/_global/search_mvt/SearchMvtRequest.ts index ac8f53831d..47178139ad 100644 --- a/specification/_global/search_mvt/SearchMvtRequest.ts +++ b/specification/_global/search_mvt/SearchMvtRequest.ts @@ -33,6 +33,7 @@ import { TrackHits } from '@global/search/_types/hits' /** * @rest_spec_name search_mvt * @availability stack since=7.15.0 stability=experimental + * @availability serverless stability=experimental visibility=public */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/_global/update_by_query_rethrottle/UpdateByQueryRethrottleRequest.ts b/specification/_global/update_by_query_rethrottle/UpdateByQueryRethrottleRequest.ts index 3024820cc8..f95ee70799 100644 --- a/specification/_global/update_by_query_rethrottle/UpdateByQueryRethrottleRequest.ts +++ b/specification/_global/update_by_query_rethrottle/UpdateByQueryRethrottleRequest.ts @@ -24,6 +24,7 @@ import { float, long } from '@_types/Numeric' /** * @rest_spec_name update_by_query_rethrottle * @availability stack since=6.5.0 stability=stable + * @availability serverless stability=stable visibility=private */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/cat/health/CatHealthRequest.ts b/specification/cat/health/CatHealthRequest.ts index e644d6947d..318dc19c7a 100644 --- a/specification/cat/health/CatHealthRequest.ts +++ b/specification/cat/health/CatHealthRequest.ts @@ -33,6 +33,7 @@ import { TimeUnit } from '@_types/Time' * You also can use the API to track the recovery of a large cluster over a longer period of time. * @rest_spec_name cat.health * @availability stack since=0.0.0 stability=stable + * @availability serverless stability=stable visibility=private * @doc_id cat-health * @cluster_privileges monitor */ diff --git a/specification/cat/recovery/CatRecoveryRequest.ts b/specification/cat/recovery/CatRecoveryRequest.ts index edfdc0a16d..4c8032d686 100644 --- a/specification/cat/recovery/CatRecoveryRequest.ts +++ b/specification/cat/recovery/CatRecoveryRequest.ts @@ -27,6 +27,7 @@ import { Bytes, Indices } from '@_types/common' * IMPORTANT: 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 index recovery API. * @rest_spec_name cat.recovery * @availability stack since=0.0.0 stability=stable + * @availability serverless stability=stable visibility=private * @doc_id cat-recovery * @cluster_privileges monitor * @index_privileges monitor diff --git a/specification/cat/repositories/CatRepositoriesRequest.ts b/specification/cat/repositories/CatRepositoriesRequest.ts index d3e011203b..2ce038260a 100644 --- a/specification/cat/repositories/CatRepositoriesRequest.ts +++ b/specification/cat/repositories/CatRepositoriesRequest.ts @@ -24,6 +24,7 @@ import { CatRequestBase } from '@cat/_types/CatBase' * IMPORTANT: 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 get snapshot repository API. * @rest_spec_name cat.repositories * @availability stack since=2.1.0 stability=stable + * @availability serverless stability=stable visibility=private * @doc_id cat-repositories * @cluster_privileges monitor_snapshot */ diff --git a/specification/cluster/get_settings/ClusterGetSettingsRequest.ts b/specification/cluster/get_settings/ClusterGetSettingsRequest.ts index c226134e32..346827e07f 100644 --- a/specification/cluster/get_settings/ClusterGetSettingsRequest.ts +++ b/specification/cluster/get_settings/ClusterGetSettingsRequest.ts @@ -25,7 +25,7 @@ import { Duration } from '@_types/Time' * By default, it returns only settings that have been explicitly defined. * @rest_spec_name cluster.get_settings * @availability stack since=0.0.0 stability=stable - * @availability serverless stability=stable visibility=public + * @availability serverless stability=stable visibility=private * @cluster_privileges monitor * @doc_id cluster-get-settings */ diff --git a/specification/cluster/pending_tasks/ClusterPendingTasksRequest.ts b/specification/cluster/pending_tasks/ClusterPendingTasksRequest.ts index 4653dbd064..7f2fac4e8a 100644 --- a/specification/cluster/pending_tasks/ClusterPendingTasksRequest.ts +++ b/specification/cluster/pending_tasks/ClusterPendingTasksRequest.ts @@ -27,7 +27,7 @@ import { Duration } from '@_types/Time' * However, if a user-initiated task such as a create index command causes a cluster state update, the activity of this task might be reported by both task api and pending cluster tasks API. * @rest_spec_name cluster.pending_tasks * @availability stack since=0.0.0 stability=stable - * @availability serverless stability=stable visibility=public + * @availability serverless stability=stable visibility=private * @cluster_privileges monitor * @doc_id cluster-pending */ diff --git a/specification/cluster/put_settings/ClusterPutSettingsRequest.ts b/specification/cluster/put_settings/ClusterPutSettingsRequest.ts index dd6078df70..6862e5c377 100644 --- a/specification/cluster/put_settings/ClusterPutSettingsRequest.ts +++ b/specification/cluster/put_settings/ClusterPutSettingsRequest.ts @@ -25,7 +25,7 @@ import { Duration } from '@_types/Time' /** * @rest_spec_name cluster.put_settings * @availability stack since=0.0.0 stability=stable - * @availability serverless stability=stable visibility=public + * @availability serverless stability=stable visibility=private * @doc_id cluster-update-settings */ export interface Request extends RequestBase { diff --git a/specification/cluster/stats/ClusterStatsRequest.ts b/specification/cluster/stats/ClusterStatsRequest.ts index 483902e7c1..171c78ee52 100644 --- a/specification/cluster/stats/ClusterStatsRequest.ts +++ b/specification/cluster/stats/ClusterStatsRequest.ts @@ -26,7 +26,7 @@ import { Duration } from '@_types/Time' * It returns basic index metrics (shard numbers, store size, memory usage) and information about the current nodes that form the cluster (number, roles, os, jvm versions, memory usage, cpu and installed plugins). * @rest_spec_name cluster.stats * @availability stack since=1.3.0 stability=stable - * @availability serverless stability=stable visibility=public + * @availability serverless stability=stable visibility=private * @cluster_privileges monitor * @doc_id cluster-stats */ diff --git a/specification/eql/delete/EqlDeleteRequest.ts b/specification/eql/delete/EqlDeleteRequest.ts index 048f339607..a25a673f7b 100644 --- a/specification/eql/delete/EqlDeleteRequest.ts +++ b/specification/eql/delete/EqlDeleteRequest.ts @@ -25,6 +25,7 @@ import { Id } from '@_types/common' * The API also deletes results for the search. * @rest_spec_name eql.delete * @availability stack since=7.9.0 stability=stable + * @availability serverless stability=stable visibility=public */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/eql/get/EqlGetRequest.ts b/specification/eql/get/EqlGetRequest.ts index 5f6000d0e8..9e492feeff 100644 --- a/specification/eql/get/EqlGetRequest.ts +++ b/specification/eql/get/EqlGetRequest.ts @@ -26,6 +26,7 @@ import { Duration } from '@_types/Time' * @doc_id eql-async-search-api * @rest_spec_name eql.get * @availability stack since=7.9.0 stability=stable + * @availability serverless stability=stable visibility=public */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/eql/get_status/EqlGetStatusRequest.ts b/specification/eql/get_status/EqlGetStatusRequest.ts index 3f8f402f4c..8195defc13 100644 --- a/specification/eql/get_status/EqlGetStatusRequest.ts +++ b/specification/eql/get_status/EqlGetStatusRequest.ts @@ -25,6 +25,7 @@ import { Id } from '@_types/common' * @doc_id eql-async-search-status-api * @rest_spec_name eql.get_status * @availability stack since=7.9.0 stability=stable + * @availability serverless stability=stable visibility=public */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/eql/search/EqlSearchRequest.ts b/specification/eql/search/EqlSearchRequest.ts index 4e1ce3d924..c39b252a05 100644 --- a/specification/eql/search/EqlSearchRequest.ts +++ b/specification/eql/search/EqlSearchRequest.ts @@ -28,6 +28,7 @@ import { ResultPosition } from './types' /** * @rest_spec_name eql.search * @availability stack since=7.9.0 stability=stable + * @availability serverless stability=stable visibility=public */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/features/reset_features/ResetFeaturesRequest.ts b/specification/features/reset_features/ResetFeaturesRequest.ts index 5ba992409b..57911fb39d 100644 --- a/specification/features/reset_features/ResetFeaturesRequest.ts +++ b/specification/features/reset_features/ResetFeaturesRequest.ts @@ -22,5 +22,6 @@ import { RequestBase } from '@_types/Base' /** * @rest_spec_name features.reset_features * @availability stack since=7.12.0 stability=experimental + * @availability serverless stability=experimental visibility=private */ export interface Request extends RequestBase {} diff --git a/specification/indices/add_block/IndicesAddBlockRequest.ts b/specification/indices/add_block/IndicesAddBlockRequest.ts index 834eaf5f8b..d07127c1c0 100644 --- a/specification/indices/add_block/IndicesAddBlockRequest.ts +++ b/specification/indices/add_block/IndicesAddBlockRequest.ts @@ -24,6 +24,7 @@ import { Duration } from '@_types/Time' /** * @rest_spec_name indices.add_block * @availability stack since=7.9.0 stability=stable + * @availability serverless stability=stable visibility=public */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/indices/clear_cache/IndicesIndicesClearCacheRequest.ts b/specification/indices/clear_cache/IndicesIndicesClearCacheRequest.ts index c67b7bf220..6157725e59 100644 --- a/specification/indices/clear_cache/IndicesIndicesClearCacheRequest.ts +++ b/specification/indices/clear_cache/IndicesIndicesClearCacheRequest.ts @@ -25,6 +25,7 @@ import { ExpandWildcards, Fields, Indices } from '@_types/common' * For data streams, the API clears the caches of the stream’s backing indices. * @rest_spec_name indices.clear_cache * @availability stack since=0.0.0 stability=stable + * @availability serverless stability=stable visibility=private */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/indices/delete_template/IndicesDeleteTemplateRequest.ts b/specification/indices/delete_template/IndicesDeleteTemplateRequest.ts index fdc4db4095..c29e6da391 100644 --- a/specification/indices/delete_template/IndicesDeleteTemplateRequest.ts +++ b/specification/indices/delete_template/IndicesDeleteTemplateRequest.ts @@ -25,7 +25,6 @@ import { Duration } from '@_types/Time' * Deletes a legacy index template. * @rest_spec_name indices.delete_template * @availability stack since=0.0.0 stability=stable - * @availability serverless stability=stable visibility=public * @cluster_privileges manage_index_templates,manage */ export interface Request extends RequestBase { diff --git a/specification/indices/disk_usage/IndicesDiskUsageRequest.ts b/specification/indices/disk_usage/IndicesDiskUsageRequest.ts index 899f2f479e..30b4847f59 100644 --- a/specification/indices/disk_usage/IndicesDiskUsageRequest.ts +++ b/specification/indices/disk_usage/IndicesDiskUsageRequest.ts @@ -25,7 +25,7 @@ import { ExpandWildcards, Indices } from '@_types/common' * @doc_id indices-disk-usage * @rest_spec_name indices.disk_usage * @availability stack since=7.15.0 stability=experimental - * @availability serverless stability=experimental visibility=public + * @availability serverless stability=experimental visibility=private */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/indices/exists_template/IndicesExistsTemplateRequest.ts b/specification/indices/exists_template/IndicesExistsTemplateRequest.ts index 8ede189b94..257ebedbe9 100644 --- a/specification/indices/exists_template/IndicesExistsTemplateRequest.ts +++ b/specification/indices/exists_template/IndicesExistsTemplateRequest.ts @@ -24,7 +24,6 @@ import { Duration } from '@_types/Time' /** * @rest_spec_name indices.exists_template * @availability stack since=0.0.0 stability=stable - * @availability serverless stability=stable visibility=public */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/indices/field_usage_stats/IndicesFieldUsageStatsRequest.ts b/specification/indices/field_usage_stats/IndicesFieldUsageStatsRequest.ts index f6365107af..b39ca352ca 100644 --- a/specification/indices/field_usage_stats/IndicesFieldUsageStatsRequest.ts +++ b/specification/indices/field_usage_stats/IndicesFieldUsageStatsRequest.ts @@ -30,6 +30,7 @@ import { Duration } from '@_types/Time' * Returns field usage information for each shard and field of an index. * @rest_spec_name indices.field_usage_stats * @availability stack since=7.15.0 stability=experimental + * @availability serverless stability=experimental visibility=private * @index_privileges manage */ export interface Request extends RequestBase { diff --git a/specification/indices/flush/IndicesFlushRequest.ts b/specification/indices/flush/IndicesFlushRequest.ts index 45331826cb..624a472ad9 100644 --- a/specification/indices/flush/IndicesFlushRequest.ts +++ b/specification/indices/flush/IndicesFlushRequest.ts @@ -25,6 +25,7 @@ import { ExpandWildcards, Indices } from '@_types/common' * @doc_id indices-flush * @rest_spec_name indices.flush * @availability stack since=0.0.0 stability=stable + * @availability serverless stability=stable visibility=private */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/indices/forcemerge/IndicesForceMergeRequest.ts b/specification/indices/forcemerge/IndicesForceMergeRequest.ts index c78d563ce6..6fc604109a 100644 --- a/specification/indices/forcemerge/IndicesForceMergeRequest.ts +++ b/specification/indices/forcemerge/IndicesForceMergeRequest.ts @@ -24,6 +24,7 @@ import { long } from '@_types/Numeric' /** * @rest_spec_name indices.forcemerge * @availability stack since=2.1.0 stability=stable + * @availability serverless stability=stable visibility=private */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/indices/get_template/IndicesGetTemplateRequest.ts b/specification/indices/get_template/IndicesGetTemplateRequest.ts index 8e17d2ce92..be882da183 100644 --- a/specification/indices/get_template/IndicesGetTemplateRequest.ts +++ b/specification/indices/get_template/IndicesGetTemplateRequest.ts @@ -24,7 +24,6 @@ import { Duration } from '@_types/Time' /** * @rest_spec_name indices.get_template * @availability stack since=0.0.0 stability=stable - * @availability serverless stability=stable visibility=public */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/indices/refresh/IndicesRefreshRequest.ts b/specification/indices/refresh/IndicesRefreshRequest.ts index eb26e3cf91..1e6824657b 100644 --- a/specification/indices/refresh/IndicesRefreshRequest.ts +++ b/specification/indices/refresh/IndicesRefreshRequest.ts @@ -23,6 +23,7 @@ import { ExpandWildcards, Indices } from '@_types/common' /** * @rest_spec_name indices.refresh * @availability stack since=0.0.0 stability=stable + * @availability serverless stability=stable visibility=public */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/indices/segments/IndicesSegmentsRequest.ts b/specification/indices/segments/IndicesSegmentsRequest.ts index bce8e99009..15edb75c09 100644 --- a/specification/indices/segments/IndicesSegmentsRequest.ts +++ b/specification/indices/segments/IndicesSegmentsRequest.ts @@ -23,6 +23,7 @@ import { ExpandWildcards, Indices } from '@_types/common' /** * @rest_spec_name indices.segments * @availability stack since=0.0.0 stability=stable + * @availability serverless stability=stable visibility=private */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/license/get/GetLicenseRequest.ts b/specification/license/get/GetLicenseRequest.ts index 9160ac99ae..7ef71200f1 100644 --- a/specification/license/get/GetLicenseRequest.ts +++ b/specification/license/get/GetLicenseRequest.ts @@ -24,6 +24,7 @@ import { RequestBase } from '@_types/Base' * For more information about the different types of licenses, see https://www.elastic.co/subscriptions. * @rest_spec_name license.get * @availability stack since=0.0.0 stability=stable + * @availability serverless stability=stable visibility=public */ export interface Request extends RequestBase { query_parameters: { diff --git a/specification/nodes/clear_repositories_metering_archive/ClearRepositoriesMeteringArchiveRequest.ts b/specification/nodes/clear_repositories_metering_archive/ClearRepositoriesMeteringArchiveRequest.ts index b136714006..2fd9a97560 100644 --- a/specification/nodes/clear_repositories_metering_archive/ClearRepositoriesMeteringArchiveRequest.ts +++ b/specification/nodes/clear_repositories_metering_archive/ClearRepositoriesMeteringArchiveRequest.ts @@ -25,6 +25,7 @@ import { long } from '@_types/Numeric' * You can use this API to clear the archived repositories metering information in the cluster. * @rest_spec_name nodes.clear_repositories_metering_archive * @availability stack since=7.16.0 stability=experimental + * @availability serverless stability=experimental visibility=private * @cluster_privileges monitor, manage */ export interface Request extends RequestBase { diff --git a/specification/nodes/get_repositories_metering_info/GetRepositoriesMeteringInfoRequest.ts b/specification/nodes/get_repositories_metering_info/GetRepositoriesMeteringInfoRequest.ts index 42d4c3081f..0590503ce1 100644 --- a/specification/nodes/get_repositories_metering_info/GetRepositoriesMeteringInfoRequest.ts +++ b/specification/nodes/get_repositories_metering_info/GetRepositoriesMeteringInfoRequest.ts @@ -27,6 +27,7 @@ import { NodeIds } from '@_types/common' * API is volatile, meaning that it won’t be present after node restarts. * @rest_spec_name nodes.get_repositories_metering_info * @availability stack since=7.16.0 stability=experimental + * @availability serverless stability=experimental visibility=private * @cluster_privileges monitor, manage */ export interface Request extends RequestBase { diff --git a/specification/security/clear_api_key_cache/SecurityClearApiKeyCacheRequest.ts b/specification/security/clear_api_key_cache/SecurityClearApiKeyCacheRequest.ts index 5413da9e2d..67c308fdc3 100644 --- a/specification/security/clear_api_key_cache/SecurityClearApiKeyCacheRequest.ts +++ b/specification/security/clear_api_key_cache/SecurityClearApiKeyCacheRequest.ts @@ -25,7 +25,7 @@ import { Ids } from '@_types/common' * The cache is also automatically cleared on state changes of the security index. * @rest_spec_name security.clear_api_key_cache * @availability stack since=7.10.0 stability=stable - * @availability serverless stability=stable visibility=public + * @availability serverless stability=stable visibility=private * @cluster_privileges manage_security */ export interface Request extends RequestBase { diff --git a/specification/security/has_privileges/SecurityHasPrivilegesRequest.ts b/specification/security/has_privileges/SecurityHasPrivilegesRequest.ts index e7d9894e73..178dafab39 100644 --- a/specification/security/has_privileges/SecurityHasPrivilegesRequest.ts +++ b/specification/security/has_privileges/SecurityHasPrivilegesRequest.ts @@ -25,7 +25,7 @@ import { ApplicationPrivilegesCheck, IndexPrivilegesCheck } from './types' /** * @rest_spec_name security.has_privileges * @availability stack since=6.4.0 stability=stable - * @availability serverless stability=stable visibility=private + * @availability serverless stability=stable visibility=public */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/slm/delete_lifecycle/DeleteSnapshotLifecycleRequest.ts b/specification/slm/delete_lifecycle/DeleteSnapshotLifecycleRequest.ts index d463789fcb..b7226560a6 100644 --- a/specification/slm/delete_lifecycle/DeleteSnapshotLifecycleRequest.ts +++ b/specification/slm/delete_lifecycle/DeleteSnapshotLifecycleRequest.ts @@ -23,6 +23,7 @@ import { Name } from '@_types/common' /** * @rest_spec_name slm.delete_lifecycle * @availability stack since=7.4.0 stability=stable + * @availability serverless stability=stable visibility=private */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/slm/execute_lifecycle/ExecuteSnapshotLifecycleRequest.ts b/specification/slm/execute_lifecycle/ExecuteSnapshotLifecycleRequest.ts index 7bfb0c5efd..487930b114 100644 --- a/specification/slm/execute_lifecycle/ExecuteSnapshotLifecycleRequest.ts +++ b/specification/slm/execute_lifecycle/ExecuteSnapshotLifecycleRequest.ts @@ -23,6 +23,7 @@ import { Name } from '@_types/common' /** * @rest_spec_name slm.execute_lifecycle * @availability stack since=7.4.0 stability=stable + * @availability serverless stability=stable visibility=private */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/slm/execute_retention/ExecuteRetentionRequest.ts b/specification/slm/execute_retention/ExecuteRetentionRequest.ts index 4eff5f337b..9c672d8a1f 100644 --- a/specification/slm/execute_retention/ExecuteRetentionRequest.ts +++ b/specification/slm/execute_retention/ExecuteRetentionRequest.ts @@ -22,5 +22,6 @@ import { RequestBase } from '@_types/Base' /** * @rest_spec_name slm.execute_retention * @availability stack since=7.5.0 stability=stable + * @availability serverless stability=stable visibility=private */ export interface Request extends RequestBase {} diff --git a/specification/slm/get_lifecycle/GetSnapshotLifecycleRequest.ts b/specification/slm/get_lifecycle/GetSnapshotLifecycleRequest.ts index 635ae25dde..c61c32337e 100644 --- a/specification/slm/get_lifecycle/GetSnapshotLifecycleRequest.ts +++ b/specification/slm/get_lifecycle/GetSnapshotLifecycleRequest.ts @@ -23,6 +23,7 @@ import { Names } from '@_types/common' /** * @rest_spec_name slm.get_lifecycle * @availability stack since=7.4.0 stability=stable + * @availability serverless stability=stable visibility=private */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/slm/get_stats/GetSnapshotLifecycleStatsRequest.ts b/specification/slm/get_stats/GetSnapshotLifecycleStatsRequest.ts index 215e552ab4..178ca6b4e6 100644 --- a/specification/slm/get_stats/GetSnapshotLifecycleStatsRequest.ts +++ b/specification/slm/get_stats/GetSnapshotLifecycleStatsRequest.ts @@ -22,5 +22,6 @@ import { RequestBase } from '@_types/Base' /** * @rest_spec_name slm.get_stats * @availability stack since=7.5.0 stability=stable + * @availability serverless stability=stable visibility=private */ export interface Request extends RequestBase {} diff --git a/specification/slm/get_status/GetSnapshotLifecycleManagementStatusRequest.ts b/specification/slm/get_status/GetSnapshotLifecycleManagementStatusRequest.ts index bded3346af..5c162fe0a6 100644 --- a/specification/slm/get_status/GetSnapshotLifecycleManagementStatusRequest.ts +++ b/specification/slm/get_status/GetSnapshotLifecycleManagementStatusRequest.ts @@ -22,5 +22,6 @@ import { RequestBase } from '@_types/Base' /** * @rest_spec_name slm.get_status * @availability stack since=7.6.0 stability=stable + * @availability serverless stability=stable visibility=private */ export interface Request extends RequestBase {} diff --git a/specification/slm/put_lifecycle/PutSnapshotLifecycleRequest.ts b/specification/slm/put_lifecycle/PutSnapshotLifecycleRequest.ts index 390d21c863..b6b79b47df 100644 --- a/specification/slm/put_lifecycle/PutSnapshotLifecycleRequest.ts +++ b/specification/slm/put_lifecycle/PutSnapshotLifecycleRequest.ts @@ -26,6 +26,7 @@ import { Duration } from '@_types/Time' /** * @rest_spec_name slm.put_lifecycle * @availability stack since=7.4.0 stability=stable + * @availability serverless stability=stable visibility=private */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/slm/start/StartSnapshotLifecycleManagementRequest.ts b/specification/slm/start/StartSnapshotLifecycleManagementRequest.ts index c0480828a7..1f0d8106ff 100644 --- a/specification/slm/start/StartSnapshotLifecycleManagementRequest.ts +++ b/specification/slm/start/StartSnapshotLifecycleManagementRequest.ts @@ -22,5 +22,6 @@ import { RequestBase } from '@_types/Base' /** * @rest_spec_name slm.start * @availability stack since=7.6.0 stability=stable + * @availability serverless stability=stable visibility=private */ export interface Request extends RequestBase {} diff --git a/specification/slm/stop/StopSnapshotLifecycleManagementRequest.ts b/specification/slm/stop/StopSnapshotLifecycleManagementRequest.ts index fcffd7501d..eb5e8ede10 100644 --- a/specification/slm/stop/StopSnapshotLifecycleManagementRequest.ts +++ b/specification/slm/stop/StopSnapshotLifecycleManagementRequest.ts @@ -22,5 +22,6 @@ import { RequestBase } from '@_types/Base' /** * @rest_spec_name slm.stop * @availability stack since=7.6.0 stability=stable + * @availability serverless stability=stable visibility=private */ export interface Request extends RequestBase {} diff --git a/specification/snapshot/cleanup_repository/SnapshotCleanupRepositoryRequest.ts b/specification/snapshot/cleanup_repository/SnapshotCleanupRepositoryRequest.ts index a10077deb9..7b69025470 100644 --- a/specification/snapshot/cleanup_repository/SnapshotCleanupRepositoryRequest.ts +++ b/specification/snapshot/cleanup_repository/SnapshotCleanupRepositoryRequest.ts @@ -25,6 +25,7 @@ import { Duration } from '@_types/Time' * Triggers the review of a snapshot repository’s contents and deletes any stale data not referenced by existing snapshots. * @rest_spec_name snapshot.cleanup_repository * @availability stack since=7.4.0 stability=stable + * @availability serverless stability=stable visibility=private */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/snapshot/clone/SnapshotCloneRequest.ts b/specification/snapshot/clone/SnapshotCloneRequest.ts index 5ea789e9d9..8cf780a4e0 100644 --- a/specification/snapshot/clone/SnapshotCloneRequest.ts +++ b/specification/snapshot/clone/SnapshotCloneRequest.ts @@ -24,6 +24,7 @@ import { Duration } from '@_types/Time' /** * @rest_spec_name snapshot.clone * @availability stack since=7.10.0 stability=stable + * @availability serverless stability=stable visibility=private */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/snapshot/create/SnapshotCreateRequest.ts b/specification/snapshot/create/SnapshotCreateRequest.ts index 37df389d0c..7fff18df5d 100644 --- a/specification/snapshot/create/SnapshotCreateRequest.ts +++ b/specification/snapshot/create/SnapshotCreateRequest.ts @@ -24,6 +24,7 @@ import { Duration } from '@_types/Time' /** * @rest_spec_name snapshot.create * @availability stack since=0.0.0 stability=stable + * @availability serverless stability=stable visibility=private */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/snapshot/create_repository/SnapshotCreateRepositoryRequest.ts b/specification/snapshot/create_repository/SnapshotCreateRepositoryRequest.ts index b1294eb7c2..68185c27b2 100644 --- a/specification/snapshot/create_repository/SnapshotCreateRepositoryRequest.ts +++ b/specification/snapshot/create_repository/SnapshotCreateRepositoryRequest.ts @@ -28,7 +28,7 @@ import { Duration } from '@_types/Time' /** * @rest_spec_name snapshot.create_repository * @availability stack since=0.0.0 stability=stable - * + * @availability serverless stability=stable visibility=private */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/snapshot/delete/SnapshotDeleteRequest.ts b/specification/snapshot/delete/SnapshotDeleteRequest.ts index 3cf3e888b8..1563821723 100644 --- a/specification/snapshot/delete/SnapshotDeleteRequest.ts +++ b/specification/snapshot/delete/SnapshotDeleteRequest.ts @@ -24,6 +24,7 @@ import { Duration } from '@_types/Time' /** * @rest_spec_name snapshot.delete * @availability stack since=0.0.0 stability=stable + * @availability serverless stability=stable visibility=private */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/snapshot/delete_repository/SnapshotDeleteRepositoryRequest.ts b/specification/snapshot/delete_repository/SnapshotDeleteRepositoryRequest.ts index 46bfa5e3c2..84ff3aea05 100644 --- a/specification/snapshot/delete_repository/SnapshotDeleteRepositoryRequest.ts +++ b/specification/snapshot/delete_repository/SnapshotDeleteRepositoryRequest.ts @@ -24,6 +24,7 @@ import { Duration } from '@_types/Time' /** * @rest_spec_name snapshot.delete_repository * @availability stack since=0.0.0 stability=stable + * @availability serverless stability=stable visibility=private */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/snapshot/get/SnapshotGetRequest.ts b/specification/snapshot/get/SnapshotGetRequest.ts index 9d2006d508..3ca67fe66f 100644 --- a/specification/snapshot/get/SnapshotGetRequest.ts +++ b/specification/snapshot/get/SnapshotGetRequest.ts @@ -27,6 +27,7 @@ import { SortOrder } from '@_types/sort' /** * @rest_spec_name snapshot.get * @availability stack since=0.0.0 stability=stable + * @availability serverless stability=stable visibility=private */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/snapshot/get_repository/SnapshotGetRepositoryRequest.ts b/specification/snapshot/get_repository/SnapshotGetRepositoryRequest.ts index a24cf2ea76..b620870113 100644 --- a/specification/snapshot/get_repository/SnapshotGetRepositoryRequest.ts +++ b/specification/snapshot/get_repository/SnapshotGetRepositoryRequest.ts @@ -24,6 +24,7 @@ import { Duration } from '@_types/Time' /** * @rest_spec_name snapshot.get_repository * @availability stack since=0.0.0 stability=stable + * @availability serverless stability=stable visibility=private */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/snapshot/restore/SnapshotRestoreRequest.ts b/specification/snapshot/restore/SnapshotRestoreRequest.ts index f788b841bd..bedf603476 100644 --- a/specification/snapshot/restore/SnapshotRestoreRequest.ts +++ b/specification/snapshot/restore/SnapshotRestoreRequest.ts @@ -25,6 +25,7 @@ import { Duration } from '@_types/Time' /** * @rest_spec_name snapshot.restore * @availability stack since=0.0.0 stability=stable + * @availability serverless stability=stable visibility=private */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/snapshot/status/SnapshotStatusRequest.ts b/specification/snapshot/status/SnapshotStatusRequest.ts index c02aabffd6..747f5bd2cb 100644 --- a/specification/snapshot/status/SnapshotStatusRequest.ts +++ b/specification/snapshot/status/SnapshotStatusRequest.ts @@ -24,6 +24,7 @@ import { Duration } from '@_types/Time' /** * @rest_spec_name snapshot.status * @availability stack since=7.8.0 stability=stable + * @availability serverless stability=stable visibility=private */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/snapshot/verify_repository/SnapshotVerifyRepositoryRequest.ts b/specification/snapshot/verify_repository/SnapshotVerifyRepositoryRequest.ts index 2e11c7793e..ec97297dc9 100644 --- a/specification/snapshot/verify_repository/SnapshotVerifyRepositoryRequest.ts +++ b/specification/snapshot/verify_repository/SnapshotVerifyRepositoryRequest.ts @@ -24,6 +24,7 @@ import { Duration } from '@_types/Time' /** * @rest_spec_name snapshot.verify_repository * @availability stack since=0.0.0 stability=stable + * @availability serverless stability=stable visibility=private */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/sql/clear_cursor/ClearSqlCursorRequest.ts b/specification/sql/clear_cursor/ClearSqlCursorRequest.ts index 9a2a0623c0..71bdcb24e9 100644 --- a/specification/sql/clear_cursor/ClearSqlCursorRequest.ts +++ b/specification/sql/clear_cursor/ClearSqlCursorRequest.ts @@ -22,6 +22,7 @@ import { RequestBase } from '@_types/Base' /** * @rest_spec_name sql.clear_cursor * @availability stack since=6.3.0 stability=stable + * @availability serverless stability=stable visibility=public */ export interface Request extends RequestBase { body: { diff --git a/specification/sql/delete_async/SqlDeleteAsyncRequest.ts b/specification/sql/delete_async/SqlDeleteAsyncRequest.ts index 61ba430eef..6773ca72e9 100644 --- a/specification/sql/delete_async/SqlDeleteAsyncRequest.ts +++ b/specification/sql/delete_async/SqlDeleteAsyncRequest.ts @@ -23,6 +23,7 @@ import { Id } from '@_types/common' /** * @rest_spec_name sql.delete_async * @availability stack since=7.15.0 stability=stable + * @availability serverless stability=stable visibility=public */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/sql/get_async/SqlGetAsyncRequest.ts b/specification/sql/get_async/SqlGetAsyncRequest.ts index efcd52853b..7538cca19a 100644 --- a/specification/sql/get_async/SqlGetAsyncRequest.ts +++ b/specification/sql/get_async/SqlGetAsyncRequest.ts @@ -24,6 +24,7 @@ import { Id } from '@_types/common' /** * @rest_spec_name sql.get_async * @availability stack since=7.15.0 stability=stable + * @availability serverless stability=stable visibility=public */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/sql/get_async_status/SqlGetAsyncStatusRequest.ts b/specification/sql/get_async_status/SqlGetAsyncStatusRequest.ts index 6f33882647..34301ecc3b 100644 --- a/specification/sql/get_async_status/SqlGetAsyncStatusRequest.ts +++ b/specification/sql/get_async_status/SqlGetAsyncStatusRequest.ts @@ -24,6 +24,7 @@ import { Id } from '@_types/common' /** * @rest_spec_name sql.get_async_status * @availability stack since=7.15.0 stability=stable + * @availability serverless stability=stable visibility=public */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/sql/query/QuerySqlRequest.ts b/specification/sql/query/QuerySqlRequest.ts index 735c8693d4..26c3de91c8 100644 --- a/specification/sql/query/QuerySqlRequest.ts +++ b/specification/sql/query/QuerySqlRequest.ts @@ -28,6 +28,7 @@ import { Duration, TimeZone } from '@_types/Time' /** * @rest_spec_name sql.query * @availability stack since=6.3.0 stability=stable + * @availability serverless stability=stable visibility=public */ export interface Request extends RequestBase { query_parameters: { diff --git a/specification/sql/translate/TranslateSqlRequest.ts b/specification/sql/translate/TranslateSqlRequest.ts index 059fec41a2..ee34bbbfef 100644 --- a/specification/sql/translate/TranslateSqlRequest.ts +++ b/specification/sql/translate/TranslateSqlRequest.ts @@ -25,6 +25,7 @@ import { TimeZone } from '@_types/Time' /** * @rest_spec_name sql.translate * @availability stack since=6.3.0 stability=stable + * @availability serverless stability=stable visibility=public */ export interface Request extends RequestBase { body: { diff --git a/specification/tasks/cancel/CancelTasksRequest.ts b/specification/tasks/cancel/CancelTasksRequest.ts index 08f37dbce2..0379bb2d5e 100644 --- a/specification/tasks/cancel/CancelTasksRequest.ts +++ b/specification/tasks/cancel/CancelTasksRequest.ts @@ -23,6 +23,7 @@ import { TaskId } from '@_types/common' /** * @rest_spec_name tasks.cancel * @availability stack since=2.3.0 stability=experimental + * @availability serverless stability=experimental visibility=private * @doc_id tasks */ export interface Request extends RequestBase { diff --git a/specification/tasks/get/GetTaskRequest.ts b/specification/tasks/get/GetTaskRequest.ts index 849111fe4f..31defcd885 100644 --- a/specification/tasks/get/GetTaskRequest.ts +++ b/specification/tasks/get/GetTaskRequest.ts @@ -24,6 +24,7 @@ import { Duration } from '@_types/Time' /** * @rest_spec_name tasks.get * @availability stack since=5.0.0 stability=experimental + * @availability serverless stability=experimental visibility=public * @doc_id tasks */ export interface Request extends RequestBase { diff --git a/specification/tasks/list/ListTasksRequest.ts b/specification/tasks/list/ListTasksRequest.ts index 5361904002..6f97d7b628 100644 --- a/specification/tasks/list/ListTasksRequest.ts +++ b/specification/tasks/list/ListTasksRequest.ts @@ -26,6 +26,7 @@ import { GroupBy } from '@tasks/_types/GroupBy' * The task management API returns information about tasks currently executing on one or more nodes in the cluster. * @rest_spec_name tasks.list * @availability stack since=2.3.0 stability=experimental + * @availability serverless stability=experimental visibility=private * @cluster_privileges monitor, manage * @doc_id tasks */ diff --git a/specification/xpack/usage/XPackUsageRequest.ts b/specification/xpack/usage/XPackUsageRequest.ts index 8a5d65ce56..5a582df854 100644 --- a/specification/xpack/usage/XPackUsageRequest.ts +++ b/specification/xpack/usage/XPackUsageRequest.ts @@ -24,6 +24,7 @@ import { Duration } from '@_types/Time' * This API provides information about which features are currently enabled and available under the current license and some usage statistics. * @rest_spec_name xpack.usage * @availability stack since=0.0.0 stability=stable + * @availability serverless stability=stable visibility=private * @cluster_privileges monitor,manage */ export interface Request extends RequestBase {