Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update visibility for serverless #2243

Merged
merged 2 commits into from
Sep 20, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -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: {
Expand Down
1 change: 1 addition & 0 deletions specification/_global/explain/ExplainRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ import { Operator } from '@_types/query_dsl/Operator'
* Returns information about why a specific document matches (or doesn’t match) a query.
* @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: {
Expand Down
1 change: 1 addition & 0 deletions specification/_global/health_report/Request.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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: {
Expand Down
1 change: 1 addition & 0 deletions specification/_global/reindex/ReindexRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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: {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ import { float } from '@_types/Numeric'
* Copies documents from a source to a destination.
* @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: {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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: {
Expand Down
1 change: 1 addition & 0 deletions specification/cat/health/CatHealthRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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
*/
Expand Down
1 change: 1 addition & 0 deletions specification/cat/recovery/CatRecoveryRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions specification/cat/repositories/CatRepositoriesRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand Down
2 changes: 1 addition & 1 deletion specification/cluster/stats/ClusterStatsRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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
*/
Expand Down
1 change: 1 addition & 0 deletions specification/eql/delete/EqlDeleteRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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: {
Expand Down
1 change: 1 addition & 0 deletions specification/eql/get/EqlGetRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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: {
Expand Down
1 change: 1 addition & 0 deletions specification/eql/get_status/EqlGetStatusRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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: {
Expand Down
1 change: 1 addition & 0 deletions specification/eql/search/EqlSearchRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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: {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 {}
1 change: 1 addition & 0 deletions specification/indices/add_block/IndicesAddBlockRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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: {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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: {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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: {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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: {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand Down
1 change: 1 addition & 0 deletions specification/indices/flush/IndicesFlushRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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: {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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: {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,6 @@ import { Duration } from '@_types/Time'
* Retrieves information about one or more index templates.
* @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: {
Expand Down
1 change: 1 addition & 0 deletions specification/indices/refresh/IndicesRefreshRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ import { ExpandWildcards, Indices } from '@_types/common'
* For data streams, the API runs the refresh operation on the stream’s backing indices.
* @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: {
Expand Down
1 change: 1 addition & 0 deletions specification/indices/segments/IndicesSegmentsRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ import { ExpandWildcards, Indices } from '@_types/common'
* For data streams, the API returns information about the stream’s backing indices.
* @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: {
Expand Down
1 change: 1 addition & 0 deletions specification/license/get/GetLicenseRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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: {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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: {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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: {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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: {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 {}
Original file line number Diff line number Diff line change
Expand Up @@ -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: {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 {}
Original file line number Diff line number Diff line change
Expand Up @@ -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 {}
Original file line number Diff line number Diff line change
Expand Up @@ -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: {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 {}
Original file line number Diff line number Diff line change
Expand Up @@ -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 {}
Original file line number Diff line number Diff line change
Expand Up @@ -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: {
Expand Down
1 change: 1 addition & 0 deletions specification/snapshot/clone/SnapshotCloneRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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: {
Expand Down
1 change: 1 addition & 0 deletions specification/snapshot/create/SnapshotCreateRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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: {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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: {
Expand Down
1 change: 1 addition & 0 deletions specification/snapshot/delete/SnapshotDeleteRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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: {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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: {
Expand Down
Loading
Loading