github/kubevela
1
0
Fork 0
mirror of https://github.com/kubevela/kubevela.git synced 2026-08-19 04:26:39 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fix: The generated swagger.json is malformed. (#3372) (#3373)

Browse Source 
Signed-off-by: Zhiyu Wang <zhiyuwang.newbis@gmail.com>
This commit is contained in:
Zhiyu Wang
2022-03-08 15:48:05 +08:00
committed by GitHub
parent b5ce5df9c5
commit bed1fb373e
17 changed files with 883 additions and 520 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/apidoc/swagger.json
+708 -358
View File
File diff suppressed because it is too large Load Diff
pkg/apiserver/rest/apis/v1/types.go
+5
View File
@@ -1054,3 +1054,8 @@ type SystemVersion struct {
VelaVersion string `json:"velaVersion"`
GitVersion string `json:"gitVersion"`
}
// SimpleResponse simple response model for temporary
type SimpleResponse struct {
Status string `json:"status"`
}
pkg/apiserver/rest/webservice/addon.go
+14 -14
View File
@@ -58,8 +58,8 @@ func (s *addonWebService) GetWebService() *restful.WebService {
Metadata(restfulspec.KeyOpenAPITags, tags).
Param(ws.QueryParameter("registry", "filter addons from given registry").DataType("string")).
Param(ws.QueryParameter("query", "Fuzzy search based on name and description.").DataType("string")).
Returns(200, "", apis.ListAddonResponse{}).
Returns(400, "", bcode.Bcode{}).
Returns(200, "OK", apis.ListAddonResponse{}).
Returns(400, "Bad Request", bcode.Bcode{}).
Writes(apis.ListAddonResponse{}))
// GET
@@ -67,8 +67,8 @@ func (s *addonWebService) GetWebService() *restful.WebService {
Doc("show details of an addon").
Metadata(restfulspec.KeyOpenAPITags, tags).
Metadata(restfulspec.KeyOpenAPITags, tags).
Returns(200, "", apis.DetailAddonResponse{}).
Returns(400, "", bcode.Bcode{}).
Returns(200, "OK", apis.DetailAddonResponse{}).
Returns(400, "Bad Request", bcode.Bcode{}).
Param(ws.PathParameter("name", "addon name to query detail").DataType("string").Required(true)).
Param(ws.QueryParameter("registry", "filter addons from given registry").DataType("string")).
Writes(apis.DetailAddonResponse{}))
@@ -77,8 +77,8 @@ func (s *addonWebService) GetWebService() *restful.WebService {
ws.Route(ws.GET("/{name}/status").To(s.statusAddon).
Doc("show status of an addon").
Metadata(restfulspec.KeyOpenAPITags, tags).
Returns(200, "", apis.AddonStatusResponse{}).
Returns(400, "", bcode.Bcode{}).
Returns(200, "OK", apis.AddonStatusResponse{}).
Returns(400, "Bad Request", bcode.Bcode{}).
Param(ws.PathParameter("name", "addon name to query status").DataType("string").Required(true)).
Writes(apis.AddonStatusResponse{}))
@@ -87,8 +87,8 @@ func (s *addonWebService) GetWebService() *restful.WebService {
Doc("enable an addon").
Metadata(restfulspec.KeyOpenAPITags, tags).
Reads(apis.EnableAddonRequest{}).
Returns(200, "", apis.AddonStatusResponse{}).
Returns(400, "", bcode.Bcode{}).
Returns(200, "OK", apis.AddonStatusResponse{}).
Returns(400, "Bad Request", bcode.Bcode{}).
Param(ws.PathParameter("name", "addon name to enable").DataType("string").Required(true)).
Writes(apis.AddonStatusResponse{}))
@@ -96,8 +96,8 @@ func (s *addonWebService) GetWebService() *restful.WebService {
ws.Route(ws.POST("/{name}/disable").To(s.disableAddon).
Doc("disable an addon").
Metadata(restfulspec.KeyOpenAPITags, tags).
Returns(200, "", apis.AddonStatusResponse{}).
Returns(400, "", bcode.Bcode{}).
Returns(200, "OK", apis.AddonStatusResponse{}).
Returns(400, "Bad Request", bcode.Bcode{}).
Param(ws.PathParameter("name", "addon name to enable").DataType("string").Required(true)).
Writes(apis.AddonStatusResponse{}))
@@ -106,8 +106,8 @@ func (s *addonWebService) GetWebService() *restful.WebService {
Doc("update an addon").
Metadata(restfulspec.KeyOpenAPITags, tags).
Reads(apis.EnableAddonRequest{}).
Returns(200, "", apis.AddonStatusResponse{}).
Returns(400, "", bcode.Bcode{}).
Returns(200, "OK", apis.AddonStatusResponse{}).
Returns(400, "Bad Request", bcode.Bcode{}).
Param(ws.PathParameter("name", "addon name to update").DataType("string").Required(true)).
Writes(apis.AddonStatusResponse{}))
@@ -250,8 +250,8 @@ func (s *enabledAddonWebService) GetWebService() *restful.WebService {
Metadata(restfulspec.KeyOpenAPITags, tags).
Param(ws.QueryParameter("registry", "filter addons from given registry").DataType("string")).
Param(ws.QueryParameter("query", "Fuzzy search based on name and description.").DataType("string")).
Returns(200, "", apis.ListAddonResponse{}).
Returns(400, "", bcode.Bcode{}).
Returns(200, "OK", apis.ListAddonResponse{}).
Returns(400, "Bad Request", bcode.Bcode{}).
Writes(apis.ListAddonResponse{}))
return ws
pkg/apiserver/rest/webservice/addon_registry.go
+8 -8
View File
@@ -50,15 +50,15 @@ func (s *addonRegistryWebService) GetWebService() *restful.WebService {
Doc("create an addon registry").
Metadata(restfulspec.KeyOpenAPITags, tags).
Reads(apis.CreateAddonRegistryRequest{}).
Returns(200, "", apis.AddonRegistry{}).
Returns(400, "", bcode.Bcode{}).
Returns(200, "OK", apis.AddonRegistry{}).
Returns(400, "Bad Request", bcode.Bcode{}).
Writes(apis.AddonRegistry{}))
ws.Route(ws.GET("/").To(s.listAddonRegistry).
Doc("list all addon registry").
Metadata(restfulspec.KeyOpenAPITags, tags).
Returns(200, "", apis.ListAddonRegistryResponse{}).
Returns(400, "", bcode.Bcode{}).
Returns(200, "OK", apis.ListAddonRegistryResponse{}).
Returns(400, "Bad Request", bcode.Bcode{}).
Writes(apis.ListAddonRegistryResponse{}))
// Delete
@@ -66,8 +66,8 @@ func (s *addonRegistryWebService) GetWebService() *restful.WebService {
Doc("delete an addon registry").
Metadata(restfulspec.KeyOpenAPITags, tags).
Param(ws.PathParameter("name", "identifier of the addon registry").DataType("string")).
Returns(200, "", apis.AddonRegistry{}).
Returns(400, "", bcode.Bcode{}).
Returns(200, "OK", apis.AddonRegistry{}).
Returns(400, "Bad Request", bcode.Bcode{}).
Writes(apis.AddonRegistry{}))
ws.Route(ws.PUT("/{name}").To(s.updateAddonRegistry).
@@ -75,8 +75,8 @@ func (s *addonRegistryWebService) GetWebService() *restful.WebService {
Metadata(restfulspec.KeyOpenAPITags, tags).
Reads(apis.UpdateAddonRegistryRequest{}).
Param(ws.PathParameter("name", "identifier of the addon registry").DataType("string")).
Returns(200, "", apis.AddonRegistry{}).
Returns(400, "", bcode.Bcode{}).
Returns(200, "OK", apis.AddonRegistry{}).
Returns(400, "Bad Request", bcode.Bcode{}).
Writes(apis.AddonRegistry{}))
return ws
pkg/apiserver/rest/webservice/application.go
+85 -84
View File
@@ -64,16 +64,16 @@ func (c *applicationWebService) GetWebService() *restful.WebService {
Param(ws.QueryParameter("query", "Fuzzy search based on name or description").DataType("string")).
Param(ws.QueryParameter("namespace", "The namespace of the managed cluster").DataType("string")).
Param(ws.QueryParameter("targetName", "Name of the application delivery target").DataType("string")).
Returns(200, "", apis.ListApplicationResponse{}).
Returns(400, "", bcode.Bcode{}).
Returns(200, "OK", apis.ListApplicationResponse{}).
Returns(400, "Bad Request", bcode.Bcode{}).
Writes(apis.ListApplicationResponse{}))
ws.Route(ws.POST("/").To(c.createApplication).
Doc("create one application ").
Metadata(restfulspec.KeyOpenAPITags, tags).
Reads(apis.CreateApplicationRequest{}).
Returns(200, "", apis.ApplicationBase{}).
Returns(400, "", bcode.Bcode{}).
Returns(200, "OK", apis.ApplicationBase{}).
Returns(400, "Bad Request", bcode.Bcode{}).
Writes(apis.ApplicationBase{}))
ws.Route(ws.DELETE("/{name}").To(c.deleteApplication).
@@ -81,8 +81,8 @@ func (c *applicationWebService) GetWebService() *restful.WebService {
Metadata(restfulspec.KeyOpenAPITags, tags).
Filter(c.appCheckFilter).
Param(ws.PathParameter("name", "identifier of the application ").DataType("string")).
Returns(200, "", apis.EmptyResponse{}).
Returns(400, "", bcode.Bcode{}).
Returns(200, "OK", apis.EmptyResponse{}).
Returns(400, "Bad Request", bcode.Bcode{}).
Writes(apis.EmptyResponse{}))
ws.Route(ws.GET("/{name}").To(c.detailApplication).
@@ -90,8 +90,8 @@ func (c *applicationWebService) GetWebService() *restful.WebService {
Metadata(restfulspec.KeyOpenAPITags, tags).
Filter(c.appCheckFilter).
Param(ws.PathParameter("name", "identifier of the application ").DataType("string")).
Returns(200, "", apis.DetailApplicationResponse{}).
Returns(400, "", bcode.Bcode{}).
Returns(200, "OK", apis.DetailApplicationResponse{}).
Returns(400, "Bad Request", bcode.Bcode{}).
Writes(apis.DetailApplicationResponse{}))
ws.Route(ws.PUT("/{name}").To(c.updateApplication).
@@ -100,8 +100,8 @@ func (c *applicationWebService) GetWebService() *restful.WebService {
Filter(c.appCheckFilter).
Param(ws.PathParameter("name", "identifier of the application ").DataType("string")).
Reads(apis.UpdateApplicationRequest{}).
Returns(200, "", apis.ApplicationBase{}).
Returns(400, "", bcode.Bcode{}).
Returns(200, "OK", apis.ApplicationBase{}).
Returns(400, "Bad Request", bcode.Bcode{}).
Writes(apis.ApplicationBase{}))
ws.Route(ws.GET("/{name}/statistics").To(c.applicationStatistics).
@@ -109,8 +109,8 @@ func (c *applicationWebService) GetWebService() *restful.WebService {
Metadata(restfulspec.KeyOpenAPITags, tags).
Filter(c.appCheckFilter).
Param(ws.PathParameter("name", "identifier of the application ").DataType("string")).
Returns(200, "", apis.ApplicationStatisticsResponse{}).
Returns(400, "", bcode.Bcode{}).
Returns(200, "OK", apis.ApplicationStatisticsResponse{}).
Returns(400, "Bad Request", bcode.Bcode{}).
Writes(apis.ApplicationStatisticsResponse{}))
ws.Route(ws.POST("/{name}/triggers").To(c.createApplicationTrigger).
@@ -119,8 +119,8 @@ func (c *applicationWebService) GetWebService() *restful.WebService {
Filter(c.appCheckFilter).
Param(ws.PathParameter("name", "identifier of the application ").DataType("string")).
Reads(apis.CreateApplicationTriggerRequest{}).
Returns(200, "", apis.ApplicationTriggerBase{}).
Returns(400, "", bcode.Bcode{}).
Returns(200, "OK", apis.ApplicationTriggerBase{}).
Returns(400, "Bad Request", bcode.Bcode{}).
Writes(apis.ApplicationTriggerBase{}))
ws.Route(ws.DELETE("/{name}/triggers/{token}").To(c.deleteApplicationTrigger).
@@ -129,8 +129,8 @@ func (c *applicationWebService) GetWebService() *restful.WebService {
Filter(c.appCheckFilter).
Param(ws.PathParameter("name", "identifier of the application ").DataType("string")).
Param(ws.PathParameter("token", "identifier of the trigger").DataType("string")).
Returns(200, "", apis.EmptyResponse{}).
Returns(400, "", bcode.Bcode{}).
Returns(200, "OK", apis.EmptyResponse{}).
Returns(400, "Bad Request", bcode.Bcode{}).
Writes([]*apis.EmptyResponse{}))
ws.Route(ws.GET("/{name}/triggers").To(c.listApplicationTriggers).
@@ -138,8 +138,8 @@ func (c *applicationWebService) GetWebService() *restful.WebService {
Metadata(restfulspec.KeyOpenAPITags, tags).
Filter(c.appCheckFilter).
Param(ws.PathParameter("name", "identifier of the application ").DataType("string")).
Returns(200, "", apis.ListApplicationTriggerResponse{}).
Returns(400, "", bcode.Bcode{}).
Returns(200, "OK", apis.ListApplicationTriggerResponse{}).
Returns(400, "Bad Request", bcode.Bcode{}).
Writes([]*apis.ApplicationTriggerBase{}))
ws.Route(ws.POST("/{name}/template").To(c.publishApplicationTemplate).
@@ -148,8 +148,8 @@ func (c *applicationWebService) GetWebService() *restful.WebService {
Filter(c.appCheckFilter).
Param(ws.PathParameter("name", "identifier of the application ").DataType("string")).
Reads(apis.CreateApplicationTemplateRequest{}).
Returns(200, "", apis.ApplicationTemplateBase{}).
Returns(400, "", bcode.Bcode{}).
Returns(200, "OK", apis.ApplicationTemplateBase{}).
Returns(400, "Bad Request", bcode.Bcode{}).
Writes(apis.ApplicationTemplateBase{}))
ws.Route(ws.POST("/{name}/deploy").To(c.deployApplication).
@@ -158,8 +158,8 @@ func (c *applicationWebService) GetWebService() *restful.WebService {
Filter(c.appCheckFilter).
Param(ws.PathParameter("name", "identifier of the application ").DataType("string")).
Reads(apis.ApplicationDeployRequest{}).
Returns(200, "", apis.ApplicationDeployResponse{}).
Returns(400, "", bcode.Bcode{}).
Returns(200, "OK", apis.ApplicationDeployResponse{}).
Returns(400, "Bad Request", bcode.Bcode{}).
Writes(apis.ApplicationDeployResponse{}))
ws.Route(ws.GET("/{name}/components").To(c.listApplicationComponents).
@@ -168,8 +168,8 @@ func (c *applicationWebService) GetWebService() *restful.WebService {
Param(ws.PathParameter("name", "identifier of the application ").DataType("string")).
Param(ws.QueryParameter("envName", "list components that deployed in define env").DataType("string")).
Metadata(restfulspec.KeyOpenAPITags, tags).
Returns(200, "", apis.ComponentListResponse{}).
Returns(400, "", bcode.Bcode{}).
Returns(200, "OK", apis.ComponentListResponse{}).
Returns(400, "Bad Request", bcode.Bcode{}).
Writes(apis.ComponentListResponse{}))
ws.Route(ws.POST("/{name}/components").To(c.createComponent).
@@ -178,8 +178,8 @@ func (c *applicationWebService) GetWebService() *restful.WebService {
Param(ws.PathParameter("name", "identifier of the application ").DataType("string")).
Metadata(restfulspec.KeyOpenAPITags, tags).
Reads(apis.CreateComponentRequest{}).
Returns(200, "", apis.ComponentBase{}).
Returns(400, "", bcode.Bcode{}).
Returns(200, "OK", apis.ComponentBase{}).
Returns(400, "Bad Request", bcode.Bcode{}).
Writes(apis.ComponentBase{}))
ws.Route(ws.GET("/{name}/components/{compName}").To(c.detailComponent).
@@ -187,9 +187,10 @@ func (c *applicationWebService) GetWebService() *restful.WebService {
Filter(c.appCheckFilter).
Filter(c.componentCheckFilter).
Param(ws.PathParameter("name", "identifier of the application ").DataType("string")).
Param(ws.PathParameter("compName", "identifier of the component").DataType("string")).
Metadata(restfulspec.KeyOpenAPITags, tags).
Returns(200, "", apis.DetailComponentResponse{}).
Returns(400, "", bcode.Bcode{}).
Returns(200, "OK", apis.DetailComponentResponse{}).
Returns(400, "Bad Request", bcode.Bcode{}).
Writes(apis.DetailComponentResponse{}))
ws.Route(ws.PUT("/{name}/components/{compName}").To(c.updateComponent).
@@ -200,8 +201,8 @@ func (c *applicationWebService) GetWebService() *restful.WebService {
Param(ws.PathParameter("compName", "identifier of the component").DataType("string")).
Metadata(restfulspec.KeyOpenAPITags, tags).
Reads(apis.UpdateApplicationComponentRequest{}).
Returns(200, "", apis.ComponentBase{}).
Returns(400, "", bcode.Bcode{}).
Returns(200, "OK", apis.ComponentBase{}).
Returns(400, "Bad Request", bcode.Bcode{}).
Writes(apis.ComponentBase{}))
ws.Route(ws.DELETE("/{name}/components/{compName}").To(c.deleteComponent).
@@ -211,9 +212,9 @@ func (c *applicationWebService) GetWebService() *restful.WebService {
Param(ws.PathParameter("name", "identifier of the application").DataType("string")).
Param(ws.PathParameter("compName", "identifier of the component").DataType("string")).
Metadata(restfulspec.KeyOpenAPITags, tags).
Returns(200, "", apis.EmptyResponse{}).
Returns(400, "", bcode.Bcode{}).
Returns(404, "", bcode.Bcode{}).
Returns(200, "OK", apis.EmptyResponse{}).
Returns(400, "Bad Request", bcode.Bcode{}).
Returns(404, "Not Found", bcode.Bcode{}).
Writes(apis.EmptyResponse{}))
ws.Route(ws.GET("/{name}/policies").To(c.listApplicationPolicies).
@@ -221,8 +222,8 @@ func (c *applicationWebService) GetWebService() *restful.WebService {
Filter(c.appCheckFilter).
Param(ws.PathParameter("name", "identifier of the application ").DataType("string")).
Metadata(restfulspec.KeyOpenAPITags, tags).
Returns(200, "", apis.ListApplicationPolicy{}).
Returns(400, "", bcode.Bcode{}).
Returns(200, "OK", apis.ListApplicationPolicy{}).
Returns(400, "Bad Request", bcode.Bcode{}).
Writes(apis.ListApplicationPolicy{}))
ws.Route(ws.POST("/{name}/policies").To(c.createApplicationPolicy).
@@ -231,8 +232,8 @@ func (c *applicationWebService) GetWebService() *restful.WebService {
Param(ws.PathParameter("name", "identifier of the application").DataType("string")).
Metadata(restfulspec.KeyOpenAPITags, tags).
Reads(apis.CreatePolicyRequest{}).
Returns(200, "", apis.PolicyBase{}).
Returns(400, "", bcode.Bcode{}).
Returns(200, "OK", apis.PolicyBase{}).
Returns(400, "Bad Request", bcode.Bcode{}).
Writes(apis.PolicyBase{}))
ws.Route(ws.GET("/{name}/policies/{policyName}").To(c.detailApplicationPolicy).
@@ -241,8 +242,8 @@ func (c *applicationWebService) GetWebService() *restful.WebService {
Param(ws.PathParameter("name", "identifier of the application").DataType("string")).
Param(ws.PathParameter("policyName", "identifier of the application policy").DataType("string")).
Metadata(restfulspec.KeyOpenAPITags, tags).
Returns(200, "", apis.DetailPolicyResponse{}).
Returns(400, "", bcode.Bcode{}).
Returns(200, "OK", apis.DetailPolicyResponse{}).
Returns(400, "Bad Request", bcode.Bcode{}).
Writes(apis.DetailPolicyResponse{}))
ws.Route(ws.DELETE("/{name}/policies/{policyName}").To(c.deleteApplicationPolicy).
@@ -251,8 +252,8 @@ func (c *applicationWebService) GetWebService() *restful.WebService {
Param(ws.PathParameter("name", "identifier of the application").DataType("string")).
Param(ws.PathParameter("policyName", "identifier of the application policy").DataType("string")).
Metadata(restfulspec.KeyOpenAPITags, tags).
Returns(200, "", apis.EmptyResponse{}).
Returns(400, "", bcode.Bcode{}).
Returns(200, "OK", apis.EmptyResponse{}).
Returns(400, "Bad Request", bcode.Bcode{}).
Writes(apis.EmptyResponse{}))
ws.Route(ws.PUT("/{name}/policies/{policyName}").To(c.updateApplicationPolicy).
@@ -262,8 +263,8 @@ func (c *applicationWebService) GetWebService() *restful.WebService {
Param(ws.PathParameter("policyName", "identifier of the application policy").DataType("string")).
Metadata(restfulspec.KeyOpenAPITags, tags).
Reads(apis.UpdatePolicyRequest{}).
Returns(200, "", apis.DetailPolicyResponse{}).
Returns(400, "", bcode.Bcode{}).
Returns(200, "OK", apis.DetailPolicyResponse{}).
Returns(400, "Bad Request", bcode.Bcode{}).
Writes(apis.DetailPolicyResponse{}))
ws.Route(ws.POST("/{name}/components/{compName}/traits").To(c.addApplicationTrait).
@@ -274,8 +275,8 @@ func (c *applicationWebService) GetWebService() *restful.WebService {
Param(ws.PathParameter("compName", "identifier of the component").DataType("string")).
Metadata(restfulspec.KeyOpenAPITags, tags).
Reads(apis.CreateApplicationTraitRequest{}).
Returns(200, "", apis.EmptyResponse{}).
Returns(400, "", bcode.Bcode{}).
Returns(200, "OK", apis.EmptyResponse{}).
Returns(400, "Bad Request", bcode.Bcode{}).
Writes(apis.ApplicationTrait{}))
ws.Route(ws.PUT("/{name}/components/{compName}/traits/{traitType}").To(c.updateApplicationTrait).
@@ -287,8 +288,8 @@ func (c *applicationWebService) GetWebService() *restful.WebService {
Param(ws.PathParameter("traitType", "identifier of the type of trait").DataType("string")).
Metadata(restfulspec.KeyOpenAPITags, tags).
Reads(apis.UpdateApplicationTraitRequest{}).
Returns(200, "", apis.ApplicationTrait{}).
Returns(400, "", bcode.Bcode{}).
Returns(200, "OK", apis.ApplicationTrait{}).
Returns(400, "Bad Request", bcode.Bcode{}).
Writes(apis.ApplicationTrait{}))
ws.Route(ws.DELETE("/{name}/components/{compName}/traits/{traitType}").To(c.deleteApplicationTrait).
@@ -299,8 +300,8 @@ func (c *applicationWebService) GetWebService() *restful.WebService {
Param(ws.PathParameter("compName", "identifier of the component").DataType("string")).
Param(ws.PathParameter("traitType", "identifier of the type of trait").DataType("string")).
Metadata(restfulspec.KeyOpenAPITags, tags).
Returns(200, "", apis.ApplicationTrait{}).
Returns(400, "", bcode.Bcode{}).
Returns(200, "OK", apis.ApplicationTrait{}).
Returns(400, "Bad Request", bcode.Bcode{}).
Writes(apis.EmptyResponse{}))
ws.Route(ws.GET("/{name}/revisions").To(c.listApplicationRevisions).
@@ -312,8 +313,8 @@ func (c *applicationWebService) GetWebService() *restful.WebService {
Param(ws.QueryParameter("page", "query the page number").DataType("integer")).
Param(ws.QueryParameter("pageSize", "query the page size number").DataType("integer")).
Metadata(restfulspec.KeyOpenAPITags, tags).
Returns(200, "", apis.ListRevisionsResponse{}).
Returns(400, "", bcode.Bcode{}).
Returns(200, "OK", apis.ListRevisionsResponse{}).
Returns(400, "Bad Request", bcode.Bcode{}).
Writes(apis.ListRevisionsResponse{}))
ws.Route(ws.GET("/{name}/revisions/{revision}").To(c.detailApplicationRevision).
@@ -322,8 +323,8 @@ func (c *applicationWebService) GetWebService() *restful.WebService {
Param(ws.PathParameter("name", "identifier of the application").DataType("string")).
Param(ws.PathParameter("revision", "identifier of the application revision").DataType("string")).
Metadata(restfulspec.KeyOpenAPITags, tags).
Returns(200, "", apis.DetailRevisionResponse{}).
Returns(400, "", bcode.Bcode{}).
Returns(200, "OK", apis.DetailRevisionResponse{}).
Returns(400, "Bad Request", bcode.Bcode{}).
Writes(apis.DetailRevisionResponse{}))
ws.Route(ws.GET("/{name}/envs").To(c.listApplicationEnvs).
@@ -331,8 +332,8 @@ func (c *applicationWebService) GetWebService() *restful.WebService {
Filter(c.appCheckFilter).
Param(ws.PathParameter("name", "identifier of the application ").DataType("string")).
Metadata(restfulspec.KeyOpenAPITags, tags).
Returns(200, "", apis.ListApplicationEnvBinding{}).
Returns(400, "", bcode.Bcode{}).
Returns(200, "OK", apis.ListApplicationEnvBinding{}).
Returns(400, "Bad Request", bcode.Bcode{}).
Writes(apis.ListApplicationEnvBinding{}))
ws.Route(ws.POST("/{name}/envs").To(c.createApplicationEnv).
@@ -341,8 +342,8 @@ func (c *applicationWebService) GetWebService() *restful.WebService {
Filter(c.appCheckFilter).
Param(ws.PathParameter("name", "identifier of the application ").DataType("string")).
Reads(apis.CreateApplicationEnvbindingRequest{}).
Returns(200, "", apis.EnvBinding{}).
Returns(400, "", bcode.Bcode{}).
Returns(200, "OK", apis.EnvBinding{}).
Returns(400, "Bad Request", bcode.Bcode{}).
Writes(apis.EmptyResponse{}))
ws.Route(ws.PUT("/{name}/envs/{envName}").To(c.updateApplicationEnv).
@@ -353,8 +354,8 @@ func (c *applicationWebService) GetWebService() *restful.WebService {
Param(ws.PathParameter("name", "identifier of the application ").DataType("string")).
Param(ws.PathParameter("envName", "identifier of the envBinding ").DataType("string")).
Reads(apis.PutApplicationEnvBindingRequest{}).
Returns(200, "", apis.EnvBinding{}).
Returns(400, "", bcode.Bcode{}).
Returns(200, "OK", apis.EnvBinding{}).
Returns(400, "Bad Request", bcode.Bcode{}).
Writes(apis.EnvBinding{}))
ws.Route(ws.DELETE("/{name}/envs/{envName}").To(c.deleteApplicationEnv).
@@ -364,8 +365,8 @@ func (c *applicationWebService) GetWebService() *restful.WebService {
Filter(c.envCheckFilter).
Param(ws.PathParameter("name", "identifier of the application ").DataType("string")).
Param(ws.PathParameter("envName", "identifier of the envBinding ").DataType("string")).
Returns(200, "", apis.EmptyResponse{}).
Returns(404, "", bcode.Bcode{}).
Returns(200, "OK", apis.EmptyResponse{}).
Returns(404, "Not Found", bcode.Bcode{}).
Writes(apis.EmptyResponse{}))
ws.Route(ws.GET("/{name}/envs/{envName}/status").To(c.getApplicationStatus).
@@ -375,8 +376,8 @@ func (c *applicationWebService) GetWebService() *restful.WebService {
Filter(c.envCheckFilter).
Param(ws.PathParameter("name", "identifier of the application ").DataType("string")).
Param(ws.PathParameter("envName", "identifier of the application envbinding").DataType("string")).
Returns(200, "", apis.ApplicationStatusResponse{}).
Returns(400, "", bcode.Bcode{}).
Returns(200, "OK", apis.ApplicationStatusResponse{}).
Returns(400, "Bad Request", bcode.Bcode{}).
Writes(apis.ApplicationStatusResponse{}))
ws.Route(ws.POST("/{name}/envs/{envName}/recycle").To(c.recycleApplicationEnv).
@@ -386,8 +387,8 @@ func (c *applicationWebService) GetWebService() *restful.WebService {
Filter(c.envCheckFilter).
Param(ws.PathParameter("name", "identifier of the application ").DataType("string").Required(true)).
Param(ws.PathParameter("envName", "identifier of the application envbinding").DataType("string").Required(true)).
Returns(200, "", apis.EmptyResponse{}).
Returns(400, "", bcode.Bcode{}).
Returns(200, "OK", apis.EmptyResponse{}).
Returns(400, "Bad Request", bcode.Bcode{}).
Writes(apis.EmptyResponse{}))
ws.Route(ws.GET("/{name}/workflows").To(c.listApplicationWorkflows).
@@ -395,7 +396,7 @@ func (c *applicationWebService) GetWebService() *restful.WebService {
Filter(c.appCheckFilter).
Param(ws.PathParameter("name", "identifier of the application.").DataType("string").Required(true)).
Metadata(restfulspec.KeyOpenAPITags, tags).
Returns(200, "", apis.ListWorkflowResponse{}).
Returns(200, "OK", apis.ListWorkflowResponse{}).
Writes(apis.ListWorkflowResponse{}).Do(returns200, returns500))
ws.Route(ws.POST("/{name}/workflows").To(c.createOrUpdateApplicationWorkflow).
@@ -427,7 +428,7 @@ func (c *applicationWebService) GetWebService() *restful.WebService {
Param(ws.PathParameter("name", "identifier of the application.").DataType("string").Required(true)).
Param(ws.PathParameter("workflowName", "identifier of the workflow").DataType("string")).
Reads(apis.UpdateWorkflowRequest{}).
Returns(200, "", apis.DetailWorkflowResponse{}).
Returns(200, "OK", apis.DetailWorkflowResponse{}).
Writes(apis.DetailWorkflowResponse{}).Do(returns200, returns500))
ws.Route(ws.DELETE("/{name}/workflows/{workflowName}").To(c.deleteWorkflow).
@@ -437,7 +438,7 @@ func (c *applicationWebService) GetWebService() *restful.WebService {
Filter(c.workflowCheckFilter).
Param(ws.PathParameter("name", "identifier of the application.").DataType("string").Required(true)).
Param(ws.PathParameter("workflowName", "identifier of the workflow").DataType("string")).
Returns(200, "", apis.EmptyResponse{}).
Returns(200, "OK", apis.EmptyResponse{}).
Writes(apis.EmptyResponse{}).Do(returns200, returns500))
ws.Route(ws.GET("/{name}/workflows/{workflowName}/records").To(c.listWorkflowRecords).
@@ -449,7 +450,7 @@ func (c *applicationWebService) GetWebService() *restful.WebService {
Filter(c.workflowCheckFilter).
Param(ws.QueryParameter("page", "query the page number").DataType("integer")).
Param(ws.QueryParameter("pageSize", "query the page size number").DataType("integer")).
Returns(200, "", apis.ListWorkflowRecordsResponse{}).
Returns(200, "OK", apis.ListWorkflowRecordsResponse{}).
Writes(apis.ListWorkflowRecordsResponse{}).Do(returns200, returns500))
ws.Route(ws.GET("/{name}/workflows/{workflowName}/records/{record}").To(c.detailWorkflowRecord).
@@ -460,7 +461,7 @@ func (c *applicationWebService) GetWebService() *restful.WebService {
Metadata(restfulspec.KeyOpenAPITags, tags).
Filter(c.appCheckFilter).
Filter(c.workflowCheckFilter).
Returns(200, "", apis.DetailWorkflowRecordResponse{}).
Returns(200, "OK", apis.DetailWorkflowRecordResponse{}).
Writes(apis.DetailWorkflowRecordResponse{}).Do(returns200, returns500))
ws.Route(ws.GET("/{name}/workflows/{workflowName}/records/{record}/resume").To(c.resumeWorkflowRecord).
@@ -471,8 +472,8 @@ func (c *applicationWebService) GetWebService() *restful.WebService {
Metadata(restfulspec.KeyOpenAPITags, tags).
Filter(c.appCheckFilter).
Filter(c.workflowCheckFilter).
Returns(200, "", nil).
Returns(400, "", bcode.Bcode{}).
Returns(200, "OK", nil).
Returns(400, "Bad Request", bcode.Bcode{}).
Writes(apis.DetailWorkflowRecordResponse{}))
ws.Route(ws.GET("/{name}/workflows/{workflowName}/records/{record}/terminate").To(c.terminateWorkflowRecord).
@@ -483,8 +484,8 @@ func (c *applicationWebService) GetWebService() *restful.WebService {
Metadata(restfulspec.KeyOpenAPITags, tags).
Filter(c.appCheckFilter).
Filter(c.workflowCheckFilter).
Returns(200, "", nil).
Returns(400, "", bcode.Bcode{}).
Returns(200, "OK", nil).
Returns(400, "Bad Request", bcode.Bcode{}).
Writes(apis.DetailWorkflowRecordResponse{}))
ws.Route(ws.GET("/{name}/workflows/{workflowName}/records/{record}/rollback").To(c.rollbackWorkflowRecord).
@@ -496,8 +497,8 @@ func (c *applicationWebService) GetWebService() *restful.WebService {
Metadata(restfulspec.KeyOpenAPITags, tags).
Filter(c.appCheckFilter).
Filter(c.workflowCheckFilter).
Returns(200, "", nil).
Returns(400, "", bcode.Bcode{}).
Returns(200, "OK", nil).
Returns(400, "Bad Request", bcode.Bcode{}).
Writes(apis.DetailWorkflowRecordResponse{}))
ws.Route(ws.GET("/{name}/records").To(c.listApplicationRecords).
@@ -505,8 +506,8 @@ func (c *applicationWebService) GetWebService() *restful.WebService {
Param(ws.PathParameter("name", "identifier of the application.").DataType("string").Required(true)).
Metadata(restfulspec.KeyOpenAPITags, tags).
Filter(c.appCheckFilter).
Returns(200, "", nil).
Returns(400, "", bcode.Bcode{}).
Returns(200, "OK", nil).
Returns(400, "Bad Request", bcode.Bcode{}).
Writes(apis.ListWorkflowRecordsResponse{}))
ws.Route(ws.POST("/{name}/compare").To(c.compareAppWithLatestRevision).
@@ -514,8 +515,8 @@ func (c *applicationWebService) GetWebService() *restful.WebService {
Metadata(restfulspec.KeyOpenAPITags, tags).
Filter(c.appCheckFilter).
Param(ws.PathParameter("name", "identifier of the application ").DataType("string")).
Returns(200, "", apis.ApplicationBase{}).
Returns(400, "", bcode.Bcode{}).
Returns(200, "OK", apis.ApplicationBase{}).
Returns(400, "Bad Request", bcode.Bcode{}).
Writes(apis.AppCompareResponse{}))
ws.Route(ws.POST("/{name}/reset").To(c.resetAppToLatestRevision).
@@ -523,8 +524,8 @@ func (c *applicationWebService) GetWebService() *restful.WebService {
Metadata(restfulspec.KeyOpenAPITags, tags).
Filter(c.appCheckFilter).
Param(ws.PathParameter("name", "identifier of the application ").DataType("string")).
Returns(200, "", apis.AppResetResponse{}).
Returns(400, "", bcode.Bcode{}).
Returns(200, "OK", apis.AppResetResponse{}).
Returns(400, "Bad Request", bcode.Bcode{}).
Writes(apis.AppResetResponse{}))
ws.Route(ws.POST("/{name}/dry-run").To(c.dryRunAppOrRevision).
@@ -532,8 +533,8 @@ func (c *applicationWebService) GetWebService() *restful.WebService {
Metadata(restfulspec.KeyOpenAPITags, tags).
Filter(c.appCheckFilter).
Param(ws.PathParameter("name", "identifier of the application ").DataType("string")).
Returns(200, "", apis.AppDryRunResponse{}).
Returns(400, "", bcode.Bcode{}).
Returns(200, "OK", apis.AppDryRunResponse{}).
Returns(400, "Bad Request", bcode.Bcode{}).
Writes(apis.AppDryRunResponse{}))
return ws
pkg/apiserver/rest/webservice/cluster.go
+29 -29
View File
@@ -50,26 +50,26 @@ func (c *ClusterWebService) GetWebService() *restful.WebService {
Doc("list all clusters").
Metadata(restfulspec.KeyOpenAPITags, tags).
Param(ws.QueryParameter("query", "Fuzzy search based on name or description").DataType("string")).
Param(ws.QueryParameter("page", "Page for paging").DataType("int").DefaultValue("0")).
Param(ws.QueryParameter("pageSize", "PageSize for paging").DataType("int").DefaultValue("20")).
Returns(200, "", apis.ListClusterResponse{}).
Returns(400, "", bcode.Bcode{}).
Param(ws.QueryParameter("page", "Page for paging").DataType("integer").DefaultValue("0")).
Param(ws.QueryParameter("pageSize", "PageSize for paging").DataType("integer").DefaultValue("20")).
Returns(200, "OK", apis.ListClusterResponse{}).
Returns(400, "Bad Request", bcode.Bcode{}).
Writes(apis.ListClusterResponse{}).Do(returns200, returns500))
ws.Route(ws.POST("/").To(c.createKubeCluster).
Doc("create cluster").
Metadata(restfulspec.KeyOpenAPITags, tags).
Reads(&apis.CreateClusterRequest{}).
Returns(200, "", apis.ClusterBase{}).
Returns(400, "", bcode.Bcode{}).
Reads(apis.CreateClusterRequest{}).
Returns(200, "OK", apis.ClusterBase{}).
Returns(400, "Bad Request", bcode.Bcode{}).
Writes(apis.ClusterBase{}))
ws.Route(ws.GET("/{clusterName}").To(c.getKubeCluster).
Doc("detail cluster info").
Metadata(restfulspec.KeyOpenAPITags, tags).
Param(ws.PathParameter("clusterName", "identifier of the cluster").DataType("string")).
Returns(200, "", apis.DetailClusterResponse{}).
Returns(400, "", bcode.Bcode{}).
Returns(200, "OK", apis.DetailClusterResponse{}).
Returns(400, "Bad Request", bcode.Bcode{}).
Writes(apis.DetailClusterResponse{}))
ws.Route(ws.PUT("/{clusterName}").To(c.modifyKubeCluster).
@@ -77,16 +77,16 @@ func (c *ClusterWebService) GetWebService() *restful.WebService {
Metadata(restfulspec.KeyOpenAPITags, tags).
Param(ws.PathParameter("clusterName", "identifier of the cluster").DataType("string")).
Reads(apis.CreateClusterRequest{}).
Returns(200, "", apis.ClusterBase{}).
Returns(400, "", bcode.Bcode{}).
Returns(200, "OK", apis.ClusterBase{}).
Returns(400, "Bad Request", bcode.Bcode{}).
Writes(apis.ClusterBase{}))
ws.Route(ws.DELETE("/{clusterName}").To(c.deleteKubeCluster).
Doc("delete cluster").
Metadata(restfulspec.KeyOpenAPITags, tags).
Param(ws.PathParameter("clusterName", "identifier of the cluster").DataType("string")).
Returns(200, "", apis.ClusterBase{}).
Returns(400, "", bcode.Bcode{}).
Returns(200, "OK", apis.ClusterBase{}).
Returns(400, "Bad Request", bcode.Bcode{}).
Writes(apis.ClusterBase{}))
ws.Route(ws.POST("/{clusterName}/namespaces").To(c.createNamespace).
@@ -94,19 +94,19 @@ func (c *ClusterWebService) GetWebService() *restful.WebService {
Metadata(restfulspec.KeyOpenAPITags, tags).
Param(ws.PathParameter("clusterName", "name of the target cluster").DataType("string")).
Reads(apis.CreateClusterNamespaceRequest{}).
Returns(200, "", apis.CreateClusterNamespaceResponse{}).
Returns(400, "", bcode.Bcode{}).
Returns(200, "OK", apis.CreateClusterNamespaceResponse{}).
Returns(400, "Bad Request", bcode.Bcode{}).
Writes(apis.CreateClusterNamespaceResponse{}))
ws.Route(ws.POST("/cloud_clusters/{provider}").To(c.listCloudClusters).
Doc("list cloud clusters").
Metadata(restfulspec.KeyOpenAPITags, tags).
Param(ws.PathParameter("provider", "identifier of the cloud provider").DataType("string")).
Param(ws.QueryParameter("page", "Page for paging").DataType("int").DefaultValue("0")).
Param(ws.QueryParameter("pageSize", "PageSize for paging").DataType("int").DefaultValue("20")).
Param(ws.QueryParameter("page", "Page for paging").DataType("integer").DefaultValue("0")).
Param(ws.QueryParameter("pageSize", "PageSize for paging").DataType("integer").DefaultValue("20")).
Reads(apis.AccessKeyRequest{}).
Returns(200, "", apis.ListCloudClusterResponse{}).
Returns(400, "", bcode.Bcode{}).
Returns(200, "OK", apis.ListCloudClusterResponse{}).
Returns(400, "Bad Request", bcode.Bcode{}).
Writes(apis.ListCloudClusterResponse{}))
ws.Route(ws.POST("/cloud_clusters/{provider}/connect").To(c.connectCloudCluster).
@@ -114,8 +114,8 @@ func (c *ClusterWebService) GetWebService() *restful.WebService {
Metadata(restfulspec.KeyOpenAPITags, tags).
Param(ws.PathParameter("provider", "identifier of the cloud provider").DataType("string")).
Reads(apis.ConnectCloudClusterRequest{}).
Returns(200, "", apis.ClusterBase{}).
Returns(400, "", bcode.Bcode{}).
Returns(200, "OK", apis.ClusterBase{}).
Returns(400, "Bad Request", bcode.Bcode{}).
Writes(apis.ClusterBase{}))
ws.Route(ws.POST("/cloud_clusters/{provider}/create").To(c.createCloudCluster).
@@ -123,8 +123,8 @@ func (c *ClusterWebService) GetWebService() *restful.WebService {
Metadata(restfulspec.KeyOpenAPITags, tags).
Param(ws.PathParameter("provider", "identifier of the cloud provider").DataType("string").Required(true)).
Reads(apis.CreateCloudClusterRequest{}).
Returns(200, "", apis.CreateCloudClusterResponse{}).
Returns(400, "", bcode.Bcode{}).
Returns(200, "OK", apis.CreateCloudClusterResponse{}).
Returns(400, "Bad Request", bcode.Bcode{}).
Writes(apis.CreateCloudClusterResponse{}))
ws.Route(ws.GET("/cloud_clusters/{provider}/creation/{cloudClusterName}").To(c.getCloudClusterCreationStatus).
@@ -132,16 +132,16 @@ func (c *ClusterWebService) GetWebService() *restful.WebService {
Metadata(restfulspec.KeyOpenAPITags, tags).
Param(ws.PathParameter("provider", "identifier of the cloud provider").DataType("string")).
Param(ws.PathParameter("cloudClusterName", "identifier for cloud cluster which is creating").DataType("string")).
Returns(200, "", apis.CreateCloudClusterResponse{}).
Returns(400, "", bcode.Bcode{}).
Returns(200, "OK", apis.CreateCloudClusterResponse{}).
Returns(400, "Bad Request", bcode.Bcode{}).
Writes(apis.CreateCloudClusterResponse{}))
ws.Route(ws.GET("/cloud_clusters/{provider}/creation").To(c.listCloudClusterCreation).
Doc("list cloud cluster creation").
Metadata(restfulspec.KeyOpenAPITags, tags).
Param(ws.PathParameter("provider", "identifier of the cloud provider").DataType("string")).
Returns(200, "", apis.ListCloudClusterCreationResponse{}).
Returns(400, "", bcode.Bcode{}).
Returns(200, "OK", apis.ListCloudClusterCreationResponse{}).
Returns(400, "Bad Request", bcode.Bcode{}).
Writes(apis.ListCloudClusterCreationResponse{}))
ws.Route(ws.DELETE("/cloud_clusters/{provider}/creation/{cloudClusterName}").To(c.deleteCloudClusterCreation).
@@ -149,8 +149,8 @@ func (c *ClusterWebService) GetWebService() *restful.WebService {
Metadata(restfulspec.KeyOpenAPITags, tags).
Param(ws.PathParameter("provider", "identifier of the cloud provider").DataType("string")).
Param(ws.PathParameter("cloudClusterName", "identifier for cloud cluster which is creating").DataType("string")).
Returns(200, "", apis.CreateCloudClusterResponse{}).
Returns(400, "", bcode.Bcode{}).
Returns(200, "OK", apis.CreateCloudClusterResponse{}).
Returns(400, "Bad Request", bcode.Bcode{}).
Writes(apis.CreateCloudClusterResponse{}))
return ws
pkg/apiserver/rest/webservice/definition.go
+1 -1
View File
@@ -44,7 +44,7 @@ func (d *definitionWebservice) GetWebService() *restful.WebService {
Param(ws.QueryParameter("type", "query the definition type").DataType("string").Required(true).AllowableValues(map[string]string{"component": "", "trait": "", "workflowstep": ""})).
Param(ws.QueryParameter("envName", "if specified, query the definition supported by the env.").DataType("string")).
Param(ws.QueryParameter("appliedWorkload", "if specified, query the trait definition applied to the workload.").DataType("string")).
Returns(200, "", apis.ListDefinitionResponse{}).
Returns(200, "OK", apis.ListDefinitionResponse{}).
Writes(apis.ListDefinitionResponse{}).Do(returns200, returns500))
ws.Route(ws.GET("/{name}").To(d.detailDefinition).
pkg/apiserver/rest/webservice/env.go
+10 -5
View File
@@ -47,31 +47,36 @@ func (n *envWebService) GetWebService() *restful.WebService {
tags := []string{"env"}
ws.Route(ws.GET("/").To(n.list).
Operation("envlist").
Doc("list all envs").
Metadata(restfulspec.KeyOpenAPITags, tags).
Returns(200, "", apis.ListEnvResponse{}).
Returns(200, "OK", apis.ListEnvResponse{}).
Writes(apis.ListEnvResponse{}))
ws.Route(ws.POST("/").To(n.create).
Operation("envcreate").
Doc("create an env").
Metadata(restfulspec.KeyOpenAPITags, tags).
Reads(apis.CreateEnvRequest{}).
Returns(200, "", apis.Env{}).
Returns(200, "OK", apis.Env{}).
Writes(apis.Env{}))
ws.Route(ws.PUT("/{name}").To(n.update).
Operation("envupdate").
Doc("update an env").
Metadata(restfulspec.KeyOpenAPITags, tags).
Param(ws.PathParameter("name", "identifier of the application ").DataType("string")).
Reads(apis.CreateEnvRequest{}).
Returns(200, "", apis.Env{}).
Returns(200, "OK", apis.Env{}).
Writes(apis.Env{}))
ws.Route(ws.DELETE("/{name}").To(n.delete).
Operation("envdelete").
Doc("delete one env").
Metadata(restfulspec.KeyOpenAPITags, tags).
Param(ws.PathParameter("name", "identifier of the application ").DataType("string")).
Returns(200, "", apis.EmptyResponse{}).
Returns(400, "", bcode.Bcode{}).
Returns(200, "OK", apis.EmptyResponse{}).
Returns(400, "Bad Request", bcode.Bcode{}).
Writes(apis.EmptyResponse{}))
return ws
}
pkg/apiserver/rest/webservice/oam_application.go
+2 -1
View File
@@ -51,7 +51,7 @@ func (c *oamApplicationWebService) GetWebService() *restful.WebService {
Metadata(restfulspec.KeyOpenAPITags, tags).
Param(ws.PathParameter("namespace", "identifier of the namespace").DataType("string")).
Param(ws.PathParameter("appname", "identifier of the oam application").DataType("string")).
Returns(200, "", apis.ApplicationResponse{}).
Returns(200, "OK", apis.ApplicationResponse{}).
Writes(apis.ApplicationResponse{}))
ws.Route(ws.POST("/namespaces/{namespace}/applications/{appname}").To(c.createOrUpdateApplication).
@@ -62,6 +62,7 @@ func (c *oamApplicationWebService) GetWebService() *restful.WebService {
Reads(apis.ApplicationRequest{}))
ws.Route(ws.DELETE("/namespaces/{namespace}/applications/{appname}").To(c.deleteApplication).
Operation("deleteOAMApplication").
Doc("create or update oam application in the specified namespace").
Metadata(restfulspec.KeyOpenAPITags, tags).
Param(ws.PathParameter("namespace", "identifier of the namespace").DataType("string")).
pkg/apiserver/rest/webservice/payload_types.go
+2 -2
View File
@@ -39,8 +39,8 @@ func (c *payloadTypesWebservice) GetWebService() *restful.WebService {
ws.Route(ws.GET("/").To(c.ListPayloadTypes).
Doc("list application trigger payload types").
Metadata(restfulspec.KeyOpenAPITags, tags).
Returns(200, "", nil).
Returns(400, "", bcode.Bcode{}).
Returns(200, "OK", nil).
Returns(400, "Bad Request", bcode.Bcode{}).
Writes([]string{}))
return ws
pkg/apiserver/rest/webservice/policy_definition.go
+1 -1
View File
@@ -38,7 +38,7 @@ func (c *policyDefinitionWebservice) GetWebService() *restful.WebService {
ws.Route(ws.GET("/").To(noop).
Doc("list all policydefinition").
Metadata(restfulspec.KeyOpenAPITags, tags).
Returns(200, "", apis.ListPolicyDefinitionResponse{}).
Returns(200, "OK", apis.ListPolicyDefinitionResponse{}).
Writes(apis.ListPolicyDefinitionResponse{}))
return ws
}
pkg/apiserver/rest/webservice/project.go
+2 -2
View File
@@ -47,14 +47,14 @@ func (n *projectWebService) GetWebService() *restful.WebService {
ws.Route(ws.GET("/").To(n.listprojects).
Doc("list all projects").
Metadata(restfulspec.KeyOpenAPITags, tags).
Returns(200, "", apis.ListProjectResponse{}).
Returns(200, "OK", apis.ListProjectResponse{}).
Writes(apis.ListProjectResponse{}))
ws.Route(ws.POST("/").To(n.createproject).
Doc("create a project").
Metadata(restfulspec.KeyOpenAPITags, tags).
Reads(apis.CreateProjectRequest{}).
Returns(200, "", apis.ProjectBase{}).
Returns(200, "OK", apis.ProjectBase{}).
Writes(apis.ProjectBase{}))
return ws
}
pkg/apiserver/rest/webservice/system_info.go
+6 -6
View File
@@ -46,23 +46,23 @@ func (u systemInfoWebService) GetWebService() *restful.WebService {
// Get
ws.Route(ws.GET("/").To(u.getSystemInfo).
Metadata(restfulspec.KeyOpenAPITags, tags).
Returns(200, "", apis.SystemInfoResponse{}).
Returns(400, "", bcode.Bcode{}).
Returns(200, "OK", apis.SystemInfoResponse{}).
Returns(400, "Bad Request", bcode.Bcode{}).
Writes(apis.SystemInfoResponse{}))
// Delete
ws.Route(ws.DELETE("/").To(u.deleteSystemInfo).
Metadata(restfulspec.KeyOpenAPITags, tags).
Returns(200, "", apis.SystemInfoResponse{}).
Returns(400, "", bcode.Bcode{}).
Returns(200, "OK", apis.SystemInfoResponse{}).
Returns(400, "Bad Request", bcode.Bcode{}).
Writes(apis.SystemInfoResponse{}))
// Post
ws.Route(ws.PUT("/").To(u.updateSystemInfo).
Metadata(restfulspec.KeyOpenAPITags, tags).
Reads(apis.SystemInfoRequest{}).
Returns(200, "", apis.SystemInfoResponse{}).
Returns(400, "", bcode.Bcode{}).
Returns(200, "OK", apis.SystemInfoResponse{}).
Returns(400, "Bad Request", bcode.Bcode{}).
Writes(apis.SystemInfoResponse{}))
return ws
pkg/apiserver/rest/webservice/target.go
+3 -3
View File
@@ -63,7 +63,7 @@ func (dt *TargetWebService) GetWebService() *restful.WebService {
Metadata(restfulspec.KeyOpenAPITags, tags).
Param(ws.QueryParameter("page", "Page for paging").DataType("integer")).
Param(ws.QueryParameter("pageSize", "PageSize for paging").DataType("integer")).
Returns(200, "", apis.ListTargetResponse{}).
Returns(200, "OK", apis.ListTargetResponse{}).
Writes(apis.ListTargetResponse{}).Do(returns200, returns500))
ws.Route(ws.POST("/").To(dt.createTarget).
@@ -88,7 +88,7 @@ func (dt *TargetWebService) GetWebService() *restful.WebService {
Filter(dt.targetCheckFilter).
Param(ws.PathParameter("name", "identifier of the Target").DataType("string")).
Reads(apis.UpdateTargetRequest{}).
Returns(200, "", apis.DetailTargetResponse{}).
Returns(200, "OK", apis.DetailTargetResponse{}).
Writes(apis.DetailTargetResponse{}).Do(returns200, returns500))
ws.Route(ws.DELETE("/{name}").To(dt.deleteTarget).
@@ -96,7 +96,7 @@ func (dt *TargetWebService) GetWebService() *restful.WebService {
Metadata(restfulspec.KeyOpenAPITags, tags).
Filter(dt.targetCheckFilter).
Param(ws.PathParameter("name", "identifier of the Target").DataType("string")).
Returns(200, "", apis.EmptyResponse{}).
Returns(200, "OK", apis.EmptyResponse{}).
Writes(apis.EmptyResponse{}).Do(returns200, returns500))
return ws
pkg/apiserver/rest/webservice/velaql.go
+2 -2
View File
@@ -49,8 +49,8 @@ func (v *velaQLWebService) GetWebService() *restful.WebService {
Doc("use velaQL to query resource status").
Metadata(restfulspec.KeyOpenAPITags, tags).
Param(ws.QueryParameter("velaql", "velaql query statement").DataType("string")).
Returns(200, "", apis.VelaQLViewResponse{}).
Returns(400, "", bcode.Bcode{}).
Returns(200, "OK", apis.VelaQLViewResponse{}).
Returns(400, "Bad Request", bcode.Bcode{}).
Writes(apis.VelaQLViewResponse{}))
return ws
pkg/apiserver/rest/webservice/webhook.go
+3 -3
View File
@@ -50,10 +50,10 @@ func (c *webhookWebService) GetWebService() *restful.WebService {
ws.Route(ws.POST("/{token}").To(c.handleApplicationWebhook).
Doc("handle application webhook request").
Metadata(restfulspec.KeyOpenAPITags, tags).
Param(ws.PathParameter("name", "identifier of the application ").DataType("string")).
Param(ws.PathParameter("token", "webhook token").DataType("string")).
Reads(apis.HandleApplicationTriggerWebhookRequest{}).
Returns(200, "", apis.ApplicationDeployResponse{}).
Returns(400, "", bcode.Bcode{}).
Returns(200, "OK", apis.ApplicationDeployResponse{}).
Returns(400, "Bad Request", bcode.Bcode{}).
Writes(apis.ApplicationDeployResponse{}))
return ws
}
pkg/apiserver/rest/webservice/webservice.go
+2 -1
View File
@@ -23,6 +23,7 @@ import (
"github.com/emicklei/go-restful/v3"
"github.com/oam-dev/kubevela/pkg/apiserver/datastore"
apisv1 "github.com/oam-dev/kubevela/pkg/apiserver/rest/apis/v1"
"github.com/oam-dev/kubevela/pkg/apiserver/rest/usecase"
)
@@ -49,7 +50,7 @@ func GetRegisteredWebService() []WebService {
func noop(req *restful.Request, resp *restful.Response) {}
func returns200(b *restful.RouteBuilder) {
b.Returns(http.StatusOK, "OK", map[string]string{"status": "ok"})
b.Returns(http.StatusOK, "OK", apisv1.SimpleResponse{Status: "ok"})
}
func returns500(b *restful.RouteBuilder) {