likyh commented on code in PR #3051: URL: https://github.com/apache/incubator-devlake/pull/3051#discussion_r970851341
########## plugins/webhook/api/issue.go: ########## @@ -0,0 +1,93 @@ +/* +Licensed to the Apache Software Foundation (ASF) under one or more +contributor license agreements. See the NOTICE file distributed with +this work for additional information regarding copyright ownership. +The ASF licenses this file to You under the Apache License, Version 2.0 +(the "License"); you may not use this file except in compliance with +the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +*/ + +package api + +import ( + "github.com/apache/incubator-devlake/errors" + "github.com/apache/incubator-devlake/plugins/core" + "github.com/apache/incubator-devlake/plugins/webhook/models" + "net/http" + "time" +) + +type WebhookIssueRequest struct { + BoardKey string `mapstructure:"board_key" validate:"required"` + Url string `mapstructure:"url"` + IssueKey string `mapstructure:"issue_key" validate:"required"` + Title string `mapstructure:"title" validate:"required"` + Description string `mapstructure:"description"` + EpicKey string `mapstructure:"epic_key"` + Type string `mapstructure:"type"` + Status string `mapstructure:"status" validate:"oneof=TODO DONE IN_PROGRESS"` + OriginalStatus string `mapstructure:"original_status" validate:"required"` + StoryPoint int64 `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"` + 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"` + Severity string `mapstructure:"severity"` + Component string `mapstructure:"component"` + //IconURL string + //DeploymentId string +} + +// PostIssue +// @Summary receive a record as defined and save it +// @Description receive a record as follow and save it, example: {"board_key":"DLK","url":"","issue_key":"DLK-1234","title":"a feature from DLK","description":"","epic_key":"","type":"BUG","status":"TODO","original_status":"created","story_point":0,"resolution_date":null,"created_date":"2020-01-01T12:00:00+00:00","updated_date":null,"lead_time_minutes":0,"parent_issue_key":"DLK-1200","priority":"","original_estimate_minutes":0,"time_spent_minutes":0,"time_remaining_minutes":0,"creator_id":"user1131","creator_name":"Nick name 1","assignee_id":"user1132","assignee_name":"Nick name 2","severity":"","component":""} +// @Tags plugins/webhook +// @Param body body WebhookPipelineRequest true "json body" +// @Success 200 {string} noResponse "" +// @Failure 400 {string} errcode.Error "Bad Request" +// @Failure 500 {string} errcode.Error "Internal Error" +// @Router /plugins/webhook/:connectionId/issue [POST] +func PostIssue(input *core.ApiResourceInput) (*core.ApiResourceOutput, errors.Error) { + connection := &models.WebhookConnection{} + err := connectionHelper.First(connection, input.Params) + if err != nil { + return nil, err + } + // TODO save issue + return &core.ApiResourceOutput{Body: nil, Status: http.StatusOK}, nil +} + +// CloseIssue +// @Summary set issue's status to DONE +// @Description set issue's status to DONE +// @Tags plugins/webhook +// @Success 200 {string} noResponse "" +// @Failure 400 {string} errcode.Error "Bad Request" +// @Failure 500 {string} errcode.Error "Internal Error" +// @Router /plugins/webhook/:connectionId/issue/:boardKey/:issueId/close [POST] Review Comment: Issues may belong to the board in some platforms, like Github (repo=board), although they are not in Jira. ########## plugins/webhook/api/issue.go: ########## @@ -0,0 +1,93 @@ +/* +Licensed to the Apache Software Foundation (ASF) under one or more +contributor license agreements. See the NOTICE file distributed with +this work for additional information regarding copyright ownership. +The ASF licenses this file to You under the Apache License, Version 2.0 +(the "License"); you may not use this file except in compliance with +the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +*/ + +package api + +import ( + "github.com/apache/incubator-devlake/errors" + "github.com/apache/incubator-devlake/plugins/core" + "github.com/apache/incubator-devlake/plugins/webhook/models" + "net/http" + "time" +) + +type WebhookIssueRequest struct { + BoardKey string `mapstructure:"board_key" validate:"required"` + Url string `mapstructure:"url"` + IssueKey string `mapstructure:"issue_key" validate:"required"` + Title string `mapstructure:"title" validate:"required"` + Description string `mapstructure:"description"` + EpicKey string `mapstructure:"epic_key"` + Type string `mapstructure:"type"` + Status string `mapstructure:"status" validate:"oneof=TODO DONE IN_PROGRESS"` + OriginalStatus string `mapstructure:"original_status" validate:"required"` + StoryPoint int64 `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"` + 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"` + Severity string `mapstructure:"severity"` + Component string `mapstructure:"component"` + //IconURL string + //DeploymentId string +} + +// PostIssue +// @Summary receive a record as defined and save it +// @Description receive a record as follow and save it, example: {"board_key":"DLK","url":"","issue_key":"DLK-1234","title":"a feature from DLK","description":"","epic_key":"","type":"BUG","status":"TODO","original_status":"created","story_point":0,"resolution_date":null,"created_date":"2020-01-01T12:00:00+00:00","updated_date":null,"lead_time_minutes":0,"parent_issue_key":"DLK-1200","priority":"","original_estimate_minutes":0,"time_spent_minutes":0,"time_remaining_minutes":0,"creator_id":"user1131","creator_name":"Nick name 1","assignee_id":"user1132","assignee_name":"Nick name 2","severity":"","component":""} +// @Tags plugins/webhook +// @Param body body WebhookPipelineRequest true "json body" +// @Success 200 {string} noResponse "" +// @Failure 400 {string} errcode.Error "Bad Request" +// @Failure 500 {string} errcode.Error "Internal Error" +// @Router /plugins/webhook/:connectionId/issue [POST] Review Comment: fixed ########## plugins/webhook/api/blueprint.go: ########## @@ -0,0 +1,57 @@ +/* +Licensed to the Apache Software Foundation (ASF) under one or more +contributor license agreements. See the NOTICE file distributed with +this work for additional information regarding copyright ownership. +The ASF licenses this file to You under the Apache License, Version 2.0 +(the "License"); you may not use this file except in compliance with +the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +*/ + +package api + +import ( + "encoding/json" + "github.com/apache/incubator-devlake/errors" + + "github.com/apache/incubator-devlake/plugins/core" + "github.com/apache/incubator-devlake/plugins/helper" + "github.com/apache/incubator-devlake/plugins/webhook/tasks" +) + +func MakePipelinePlan(subtaskMetas []core.SubTaskMeta, connectionId uint64, scope []*core.BlueprintScopeV100) (core.PipelinePlan, errors.Error) { Review Comment: fixed -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
