feat(secret_manager): add set secret owner endpoint (#1660)

Author: scaleway-bot

api/secret/v1alpha1/secret_sdk.go

@@ -39,8 +39,8 @@ var (
 	_ = namegenerator.GetRandomName
 )
 
-// API: this API allows you to conveniently store, access and share sensitive data.
-// Secret Manager API documentation.
+// API: secret Manager API.
+// This API allows you to conveniently store, access and share sensitive data.
 type API struct {
 	client *scw.Client
 }
@@ -158,7 +158,7 @@ type AccessSecretVersionResponse struct {
 	// Data: the base64-encoded secret payload of the version.
 	Data []byte `json:"data"`
 	// DataCrc32: the CRC32 checksum of the data as a base-10 integer.
-	// This field is present only if a CRC32 was supplied during the creation of the version.
+	// This field is only available if a CRC32 was supplied during the creation of the version.
 	DataCrc32 *uint32 `json:"data_crc32"`
 }
 
@@ -435,69 +435,25 @@ func (s *API) UpdateSecret(req *UpdateSecretRequest, opts ...scw.RequestOption)
 	return &resp, nil
 }
 
-type AddSecretOwnerRequest struct {
-	// Region: region to target. If none is passed will use default region from the config.
-	Region scw.Region `json:"-"`
-	// SecretID: ID of the secret.
-	SecretID string `json:"-"`
-	// ProductName: name of the product to add.
-	ProductName string `json:"product_name"`
-}
-
-// AddSecretOwner: allow another product to use the secret.
-func (s *API) AddSecretOwner(req *AddSecretOwnerRequest, opts ...scw.RequestOption) error {
-	var err error
-
-	if req.Region == "" {
-		defaultRegion, _ := s.client.GetDefaultRegion()
-		req.Region = defaultRegion
-	}
-
-	if fmt.Sprint(req.Region) == "" {
-		return errors.New("field Region cannot be empty in request")
-	}
-
-	if fmt.Sprint(req.SecretID) == "" {
-		return errors.New("field SecretID cannot be empty in request")
-	}
-
-	scwReq := &scw.ScalewayRequest{
-		Method:  "POST",
-		Path:    "/secret-manager/v1alpha1/regions/" + fmt.Sprint(req.Region) + "/secrets/" + fmt.Sprint(req.SecretID) + "/add-owner",
-		Headers: http.Header{},
-	}
-
-	err = scwReq.SetBody(req)
-	if err != nil {
-		return err
-	}
-
-	err = s.client.Do(scwReq, nil, opts...)
-	if err != nil {
-		return err
-	}
-	return nil
-}
-
 type ListSecretsRequest struct {
 	// Region: region to target. If none is passed will use default region from the config.
 	Region scw.Region `json:"-"`
 	// OrganizationID: filter by Organization ID (optional).
 	OrganizationID *string `json:"-"`
 	// ProjectID: filter by Project ID (optional).
 	ProjectID *string `json:"-"`
-	// Name: filter by secret name (optional).
-	Name *string `json:"-"`
-	// Tags: list of tags to filter on (optional).
-	Tags []string `json:"-"`
-	// IsManaged: filter by managed / not managed (optional).
-	IsManaged *bool `json:"-"`
 	// OrderBy: default value: name_asc
 	OrderBy ListSecretsRequestOrderBy `json:"-"`
 
 	Page *int32 `json:"-"`
 
 	PageSize *uint32 `json:"-"`
+	// Tags: list of tags to filter on (optional).
+	Tags []string `json:"-"`
+	// Name: filter by secret name (optional).
+	Name *string `json:"-"`
+	// IsManaged: filter by managed / not managed (optional).
+	IsManaged *bool `json:"-"`
 }
 
 // ListSecrets: list secrets.
@@ -583,6 +539,50 @@ func (s *API) DeleteSecret(req *DeleteSecretRequest, opts ...scw.RequestOption)
 	return nil
 }
 
+type AddSecretOwnerRequest struct {
+	// Region: region to target. If none is passed will use default region from the config.
+	Region scw.Region `json:"-"`
+	// SecretID: ID of the secret.
+	SecretID string `json:"-"`
+	// ProductName: name of the product to add.
+	ProductName string `json:"product_name"`
+}
+
+// AddSecretOwner: allow a product to use the secret.
+func (s *API) AddSecretOwner(req *AddSecretOwnerRequest, opts ...scw.RequestOption) error {
+	var err error
+
+	if req.Region == "" {
+		defaultRegion, _ := s.client.GetDefaultRegion()
+		req.Region = defaultRegion
+	}
+
+	if fmt.Sprint(req.Region) == "" {
+		return errors.New("field Region cannot be empty in request")
+	}
+
+	if fmt.Sprint(req.SecretID) == "" {
+		return errors.New("field SecretID cannot be empty in request")
+	}
+
+	scwReq := &scw.ScalewayRequest{
+		Method:  "POST",
+		Path:    "/secret-manager/v1alpha1/regions/" + fmt.Sprint(req.Region) + "/secrets/" + fmt.Sprint(req.SecretID) + "/add-owner",
+		Headers: http.Header{},
+	}
+
+	err = scwReq.SetBody(req)
+	if err != nil {
+		return err
+	}
+
+	err = s.client.Do(scwReq, nil, opts...)
+	if err != nil {
+		return err
+	}
+	return nil
+}
+
 type CreateSecretVersionRequest struct {
 	// Region: region to target. If none is passed will use default region from the config.
 	Region scw.Region `json:"-"`
@@ -596,11 +596,11 @@ type CreateSecretVersionRequest struct {
 	// Optional. If there is no previous version or if the previous version was already disabled, does nothing.
 	DisablePrevious *bool `json:"disable_previous"`
 	// PasswordGeneration: options to generate a password.
-	// Optional. If specified, a random password will be generated. The data and data_crc32 fields 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.
+	// Optional. If specified, a random password will be generated. The `data` and `data_crc32` fields 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.
 	// Precisely one of PasswordGeneration must be set.
 	PasswordGeneration *PasswordGenerationParams `json:"password_generation,omitempty"`
 	// DataCrc32: the CRC32 checksum of the data as a base-10 integer.
-	// Optional. If specified, the Secret Manager will verify the integrity of the data received against the given CRC32. An error is returned if the CRC32 does not match. Otherwise, the CRC32 will be stored and returned along with the SecretVersion on futur accesses.
+	// Optional. If specified, Secret Manager will verify the integrity of the data received against the given CRC32. An error is returned if the CRC32 does not match. Otherwise, the CRC32 will be stored and returned along with the SecretVersion on futur accesses.
 	DataCrc32 *uint32 `json:"data_crc32"`
 }