Skip to content

Commit 5d1077e

Browse files
authored
Update parameter descriptions for Snapshot Management. (#836)
Signed-off-by: Archer <[email protected]>
1 parent c070795 commit 5d1077e

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

spec/namespaces/sm.yaml

+13-13
Original file line numberDiff line numberDiff line change
@@ -217,30 +217,31 @@ components:
217217
sm.create_policy::path.policy_name:
218218
name: policy_name
219219
in: path
220-
description: The name of the snapshot management policy.
220+
description: The snapshot management policy name.
221221
required: true
222222
schema:
223223
type: string
224224

225225
sm.get_policy::path.policy_name:
226226
name: policy_name
227227
in: path
228-
description: The name of the snapshot management policy.
228+
description: The snapshot management name.
229229
required: true
230230
schema:
231231
type: string
232232

233233
sm.get_policies::query.from:
234234
name: from
235235
in: query
236-
description: 'The starting index (default: 0)'
236+
description: The index to retrieve snapshot management policies from.
237237
schema:
238+
default: 0
238239
type: integer
239240

240241
sm.update_policy::path.policy_name:
241242
name: policy_name
242243
in: path
243-
description: The name of the snapshot management policy.
244+
description: The snapshot management policy name.
244245
required: true
245246
schema:
246247
type: string
@@ -264,61 +265,60 @@ components:
264265
sm.delete_policy::path.policy_name:
265266
name: policy_name
266267
in: path
267-
description: The name of the snapshot management policy.
268+
description: The snapshot management policy name.
268269
required: true
269270
schema:
270271
type: string
271272

272273
sm.explain_policy::path.policy_name:
273274
name: policy_name
274275
in: path
275-
description: The name of the snapshot management policy.
276+
description: The snapshot management policy name.
276277
required: true
277278
schema:
278279
type: string
279280

280281
sm.start_policy::path.policy_name:
281282
name: policy_name
282283
in: path
283-
description: The name of the snapshot management policy.
284+
description: The snapshot management policy name.
284285
required: true
285286
schema:
286287
type: string
287288

288289
sm.stop_policy::path.policy_name:
289290
name: policy_name
290291
in: path
291-
description: The name of the snapshot management policy.
292+
description: The snapshot management policy name.
292293
required: true
293294
schema:
294295
type: string
295296

296297
sm.get_policies::query.size:
297298
name: size
298299
in: query
299-
description:
300-
The number of policies to return.
300+
description: The number of snapshot management policies to return.
301301
schema:
302302
type: integer
303303

304304
sm.get_policies::query.queryString:
305305
name: queryString
306306
in: query
307-
description: A query string to filter policies.
307+
description: Filters the returned snapshot management policies based on query string.
308308
schema:
309309
type: string
310310

311311
sm.get_policies::query.sortField:
312312
name: sortField
313313
in: query
314-
description: The field to sort on.
314+
description: The name of the query field to sort on.
315315
schema:
316316
type: string
317317

318318
sm.get_policies::query.sortOrder:
319319
name: sortOrder
320320
in: query
321-
description: The order of sorting.
321+
description: The order to sort the snapshot management policy result.
322322
schema:
323323
type: string
324324
enum: [asc, desc]

0 commit comments

Comments
 (0)