DeforaNetworks/corteza
3
0
Fork 0
Code Activity

Fix system REST api naming consistency (remove/delete)

Browse Source
This commit is contained in:
Denis Arh
2019-02-24 10:29:20 +01:00
parent bbaa78b297
commit 996a9fca67
13 changed files with 45 additions and 45 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
api/system/spec.json
View File

@@ -110,7 +110,7 @@
}
},
{
"name": "remove",
"name": "delete",
"method": "DELETE",
"title": "Remove organisation",
"path": "/{id}",
@@ -254,7 +254,7 @@
}
},
{
"name": "remove",
"name": "delete",
"method": "DELETE",
"title": "Remove role",
"path": "/{roleID}",
@@ -525,7 +525,7 @@
}
},
{
"name": "remove",
"name": "delete",
"method": "DELETE",
"title": "Remove user",
"path": "/{userID}",

2
api/system/spec/organisation.json
View File

@@ -68,7 +68,7 @@
}
},
{
"Name": "remove",
"Name": "delete",
"Method": "DELETE",
"Title": "Remove organisation",
"Path": "/{id}",

2
api/system/spec/role.json
View File

@@ -96,7 +96,7 @@
}
},
{
"Name": "remove",
"Name": "delete",
"Method": "DELETE",
"Title": "Remove role",
"Path": "/{roleID}",

2
api/system/spec/user.json
View File

@@ -131,7 +131,7 @@
}
},
{
"Name": "remove",
"Name": "delete",
"Method": "DELETE",
"Title": "Remove user",
"Path": "/{userID}",

12
system/rest/handlers/organisation.go
View File

@@ -30,7 +30,7 @@ type OrganisationAPI interface {
List(context.Context, *request.OrganisationList) (interface{}, error)
Create(context.Context, *request.OrganisationCreate) (interface{}, error)
Update(context.Context, *request.OrganisationUpdate) (interface{}, error)
Remove(context.Context, *request.OrganisationRemove) (interface{}, error)
Delete(context.Context, *request.OrganisationDelete) (interface{}, error)
Read(context.Context, *request.OrganisationRead) (interface{}, error)
Archive(context.Context, *request.OrganisationArchive) (interface{}, error)
}
@@ -40,7 +40,7 @@ type Organisation struct {
List func(http.ResponseWriter, *http.Request)
Create func(http.ResponseWriter, *http.Request)
Update func(http.ResponseWriter, *http.Request)
Remove func(http.ResponseWriter, *http.Request)
Delete func(http.ResponseWriter, *http.Request)
Read func(http.ResponseWriter, *http.Request)
Archive func(http.ResponseWriter, *http.Request)
}
@@ -68,11 +68,11 @@ func NewOrganisation(oh OrganisationAPI) *Organisation {
return oh.Update(r.Context(), params)
})
},
Remove: func(w http.ResponseWriter, r *http.Request) {
Delete: func(w http.ResponseWriter, r *http.Request) {
defer r.Body.Close()
params := request.NewOrganisationRemove()
params := request.NewOrganisationDelete()
resputil.JSON(w, params.Fill(r), func() (interface{}, error) {
return oh.Remove(r.Context(), params)
return oh.Delete(r.Context(), params)
})
},
Read: func(w http.ResponseWriter, r *http.Request) {
@@ -99,7 +99,7 @@ func (oh *Organisation) MountRoutes(r chi.Router, middlewares ...func(http.Handl
r.Get("/", oh.List)
r.Post("/", oh.Create)
r.Put("/{id}", oh.Update)
r.Delete("/{id}", oh.Remove)
r.Delete("/{id}", oh.Delete)
r.Get("/{id}", oh.Read)
r.Post("/{id}/archive", oh.Archive)
})

12
system/rest/handlers/role.go
View File

@@ -31,7 +31,7 @@ type RoleAPI interface {
Create(context.Context, *request.RoleCreate) (interface{}, error)
Update(context.Context, *request.RoleUpdate) (interface{}, error)
Read(context.Context, *request.RoleRead) (interface{}, error)
Remove(context.Context, *request.RoleRemove) (interface{}, error)
Delete(context.Context, *request.RoleDelete) (interface{}, error)
Archive(context.Context, *request.RoleArchive) (interface{}, error)
Move(context.Context, *request.RoleMove) (interface{}, error)
Merge(context.Context, *request.RoleMerge) (interface{}, error)
@@ -46,7 +46,7 @@ type Role struct {
Create func(http.ResponseWriter, *http.Request)
Update func(http.ResponseWriter, *http.Request)
Read func(http.ResponseWriter, *http.Request)
Remove func(http.ResponseWriter, *http.Request)
Delete func(http.ResponseWriter, *http.Request)
Archive func(http.ResponseWriter, *http.Request)
Move func(http.ResponseWriter, *http.Request)
Merge func(http.ResponseWriter, *http.Request)
@@ -85,11 +85,11 @@ func NewRole(rh RoleAPI) *Role {
return rh.Read(r.Context(), params)
})
},
Remove: func(w http.ResponseWriter, r *http.Request) {
Delete: func(w http.ResponseWriter, r *http.Request) {
defer r.Body.Close()
params := request.NewRoleRemove()
params := request.NewRoleDelete()
resputil.JSON(w, params.Fill(r), func() (interface{}, error) {
return rh.Remove(r.Context(), params)
return rh.Delete(r.Context(), params)
})
},
Archive: func(w http.ResponseWriter, r *http.Request) {
@@ -145,7 +145,7 @@ func (rh *Role) MountRoutes(r chi.Router, middlewares ...func(http.Handler) http
r.Post("/", rh.Create)
r.Put("/{roleID}", rh.Update)
r.Get("/{roleID}", rh.Read)
r.Delete("/{roleID}", rh.Remove)
r.Delete("/{roleID}", rh.Delete)
r.Post("/{roleID}/archive", rh.Archive)
r.Post("/{roleID}/move", rh.Move)
r.Post("/{roleID}/merge", rh.Merge)

12
system/rest/handlers/user.go
View File

@@ -31,7 +31,7 @@ type UserAPI interface {
Create(context.Context, *request.UserCreate) (interface{}, error)
Update(context.Context, *request.UserUpdate) (interface{}, error)
Read(context.Context, *request.UserRead) (interface{}, error)
Remove(context.Context, *request.UserRemove) (interface{}, error)
Delete(context.Context, *request.UserDelete) (interface{}, error)
Suspend(context.Context, *request.UserSuspend) (interface{}, error)
Unsuspend(context.Context, *request.UserUnsuspend) (interface{}, error)
}
@@ -42,7 +42,7 @@ type User struct {
Create func(http.ResponseWriter, *http.Request)
Update func(http.ResponseWriter, *http.Request)
Read func(http.ResponseWriter, *http.Request)
Remove func(http.ResponseWriter, *http.Request)
Delete func(http.ResponseWriter, *http.Request)
Suspend func(http.ResponseWriter, *http.Request)
Unsuspend func(http.ResponseWriter, *http.Request)
}
@@ -77,11 +77,11 @@ func NewUser(uh UserAPI) *User {
return uh.Read(r.Context(), params)
})
},
Remove: func(w http.ResponseWriter, r *http.Request) {
Delete: func(w http.ResponseWriter, r *http.Request) {
defer r.Body.Close()
params := request.NewUserRemove()
params := request.NewUserDelete()
resputil.JSON(w, params.Fill(r), func() (interface{}, error) {
return uh.Remove(r.Context(), params)
return uh.Delete(r.Context(), params)
})
},
Suspend: func(w http.ResponseWriter, r *http.Request) {
@@ -109,7 +109,7 @@ func (uh *User) MountRoutes(r chi.Router, middlewares ...func(http.Handler) http
r.Post("/", uh.Create)
r.Put("/{userID}", uh.Update)
r.Get("/{userID}", uh.Read)
r.Delete("/{userID}", uh.Remove)
r.Delete("/{userID}", uh.Delete)
r.Post("/{userID}/suspend", uh.Suspend)
r.Post("/{userID}/unsuspend", uh.Unsuspend)
})

2
system/rest/organisation.go
View File

@@ -51,7 +51,7 @@ func (ctrl *Organisation) Update(ctx context.Context, r *request.OrganisationUpd
return ctrl.svc.org.With(ctx).Update(org)
}
func (ctrl *Organisation) Remove(ctx context.Context, r *request.OrganisationRemove) (interface{}, error) {
func (ctrl *Organisation) Delete(ctx context.Context, r *request.OrganisationDelete) (interface{}, error) {
return nil, ctrl.svc.org.With(ctx).Delete(r.ID)
}

12
system/rest/request/organisation.go
View File

@@ -169,16 +169,16 @@ func (or *OrganisationUpdate) Fill(r *http.Request) (err error) {
var _ RequestFiller = NewOrganisationUpdate()
// Organisation remove request parameters
type OrganisationRemove struct {
// Organisation delete request parameters
type OrganisationDelete struct {
ID uint64 `json:",string"`
}
func NewOrganisationRemove() *OrganisationRemove {
return &OrganisationRemove{}
func NewOrganisationDelete() *OrganisationDelete {
return &OrganisationDelete{}
}
func (or *OrganisationRemove) Fill(r *http.Request) (err error) {
func (or *OrganisationDelete) Fill(r *http.Request) (err error) {
if strings.ToLower(r.Header.Get("content-type")) == "application/json" {
err = json.NewDecoder(r.Body).Decode(or)
@@ -210,7 +210,7 @@ func (or *OrganisationRemove) Fill(r *http.Request) (err error) {
return err
}
var _ RequestFiller = NewOrganisationRemove()
var _ RequestFiller = NewOrganisationDelete()
// Organisation read request parameters
type OrganisationRead struct {

12
system/rest/request/role.go
View File

@@ -214,16 +214,16 @@ func (ro *RoleRead) Fill(r *http.Request) (err error) {
var _ RequestFiller = NewRoleRead()
// Role remove request parameters
type RoleRemove struct {
// Role delete request parameters
type RoleDelete struct {
RoleID uint64 `json:",string"`
}
func NewRoleRemove() *RoleRemove {
return &RoleRemove{}
func NewRoleDelete() *RoleDelete {
return &RoleDelete{}
}
func (ro *RoleRemove) Fill(r *http.Request) (err error) {
func (ro *RoleDelete) Fill(r *http.Request) (err error) {
if strings.ToLower(r.Header.Get("content-type")) == "application/json" {
err = json.NewDecoder(r.Body).Decode(ro)
@@ -255,7 +255,7 @@ func (ro *RoleRemove) Fill(r *http.Request) (err error) {
return err
}
var _ RequestFiller = NewRoleRemove()
var _ RequestFiller = NewRoleDelete()
// Role archive request parameters
type RoleArchive struct {

12
system/rest/request/user.go
View File

@@ -252,16 +252,16 @@ func (us *UserRead) Fill(r *http.Request) (err error) {
var _ RequestFiller = NewUserRead()
// User remove request parameters
type UserRemove struct {
// User delete request parameters
type UserDelete struct {
UserID uint64 `json:",string"`
}
func NewUserRemove() *UserRemove {
return &UserRemove{}
func NewUserDelete() *UserDelete {
return &UserDelete{}
}
func (us *UserRemove) Fill(r *http.Request) (err error) {
func (us *UserDelete) Fill(r *http.Request) (err error) {
if strings.ToLower(r.Header.Get("content-type")) == "application/json" {
err = json.NewDecoder(r.Body).Decode(us)
@@ -293,7 +293,7 @@ func (us *UserRemove) Fill(r *http.Request) (err error) {
return err
}
var _ RequestFiller = NewUserRemove()
var _ RequestFiller = NewUserDelete()
// User suspend request parameters
type UserSuspend struct {

2
system/rest/role.go
View File

@@ -87,7 +87,7 @@ func (ctrl *Role) Update(ctx context.Context, r *request.RoleUpdate) (interface{
return role, nil
}
func (ctrl *Role) Remove(ctx context.Context, r *request.RoleRemove) (interface{}, error) {
func (ctrl *Role) Delete(ctx context.Context, r *request.RoleDelete) (interface{}, error) {
return nil, ctrl.svc.role.With(ctx).Delete(r.RoleID)
}

2
system/rest/user.go
View File

@@ -60,7 +60,7 @@ func (ctrl *User) Read(ctx context.Context, r *request.UserRead) (interface{}, e
return ctrl.user.With(ctx).FindByID(r.UserID)
}
func (ctrl *User) Remove(ctx context.Context, r *request.UserRemove) (interface{}, error) {
func (ctrl *User) Delete(ctx context.Context, r *request.UserDelete) (interface{}, error) {
return nil, ctrl.user.With(ctx).Delete(r.UserID)
}