Moved DeploymentApprovalStatus to types.go

xanzy · Mar 4, 2024 · fa5414a · fa5414a
1 parent 9cb5e61
commit fa5414a
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 15 deletions.
diff --git a/deployments.go b/deployments.go
@@ -88,7 +88,8 @@ type ListProjectDeploymentsOptions struct {
 
 // ListProjectDeployments gets a list of deployments in a project.
 //
-// GitLab API docs: https://docs.gitlab.com/ee/api/deployments.html#list-project-deployments
+// GitLab API docs:
+// https://docs.gitlab.com/ee/api/deployments.html#list-project-deployments
 func (s *DeploymentsService) ListProjectDeployments(pid interface{}, opts *ListProjectDeploymentsOptions, options ...RequestOptionFunc) ([]*Deployment, *Response, error) {
 	project, err := parseID(pid)
 	if err != nil {
@@ -112,7 +113,8 @@ func (s *DeploymentsService) ListProjectDeployments(pid interface{}, opts *ListP
 
 // GetProjectDeployment get a deployment for a project.
 //
-// GitLab API docs: https://docs.gitlab.com/ee/api/deployments.html#get-a-specific-deployment
+// GitLab API docs:
+// https://docs.gitlab.com/ee/api/deployments.html#get-a-specific-deployment
 func (s *DeploymentsService) GetProjectDeployment(pid interface{}, deployment int, options ...RequestOptionFunc) (*Deployment, *Response, error) {
 	project, err := parseID(pid)
 	if err != nil {
@@ -137,7 +139,8 @@ func (s *DeploymentsService) GetProjectDeployment(pid interface{}, deployment in
 // CreateProjectDeploymentOptions represents the available
 // CreateProjectDeployment() options.
 //
-// GitLab API docs: https://docs.gitlab.com/ee/api/deployments.html#create-a-deployment
+// GitLab API docs:
+// https://docs.gitlab.com/ee/api/deployments.html#create-a-deployment
 type CreateProjectDeploymentOptions struct {
 	Environment *string                `url:"environment,omitempty" json:"environment,omitempty"`
 	Ref         *string                `url:"ref,omitempty" json:"ref,omitempty"`
@@ -148,7 +151,8 @@ type CreateProjectDeploymentOptions struct {
 
 // CreateProjectDeployment creates a project deployment.
 //
-// GitLab API docs: https://docs.gitlab.com/ee/api/deployments.html#create-a-deployment
+// GitLab API docs:
+// https://docs.gitlab.com/ee/api/deployments.html#create-a-deployment
 func (s *DeploymentsService) CreateProjectDeployment(pid interface{}, opt *CreateProjectDeploymentOptions, options ...RequestOptionFunc) (*Deployment, *Response, error) {
 	project, err := parseID(pid)
 	if err != nil {
@@ -173,14 +177,16 @@ func (s *DeploymentsService) CreateProjectDeployment(pid interface{}, opt *Creat
 // UpdateProjectDeploymentOptions represents the available
 // UpdateProjectDeployment() options.
 //
-// GitLab API docs: https://docs.gitlab.com/ee/api/deployments.html#update-a-deployment
+// GitLab API docs:
+// https://docs.gitlab.com/ee/api/deployments.html#update-a-deployment
 type UpdateProjectDeploymentOptions struct {
 	Status *DeploymentStatusValue `url:"status,omitempty" json:"status,omitempty"`
 }
 
 // UpdateProjectDeployment updates a project deployment.
 //
-// GitLab API docs: https://docs.gitlab.com/ee/api/deployments.html#update-a-deployment
+// GitLab API docs:
+// https://docs.gitlab.com/ee/api/deployments.html#update-a-deployment
 func (s *DeploymentsService) UpdateProjectDeployment(pid interface{}, deployment int, opt *UpdateProjectDeploymentOptions, options ...RequestOptionFunc) (*Deployment, *Response, error) {
 	project, err := parseID(pid)
 	if err != nil {
@@ -202,13 +208,11 @@ func (s *DeploymentsService) UpdateProjectDeployment(pid interface{}, deployment
 	return d, resp, nil
 }
 
-type DeploymentApprovalStatus string
-
-const (
-	DeploymentApproved DeploymentApprovalStatus = "approved"
-	DeploymentRejected DeploymentApprovalStatus = "rejected"
-)
-
+// ApproveOrRejectProjectDeploymentOptions represents the available
+// ApproveOrRejectProjectDeployment() options.
+//
+// GitLab API docs:
+// https://docs.gitlab.com/ee/api/deployments.html#approve-or-reject-a-blocked-deployment
 type ApproveOrRejectProjectDeploymentOptions struct {
 	Status        *DeploymentApprovalStatus `url:"status,omitempty" json:"status,omitempty"`
 	Comment       *string                   `url:"comment,omitempty" json:"comment,omitempty"`
@@ -217,7 +221,8 @@ type ApproveOrRejectProjectDeploymentOptions struct {
 
 // ApproveOrRejectProjectDeployment approve or reject a blocked deployment.
 //
-// GitLab API docs: https://docs.gitlab.com/ee/api/deployments.html#approve-or-reject-a-blocked-deployment
+// GitLab API docs:
+// https://docs.gitlab.com/ee/api/deployments.html#approve-or-reject-a-blocked-deployment
 func (s *DeploymentsService) ApproveOrRejectProjectDeployment(pid interface{}, deployment int,
 	opt *ApproveOrRejectProjectDeploymentOptions, options ...RequestOptionFunc,
 ) (*Response, error) {
@@ -237,7 +242,8 @@ func (s *DeploymentsService) ApproveOrRejectProjectDeployment(pid interface{}, d
 
 // DeleteProjectDeployment delete a project deployment.
 //
-// GitLab API docs: https://docs.gitlab.com/ee/api/deployments.html#delete-a-specific-deployment
+// GitLab API docs:
+// https://docs.gitlab.com/ee/api/deployments.html#delete-a-specific-deployment
 func (s *DeploymentsService) DeleteProjectDeployment(pid interface{}, deployment int, options ...RequestOptionFunc) (*Response, error) {
 	project, err := parseID(pid)
 	if err != nil {

diff --git a/types.go b/types.go
@@ -256,6 +256,15 @@ func BuildState(v BuildStateValue) *BuildStateValue {
 	return Ptr(v)
 }
 
+// DeploymentApprovalStatus represents a Gitlab deployment approval status.
+type DeploymentApprovalStatus string
+
+// These constants represent all valid deployment approval statuses.
+const (
+	DeploymentApprovalStatusApproved DeploymentApprovalStatus = "approved"
+	DeploymentApprovalStatusRejected DeploymentApprovalStatus = "rejected"
+)
+
 // DeploymentStatusValue represents a Gitlab deployment status.
 type DeploymentStatusValue string