Skip to content

Commit 0cee50b

Browse files
authored
docs(secret-manager): use new description field (#1623)
1 parent 14ed2c9 commit 0cee50b

File tree

1 file changed

+19
-12
lines changed

1 file changed

+19
-12
lines changed

api/secret/v1alpha1/secret_sdk.go

Lines changed: 19 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,8 @@ func (enum *SecretVersionStatus) UnmarshalJSON(data []byte) error {
152152
type AccessSecretVersionResponse struct {
153153
// SecretID: ID of the secret.
154154
SecretID string `json:"secret_id"`
155-
// Revision: version number. The first version of the secret is numbered 1, and all subsequent revisions augment by 1.
155+
// Revision: version number.
156+
// The first version of the secret is numbered 1, and all subsequent revisions augment by 1.
156157
Revision uint32 `json:"revision"`
157158
// Data: the base64-encoded secret payload of the version.
158159
Data []byte `json:"data"`
@@ -540,9 +541,7 @@ type CreateSecretVersionRequest struct {
540541
// If there is no previous version or if the previous version was already disabled, does nothing.
541542
DisablePrevious bool `json:"disable_previous"`
542543
// PasswordGeneration: options to generate a password.
543-
// If specified, a random password will be generated. The data field must be empty.
544-
// By default, the generator will use upper and lower case letters, and digits.
545-
// This behavior can be tuned using the generation params.
544+
// If specified, a random password will be generated. The data field must be empty. By default, the generator will use upper and lower case letters, and digits. This behavior can be tuned using the generation parameters.
546545
// Precisely one of PasswordGeneration must be set.
547546
PasswordGeneration *PasswordGenerationParams `json:"password_generation,omitempty"`
548547
}
@@ -590,7 +589,8 @@ type GetSecretVersionRequest struct {
590589
Region scw.Region `json:"-"`
591590
// SecretID: ID of the secret.
592591
SecretID string `json:"-"`
593-
// Revision: version number. The first version of the secret is numbered 1, and all subsequent revisions augment by 1. Value can be a number or "latest".
592+
// Revision: version number.
593+
// The first version of the secret is numbered 1, and all subsequent revisions augment by 1. Value can be a number or "latest".
594594
Revision string `json:"-"`
595595
}
596596

@@ -636,7 +636,8 @@ type GetSecretVersionByNameRequest struct {
636636
Region scw.Region `json:"-"`
637637
// SecretName: name of the secret.
638638
SecretName string `json:"-"`
639-
// Revision: version number. The first version of the secret is numbered 1, and all subsequent revisions augment by 1. Value can be a number or "latest".
639+
// Revision: version number.
640+
// The first version of the secret is numbered 1, and all subsequent revisions augment by 1. Value can be a number or "latest".
640641
Revision string `json:"-"`
641642
}
642643

@@ -682,7 +683,8 @@ type UpdateSecretVersionRequest struct {
682683
Region scw.Region `json:"-"`
683684
// SecretID: ID of the secret.
684685
SecretID string `json:"-"`
685-
// Revision: version number. The first version of the secret is numbered 1, and all subsequent revisions augment by 1. Value can be a number or "latest".
686+
// Revision: version number.
687+
// The first version of the secret is numbered 1, and all subsequent revisions augment by 1. Value can be a number or "latest".
686688
Revision string `json:"-"`
687689
// Description: description of the version.
688690
Description *string `json:"description"`
@@ -849,7 +851,8 @@ type DestroySecretVersionRequest struct {
849851
Region scw.Region `json:"-"`
850852
// SecretID: ID of the secret.
851853
SecretID string `json:"-"`
852-
// Revision: version number. The first version of the secret is numbered 1, and all subsequent revisions augment by 1. Value can be a number or "latest".
854+
// Revision: version number.
855+
// The first version of the secret is numbered 1, and all subsequent revisions augment by 1. Value can be a number or "latest".
853856
Revision string `json:"-"`
854857
}
855858

@@ -900,7 +903,8 @@ type EnableSecretVersionRequest struct {
900903
Region scw.Region `json:"-"`
901904
// SecretID: ID of the secret.
902905
SecretID string `json:"-"`
903-
// Revision: version number. The first version of the secret is numbered 1, and all subsequent revisions augment by 1. Value can be a number or "latest".
906+
// Revision: version number.
907+
// The first version of the secret is numbered 1, and all subsequent revisions augment by 1. Value can be a number or "latest".
904908
Revision string `json:"-"`
905909
}
906910

@@ -951,7 +955,8 @@ type DisableSecretVersionRequest struct {
951955
Region scw.Region `json:"-"`
952956
// SecretID: ID of the secret.
953957
SecretID string `json:"-"`
954-
// Revision: version number. The first version of the secret is numbered 1, and all subsequent revisions augment by 1. Value can be a number or "latest".
958+
// Revision: version number.
959+
// The first version of the secret is numbered 1, and all subsequent revisions augment by 1. Value can be a number or "latest".
955960
Revision string `json:"-"`
956961
}
957962

@@ -1002,7 +1007,8 @@ type AccessSecretVersionRequest struct {
10021007
Region scw.Region `json:"-"`
10031008
// SecretID: ID of the secret.
10041009
SecretID string `json:"-"`
1005-
// Revision: version number. The first version of the secret is numbered 1, and all subsequent revisions augment by 1. Value can be a number or "latest".
1010+
// Revision: version number.
1011+
// The first version of the secret is numbered 1, and all subsequent revisions augment by 1. Value can be a number or "latest".
10061012
Revision string `json:"-"`
10071013
}
10081014

@@ -1048,7 +1054,8 @@ type AccessSecretVersionByNameRequest struct {
10481054
Region scw.Region `json:"-"`
10491055
// SecretName: name of the secret.
10501056
SecretName string `json:"-"`
1051-
// Revision: version number. The first version of the secret is numbered 1, and all subsequent revisions augment by 1. Value can be a number or "latest".
1057+
// Revision: version number.
1058+
// The first version of the secret is numbered 1, and all subsequent revisions augment by 1. Value can be a number or "latest".
10521059
Revision string `json:"-"`
10531060
}
10541061

0 commit comments

Comments
 (0)