-
Notifications
You must be signed in to change notification settings - Fork 875
/
definition.go
172 lines (152 loc) · 6.39 KB
/
definition.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
/*
Copyright 2021 The KubeVela Authors.
Licensed 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 (
"strconv"
restfulspec "github.com/emicklei/go-restful-openapi/v2"
restful "github.com/emicklei/go-restful/v3"
"github.com/oam-dev/kubevela/pkg/apiserver/domain/service"
apis "github.com/oam-dev/kubevela/pkg/apiserver/interfaces/api/dto/v1"
"github.com/oam-dev/kubevela/pkg/apiserver/utils"
"github.com/oam-dev/kubevela/pkg/apiserver/utils/bcode"
)
type definition struct {
DefinitionService service.DefinitionService `inject:""`
RbacService service.RBACService `inject:""`
}
func (d *definition) GetWebServiceRoute() *restful.WebService {
ws := new(restful.WebService)
ws.Path(versionPrefix+"/definitions").
Consumes(restful.MIME_XML, restful.MIME_JSON).
Produces(restful.MIME_JSON, restful.MIME_XML).
Doc("api for definition manage")
tags := []string{"definition"}
ws.Route(ws.GET("/").To(d.listDefinitions).
Doc("list all definitions").
Metadata(restfulspec.KeyOpenAPITags, tags).
// TODO: provide project scope api for query definition list
// Filter(d.RbacService.CheckPerm("definition", "list")).
Param(ws.QueryParameter("type", "query the definition type").DataType("string").Required(true).AllowableValues(map[string]string{"component": "", "trait": "", "workflowstep": ""})).
Param(ws.QueryParameter("queryAll", "query all definitions include hidden in UI").DataType("boolean").DefaultValue("false")).
Param(ws.QueryParameter("appliedWorkload", "if specified, query the trait definition applied to the workload").DataType("string")).
Param(ws.QueryParameter("ownerAddon", "query by which addon created the definition").DataType("string")).
Param(ws.QueryParameter("scope", "query by the specified scope like WorkflowRun or Application").DataType("string")).
Returns(200, "OK", apis.ListDefinitionResponse{}).
Writes(apis.ListDefinitionResponse{}).Do(returns200, returns500))
ws.Route(ws.GET("/{definitionName}").To(d.detailDefinition).
Doc("Detail a definition").
// Filter(d.RbacService.CheckPerm("definition", "detail")).
Param(ws.PathParameter("definitionName", "identifier of the definition").DataType("string")).
Param(ws.QueryParameter("type", "query the definition type").DataType("string")).
Metadata(restfulspec.KeyOpenAPITags, tags).
Returns(200, "create successfully", apis.DetailDefinitionResponse{}).
Writes(apis.DetailDefinitionResponse{}).Do(returns200, returns500))
ws.Route(ws.PUT("/{definitionName}/uischema").To(d.updateUISchema).
Doc("Update the UI schema for a definition").
Filter(d.RbacService.CheckPerm("definition", "update")).
Metadata(restfulspec.KeyOpenAPITags, tags).
Reads(apis.UpdateUISchemaRequest{}).
Returns(200, "update successfully", utils.UISchema{}).
Writes(apis.DetailDefinitionResponse{}).Do(returns200, returns500))
ws.Route(ws.PUT("/{definitionName}/status").To(d.updateDefinitionStatus).
Doc("Update the status for a definition").
Filter(d.RbacService.CheckPerm("definition", "update")).
Metadata(restfulspec.KeyOpenAPITags, tags).
Reads(apis.UpdateDefinitionStatusRequest{}).
Returns(200, "update successfully", utils.UISchema{}).
Writes(apis.DetailDefinitionResponse{}).Do(returns200, returns500))
ws.Filter(authCheckFilter)
return ws
}
// NewDefinition new definition
func NewDefinition() Interface {
return &definition{}
}
func (d *definition) listDefinitions(req *restful.Request, res *restful.Response) {
queryAll, err := strconv.ParseBool(req.QueryParameter("queryAll"))
if err != nil {
queryAll = false
}
definitions, err := d.DefinitionService.ListDefinitions(req.Request.Context(), service.DefinitionQueryOption{
Type: req.QueryParameter("type"),
AppliedWorkloads: req.QueryParameter("appliedWorkload"),
OwnerAddon: req.QueryParameter("ownerAddon"),
Scope: req.QueryParameter("scope"),
QueryAll: queryAll,
})
if err != nil {
bcode.ReturnError(req, res, err)
return
}
if err := res.WriteEntity(apis.ListDefinitionResponse{Definitions: definitions}); err != nil {
bcode.ReturnError(req, res, err)
return
}
}
func (d *definition) detailDefinition(req *restful.Request, res *restful.Response) {
definition, err := d.DefinitionService.DetailDefinition(req.Request.Context(), req.PathParameter("definitionName"), req.QueryParameter("type"))
if err != nil {
bcode.ReturnError(req, res, err)
return
}
if err := res.WriteEntity(definition); err != nil {
bcode.ReturnError(req, res, err)
return
}
}
func (d *definition) updateUISchema(req *restful.Request, res *restful.Response) {
// Verify the validity of parameters
var updateReq apis.UpdateUISchemaRequest
if err := req.ReadEntity(&updateReq); err != nil {
bcode.ReturnError(req, res, err)
return
}
if err := validate.Struct(&updateReq); err != nil {
bcode.ReturnError(req, res, err)
return
}
if err := updateReq.UISchema.Validate(); err != nil {
bcode.ReturnError(req, res, bcode.ErrInvalidDefinitionUISchema.SetMessage(err.Error()))
return
}
schema, err := d.DefinitionService.AddDefinitionUISchema(req.Request.Context(), req.PathParameter("definitionName"), updateReq.DefinitionType, updateReq.UISchema)
if err != nil {
bcode.ReturnError(req, res, err)
return
}
if err := res.WriteEntity(schema); err != nil {
bcode.ReturnError(req, res, err)
return
}
}
func (d *definition) updateDefinitionStatus(req *restful.Request, res *restful.Response) {
// Verify the validity of parameters
var updateReq apis.UpdateDefinitionStatusRequest
if err := req.ReadEntity(&updateReq); err != nil {
bcode.ReturnError(req, res, err)
return
}
if err := validate.Struct(&updateReq); err != nil {
bcode.ReturnError(req, res, err)
return
}
schema, err := d.DefinitionService.UpdateDefinitionStatus(req.Request.Context(), req.PathParameter("definitionName"), updateReq)
if err != nil {
bcode.ReturnError(req, res, err)
return
}
if err := res.WriteEntity(schema); err != nil {
bcode.ReturnError(req, res, err)
return
}
}