More descriptions

Author: lcawl

output/openapi/elasticsearch-openapi.json

@@ -392,6 +392,12 @@
       ],
       "response": []
     },
+    "snapshot.clone": {
+      "request": [
+        "Request: query parameter 'timeout' does not exist in the json spec"
+      ],
+      "response": []
+    },
     "snapshot.delete": {
       "request": [
         "Request: missing json spec query parameter 'wait_for_completion'"

output/schema/schema.json

@@ -686,6 +686,8 @@ snapshot-repo-delete,https://www.elastic.co/guide/en/elasticsearch/reference/{br
 snapshot-repo-get,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-snapshot-repo-api.html
 snapshot-repo-verify,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/verify-snapshot-repo-api.html
 snapshot-repo-verify-integrity,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/verify-repo-integrity-api.html
+snapshot-restore-amend-replacement,https://docs.oracle.com/javase/8/docs/api/java/util/regex/Matcher.html#appendReplacement-java.lang.StringBuffer-java.lang.String-
+snapshot-restore-feature-state,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/snapshot-restore.html#feature-state
 sort-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/sort-processor.html
 sort-search-results,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/sort-search-results.html
 sort-tiebreaker,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/eql.html#eql-search-specify-a-sort-tiebreaker

output/schema/validation-errors.json

@@ -20,10 +20,28 @@
 import { long } from '@_types/Numeric'
 
 export class ShardsStats {
+  /**
+   * The number of shards that initialized, started, and finalized successfully.
+   */
   done: long
+  /**
+   * The number of shards that failed to be included in the snapshot.
+   */
   failed: long
+  /**
+   * The number of shards that are finalizing but are not done.
+   */
   finalizing: long
+  /**
+   * The number of shards that are still initializing.
+   */
   initializing: long
+  /**
+   * The number of shards that have started but are not finalized.
+   */
   started: long
+  /**
+   * The total number of shards included in the snapshot.
+   */
   total: long
 }

output/typescript/types.ts

@@ -18,14 +18,14 @@
  */
 
 export enum ShardsStatsStage {
-  /** Number of shards in the snapshot that were successfully stored in the repository. */
+  /** The number of shards in the snapshot that were successfully stored in the repository. */
   DONE,
-  /** Number of shards in the snapshot that were not successfully stored in the repository. */
+  /** The number of shards in the snapshot that were not successfully stored in the repository. */
   FAILURE,
-  /** Number of shards in the snapshot that are in the finalizing stage of being stored in the repository. */
+  /** The number of shards in the snapshot that are in the finalizing stage of being stored in the repository. */
   FINALIZE,
-  /** Number of shards in the snapshot that are in the initializing stage of being stored in the repository. */
+  /** The number of shards in the snapshot that are in the initializing stage of being stored in the repository. */
   INIT,
-  /** Number of shards in the snapshot that are in the started stage of being stored in the repository. */
+  /** The number of shards in the snapshot that are in the started stage of being stored in the repository. */
   STARTED
 }

specification/_doc_ids/table.csv

@@ -21,9 +21,22 @@ import { Duration, DurationValue, EpochTime, UnitMillis } from '@_types/Time'
 import { FileCountSnapshotStats } from './FileCountSnapshotStats'
 
 export class SnapshotStats {
+  /**
+   * The number and size of files that still need to be copied as part of the incremental snapshot.
+   * For completed snapshots, this property indicates the number and size of files that were not already in the repository and were copied as part of the incremental snapshot.
+   */
   incremental: FileCountSnapshotStats
+  /**
+   * The time, in milliseconds, when the snapshot creation process started.
+   */
   start_time_in_millis: EpochTime<UnitMillis>
   time?: Duration
+  /**
+   * The total time, in milliseconds, that it took for the snapshot process to complete.
+   */
   time_in_millis: DurationValue<UnitMillis>
+  /**
+   * The total number and size of files that are referenced by the snapshot.
+   */
   total: FileCountSnapshotStats
 }

specification/snapshot/_types/SnapshotShardsStats.ts

@@ -24,12 +24,37 @@ import { ShardsStats } from './SnapshotShardsStats'
 import { SnapshotStats } from './SnapshotStats'
 
 export class Status {
+  /**
+   * Indicates whether the current cluster state is included in the snapshot.
+   */
   include_global_state: boolean
   indices: Dictionary<string, SnapshotIndexStats>
+  /**
+   * The name of the repository that includes the snapshot.
+   */
   repository: string
+  /**
+   * Statistics for the shards in the snapshot.
+   */
   shards_stats: ShardsStats
+  /**
+   * The name of the snapshot.
+   */
   snapshot: string
+  /**
+   * The current snapshot state:
+   *
+   * * `FAILED`: The snapshot finished with an error and failed to store any data.
+   * * `STARTED`: The snapshot is currently running.
+   * * `SUCCESS`: The snapshot completed.
+   */
   state: string
+  /**
+   * Details about the number (`file_count`) and size (`size_in_bytes`) of files included in the snapshot.
+   */
   stats: SnapshotStats
+  /**
+   * The universally unique identifier (UUID) for the snapshot.
+   */
   uuid: Uuid
 }

specification/snapshot/_types/SnapshotShardsStatsStage.ts

@@ -34,18 +34,22 @@ import { Duration } from '@_types/Time'
 export interface Request extends RequestBase {
   path_parts: {
     /**
-     * Snapshot repository to clean up.
+     * The name of the snapshot repository to clean up.
      * @codegen_name name */
     repository: Name
   }
   query_parameters: {
     /**
-     * Period to wait for a connection to the master node.
+     * The period to wait for a connection to the master node.
+     * If the master node is not available before the timeout expires, the request fails and returns an error.
+     * To indicate that the request should never timeout, set it to `-1`
      * @server_default 30s
      */
     master_timeout?: Duration
     /**
-     * Period to wait for a response.
+     * The period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata.
+     * If no response is received before the timeout expires, the cluster metadata update still applies but the response will indicate that it was not completely acknowledged.
+     * To indicate that the request should never timeout, set it to `-1`.
      * @server_default 30s
      */
     timeout?: Duration

specification/snapshot/_types/SnapshotStats.ts

@@ -27,8 +27,11 @@ export class Response {
 }
 
 export class CleanupRepositoryResults {
-  /** Number of binary large objects (blobs) removed during cleanup. */
+  /**
+   * The number of binary large objects (blobs) removed from the snapshot repository during cleanup operations.
+   * A non-zero value indicates that unreferenced blobs were found and subsequently cleaned up.
+   */
   deleted_blobs: long
-  /** Number of bytes freed by cleanup operations. */
+  /** The number of bytes freed by cleanup operations. */
   deleted_bytes: long
 }

specification/snapshot/_types/SnapshotStatus.ts

@@ -32,14 +32,39 @@ import { Duration } from '@_types/Time'
  */
 export interface Request extends RequestBase {
   path_parts: {
+    /**
+     * The name of the snapshot repository that both source and target snapshot belong to.
+     */
     repository: Name
+    /**
+     * The source snapshot name.
+     */
     snapshot: Name
+    /**
+     * The target snapshot name.
+     */
     target_snapshot: Name
   }
   query_parameters: {
+    /**
+     * The period to wait for the master node.
+     * If the master node is not available before the timeout expires, the request fails and returns an error.
+     * To indicate that the request should never timeout, set it to `-1`.
+     * @server_default 30s
+     */
     master_timeout?: Duration
+    /**
+     * The period of time to wait for a response.
+     * If no response is received before the timeout expires, the request fails and returns an error.
+     * @server_default 30s
+     */
+    timeout?: Duration
   }
   body: {
+    /**
+     * A comma-separated list of indices to include in the snapshot.
+     * Multi-target syntax is supported.
+     */
     indices: string
   }
 }

specification/snapshot/cleanup_repository/SnapshotCleanupRepositoryRequest.ts

@@ -18,7 +18,7 @@
  */
 
 import { RequestBase } from '@_types/Base'
-import { Indices, Metadata, Name } from '@_types/common'
+import { ExpandWildcards, Indices, Metadata, Name } from '@_types/common'
 import { Duration } from '@_types/Time'
 
 /**
@@ -34,51 +34,85 @@ import { Duration } from '@_types/Time'
 export interface Request extends RequestBase {
   path_parts: {
     /**
-     * Repository for the snapshot.
+     * The name of the repository for the snapshot.
      */
     repository: Name
     /**
-     * Name of the snapshot. Must be unique in the repository.
+     * The name of the snapshot.
+     * It supportes date math.
+     * It must be unique in the repository.
      */
     snapshot: Name
   }
   query_parameters: {
     /**
-     * Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.
+     * The period to wait for a connection to the master node.
+     * If no response is received before the timeout expires, the request fails and returns an error.
      * @server_default 30s
      */
     master_timeout?: Duration
     /**
-     *  If `true`, the request returns a response when the snapshot is complete. If `false`, the request returns a response when the snapshot initializes.
+     *  If `true`, the request returns a response when the snapshot is complete.
+     * If `false`, the request returns a response when the snapshot initializes.
      * @server_default false
      */
     wait_for_completion?: boolean
   }
   body: {
     /**
-     * If `true`, the request ignores data streams and indices in `indices` that are missing or closed. If `false`, the request returns an error for any data stream or index that is missing or closed.
+     * Determines how wildcard patterns in the `indices` parameter match data streams and indices.
+     * It supports comma-separated values such as `open,hidden`.
+     * @server_default all
+     */
+    expand_wildcards?: ExpandWildcards
+    /**
+     * The feature states to include in the snapshot.
+     * Each feature state includes one or more system indices containing related data.
+     * You can view a list of eligible features using the get features API.
+     *
+     * If `include_global_state` is `true`, all current feature states are included by default.
+     * If `include_global_state` is `false`, no feature states are included by default.
+     *
+     * Note that specifying an empty array will result in the default behavior.
+     * To exclude all feature states, regardless of the `include_global_state` value, specify an array with only the value `none` (`["none"]`).
+     * @ext_doc_id snapshot-restore-feature-state
+     */
+    feature_states?: string[]
+    /**
+     * If `true`, the request ignores data streams and indices in `indices` that are missing or closed.
+     * If `false`, the request returns an error for any data stream or index that is missing or closed.
      * @server_default false
      */
     ignore_unavailable?: boolean
     /**
-     * If `true`, the current cluster state is included in the snapshot. The cluster state includes persistent cluster settings, composable index templates, legacy index templates, ingest pipelines, and ILM policies. It also includes data stored in system indices, such as Watches and task records (configurable via `feature_states`).
+     * If `true`, the current cluster state is included in the snapshot.
+     * The cluster state includes persistent cluster settings, composable index templates, legacy index templates, ingest pipelines, and ILM policies.
+     * It also includes data stored in system indices, such as Watches and task records (configurable via `feature_states`).
      * @server_default true
      */
     include_global_state?: boolean
     /**
-     * Data streams and indices to include in the snapshot. Supports multi-target syntax. Includes all data streams and indices by default.
+     * A comma-separated list of data streams and indices to include in the snapshot.
+     * It supports a multi-target syntax.
+     * The default is an empty array (`[]`), which includes all regular data streams and regular indices.
+     * To exclude all data streams and indices, use `-*`.
+     *
+     * You can't use this parameter to include or exclude system indices or system data streams from a snapshot.
+     * Use `feature_states` instead.
      */
     indices?: Indices
     /**
-     * Feature states to include in the snapshot. Each feature state includes one or more system indices containing related data. You can view a list of eligible features using the get features API. If `include_global_state` is `true`, all current feature states are included by default. If `include_global_state` is `false`, no feature states are included by default.
-     */
-    feature_states?: string[]
-    /**
-     * Optional metadata for the snapshot. May have any contents. Must be less than 1024 bytes. This map is not automatically generated by Elasticsearch.
+     * Arbitrary metadata to the snapshot, such as a record of who took the snapshot, why it was taken, or any other useful data.
+     * It can have any contents but it must be less than 1024 bytes.
+     * This information is not automatically generated by Elasticsearch.
      */
     metadata?: Metadata
     /**
-     * If `true`, allows restoring a partial snapshot of indices with unavailable shards. Only shards that were successfully included in the snapshot will be restored. All missing shards will be recreated as empty. If `false`, the entire restore operation will fail if one or more indices included in the snapshot do not have all primary shards available.
+     * If `true`, it enables you to restore a partial snapshot of indices with unavailable shards.
+     * Only shards that were successfully included in the snapshot will be restored.
+     * All missing shards will be recreated as empty.
+     *
+     * If `false`, the entire restore operation will fail if one or more indices included in the snapshot do not have all primary shards available.
      * @server_default false
      */
     partial?: boolean