Skip to content

Tidy up Webhook APIs #7550

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
klesh merged 3 commits into from
May 31, 2024
Merged

Tidy up Webhook APIs #7550

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
aa0cc3f
refactor: align webhook deployment API request body and db schema
May 31, 2024
65a8c48
refactor: webhook issues api request body spelling
May 31, 2024
2747cad
refactor: removing unused pipelineId from webhook deployment api
May 31, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 7 additions & 11 deletions backend/plugins/webhook/api/deployments.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,18 +39,17 @@ import (
)

type WebhookDeploymentReq struct {
Id string `mapstructure:"id"`
Id string `mapstructure:"id" validate:"required"`
DisplayTitle string `mapstructure:"displayTitle"`
PipelineId string `mapstructure:"pipelineId" validate:"required"`
Result string `mapstructure:"result"`
Environment string `validate:"omitempty,oneof=PRODUCTION STAGING TESTING DEVELOPMENT"`
Name string `mapstructure:"name"`
// DeploymentCommits is used for multiple commits in one deployment
DeploymentCommits []WebhookDeploymentCommitReq `mapstructure:"deploymentCommits" validate:"omitempty,dive"`
CreatedDate *time.Time `mapstructure:"createdTime"`
CreatedDate *time.Time `mapstructure:"createdDate"`
// QueuedDate *time.Time `mapstructure:"queue_time"`
StartedDate *time.Time `mapstructure:"startedTime" validate:"required"`
FinishedDate *time.Time `mapstructure:"endedTime"`
StartedDate *time.Time `mapstructure:"startedDate" validate:"required"`
FinishedDate *time.Time `mapstructure:"finishedDate"`
}

type WebhookDeploymentCommitReq struct {
Expand All @@ -63,10 +62,10 @@ type WebhookDeploymentCommitReq struct {
CommitMsg string `mapstructure:"commitMsg"`
Result string `mapstructure:"result"`
Status string `mapstructure:"status"`
CreatedDate *time.Time `mapstructure:"createdTime"`
CreatedDate *time.Time `mapstructure:"createdDate"`
// QueuedDate *time.Time `mapstructure:"queue_time"`
StartedDate *time.Time `mapstructure:"startedTime"`
FinishedDate *time.Time `mapstructure:"endedTime"`
StartedDate *time.Time `mapstructure:"startedDate" validate:"required"`
FinishedDate *time.Time `mapstructure:"finishedDate"`
}

// PostDeployments
Expand Down Expand Up @@ -121,9 +120,6 @@ func CreateDeploymentAndDeploymentCommits(connection *models.WebhookConnection,
}
// set default values for optional fields
deploymentId := request.Id
if deploymentId == "" {
deploymentId = request.PipelineId
}
scopeId := fmt.Sprintf("%s:%d", "webhook", connection.ID)
if request.CreatedDate == nil {
request.CreatedDate = request.StartedDate
Expand Down
32 changes: 16 additions & 16 deletions backend/plugins/webhook/api/incident.go → backend/plugins/webhook/api/issues.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,27 +35,27 @@ import (

type WebhookIssueRequest struct {
Url string `mapstructure:"url"`
IssueKey string `mapstructure:"issue_key" validate:"required"`
IssueKey string `mapstructure:"issueKey" validate:"required"`
Title string `mapstructure:"title" validate:"required"`
Description string `mapstructure:"description"`
EpicKey string `mapstructure:"epic_key"`
EpicKey string `mapstructure:"epicKey"`
Type string `mapstructure:"type"`
Status string `mapstructure:"status" validate:"oneof=TODO DONE IN_PROGRESS"`
OriginalStatus string `mapstructure:"original_status" validate:"required"`
StoryPoint float64 `mapstructure:"story_point"`
ResolutionDate *time.Time `mapstructure:"resolution_date"`
CreatedDate *time.Time `mapstructure:"created_date" validate:"required"`
UpdatedDate *time.Time `mapstructure:"updated_date"`
LeadTimeMinutes uint `mapstructure:"lead_time_minutes"`
ParentIssueKey string `mapstructure:"parent_issue_key"`
OriginalStatus string `mapstructure:"originalStatus" validate:"required"`
StoryPoint float64 `mapstructure:"storyPoint"`
ResolutionDate *time.Time `mapstructure:"resolutionDate"`
CreatedDate *time.Time `mapstructure:"createdDate" validate:"required"`
UpdatedDate *time.Time `mapstructure:"updatedDate"`
LeadTimeMinutes uint `mapstructure:"leadTimeMinutes"`
ParentIssueKey string `mapstructure:"parentIssueKey"`
Priority string `mapstructure:"priority"`
OriginalEstimateMinutes int64 `mapstructure:"original_estimate_minutes"`
TimeSpentMinutes int64 `mapstructure:"time_spent_minutes"`
TimeRemainingMinutes int64 `mapstructure:"time_remaining_minutes"`
CreatorId string `mapstructure:"creator_id"`
CreatorName string `mapstructure:"creator_name"`
AssigneeId string `mapstructure:"assignee_id"`
AssigneeName string `mapstructure:"assignee_name"`
OriginalEstimateMinutes int64 `mapstructure:"originalEstimateMinutes"`
TimeSpentMinutes int64 `mapstructure:"timeSpentMinutes"`
TimeRemainingMinutes int64 `mapstructure:"timeRemainingMinutes"`
CreatorId string `mapstructure:"creatorId"`
CreatorName string `mapstructure:"creatorName"`
AssigneeId string `mapstructure:"assigneeId"`
AssigneeName string `mapstructure:"assigneeName"`
Severity string `mapstructure:"severity"`
Component string `mapstructure:"component"`
//IconURL string
Expand Down