Skip to content

Commit 2a8d8de

Browse files
authored
fix(secret-manager): incomplete API descriptions (#1590)
1 parent 2ec24bb commit 2a8d8de

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

api/secret/v1alpha1/secret_sdk.go

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -326,7 +326,7 @@ type GetSecretByNameRequest struct {
326326
SecretName string `json:"-"`
327327
}
328328

329-
// GetSecretByName: get metadata of a Secret.
329+
// GetSecretByName: get metadata of a Secret by name.
330330
func (s *API) GetSecretByName(req *GetSecretByNameRequest, opts ...scw.RequestOption) (*Secret, error) {
331331
var err error
332332

@@ -477,7 +477,7 @@ type DeleteSecretRequest struct {
477477
SecretID string `json:"-"`
478478
}
479479

480-
// DeleteSecret: delete a secret.
480+
// DeleteSecret: delete a Secret.
481481
func (s *API) DeleteSecret(req *DeleteSecretRequest, opts ...scw.RequestOption) error {
482482
var err error
483483

@@ -609,7 +609,7 @@ type GetSecretVersionByNameRequest struct {
609609
Revision string `json:"-"`
610610
}
611611

612-
// GetSecretVersionByName: get metadata of a SecretVersion.
612+
// GetSecretVersionByName: get metadata of a SecretVersion by name.
613613
func (s *API) GetSecretVersionByName(req *GetSecretVersionByNameRequest, opts ...scw.RequestOption) (*SecretVersion, error) {
614614
var err error
615615

@@ -710,7 +710,7 @@ type ListSecretVersionsRequest struct {
710710
Status []SecretVersionStatus `json:"-"`
711711
}
712712

713-
// ListSecretVersions: list versions of a secret, not returning any sensitive data.
713+
// ListSecretVersions: list versions of a Secret, not returning any sensitive data.
714714
func (s *API) ListSecretVersions(req *ListSecretVersionsRequest, opts ...scw.RequestOption) (*ListSecretVersionsResponse, error) {
715715
var err error
716716

@@ -766,7 +766,7 @@ type ListSecretVersionsByNameRequest struct {
766766
Status []SecretVersionStatus `json:"-"`
767767
}
768768

769-
// ListSecretVersionsByName: list versions of a secret, not returning any sensitive data.
769+
// ListSecretVersionsByName: list versions of a Secret by name, not returning any sensitive data.
770770
func (s *API) ListSecretVersionsByName(req *ListSecretVersionsByNameRequest, opts ...scw.RequestOption) (*ListSecretVersionsResponse, error) {
771771
var err error
772772

@@ -1013,7 +1013,7 @@ type AccessSecretVersionByNameRequest struct {
10131013
Revision string `json:"-"`
10141014
}
10151015

1016-
// AccessSecretVersionByName: access a SecretVersion, returning the sensitive data.
1016+
// AccessSecretVersionByName: access a SecretVersion by name, returning the sensitive data.
10171017
func (s *API) AccessSecretVersionByName(req *AccessSecretVersionByNameRequest, opts ...scw.RequestOption) (*AccessSecretVersionResponse, error) {
10181018
var err error
10191019

0 commit comments

Comments
 (0)