Skip to content

Commit b3d69b1

Browse files
committed
Add more descriptions
1 parent 36eb73c commit b3d69b1

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

specification/snapshot/create_repository/SnapshotCreateRepositoryRequest.ts

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,15 +27,22 @@ import { Duration } from '@_types/Time'
2727
* IMPORTANT: If you are migrating searchable snapshots, the repository name must be identical in the source and destination clusters.
2828
* To register a snapshot repository, the cluster's global metadata must be writeable.
2929
* Ensure there are no cluster blocks (for example, `cluster.blocks.read_only` and `clsuter.blocks.read_only_allow_delete` settings) that prevent write access.
30+
*
31+
* Several options for this API can be specified using a query parameter or a request body parameter.
32+
* If both parameters are specified, only the query parameter is used.
3033
* @rest_spec_name snapshot.create_repository
3134
* @availability stack since=0.0.0 stability=stable
3235
* @availability serverless stability=stable visibility=private
3336
* @cluster_privileges manage
37+
* @doc_id snapshot-repository-api-create
3438
* @ext_doc_id register-repository
3539
*/
3640
export interface Request extends RequestBase {
3741
path_parts: {
38-
/** @codegen_name name */
42+
/**
43+
* The name of the snapshot repository to register or update.
44+
* @codegen_name name
45+
*/
3946
repository: Name
4047
}
4148
query_parameters: {

0 commit comments

Comments
 (0)