More descriptions

Author: lcawl

output/openapi/elasticsearch-openapi.json

@@ -398,6 +398,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

@@ -667,6 +667,8 @@ slm-api-start,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/s
 slm-api-stop,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/slm-api-stop.html
 snapshot-create,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/snapshots-take-snapshot.html
 snapshot-repository-api-create,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/put-snapshot-repo-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

@@ -33,18 +33,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