From afc0172bc3b3155afca394a7465b0b65ff0787d4 Mon Sep 17 00:00:00 2001 From: Ray Zhou Date: Tue, 2 Jul 2019 15:35:26 +0800 Subject: [PATCH] Update IAM API docs --- pkg/apis/iam/v1alpha2/register.go | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/pkg/apis/iam/v1alpha2/register.go b/pkg/apis/iam/v1alpha2/register.go index c3d09b5ab..8ef738006 100644 --- a/pkg/apis/iam/v1alpha2/register.go +++ b/pkg/apis/iam/v1alpha2/register.go @@ -135,7 +135,7 @@ func addWebService(c *restful.Container) error { Metadata(restfulspec.KeyOpenAPITags, []string{constants.IdentityManagementTag})) ws.Route(ws.DELETE("/users/{user}"). To(iam.DeleteUser). - Doc("Delete a specified user."). + Doc("Delete the specified user."). Param(ws.PathParameter("user", "username")). Returns(http.StatusOK, ok, errors.Error{}). Metadata(restfulspec.KeyOpenAPITags, []string{constants.IdentityManagementTag})) @@ -159,7 +159,7 @@ func addWebService(c *restful.Container) error { Metadata(restfulspec.KeyOpenAPITags, []string{constants.IdentityManagementTag})) ws.Route(ws.GET("/users/{user}/roles"). To(iam.ListUserRoles). - Doc("Retrieve all the roles that are assigned to the user."). + Doc("Retrieve all the roles that are assigned to the specified user."). Param(ws.PathParameter("user", "username")). Returns(http.StatusOK, ok, iam.RoleList{}). Metadata(restfulspec.KeyOpenAPITags, []string{constants.AccessManagementTag})) @@ -251,14 +251,14 @@ func addWebService(c *restful.Container) error { Metadata(restfulspec.KeyOpenAPITags, []string{constants.AccessManagementTag})) ws.Route(ws.POST("/workspaces/{workspace}/members"). To(iam.InviteUser). - Doc("Invite members to the workspace."). + Doc("Invite a member to the specified workspace."). Param(ws.PathParameter("workspace", "workspace name")). Reads(InviteUserRequest{}). Returns(http.StatusOK, ok, errors.Error{}). Metadata(restfulspec.KeyOpenAPITags, []string{constants.AccessManagementTag})) ws.Route(ws.DELETE("/workspaces/{workspace}/members/{member}"). To(iam.RemoveUser). - Doc("Remove members from the workspace."). + Doc("Remove the specified member from the workspace."). Param(ws.PathParameter("workspace", "workspace name")). Param(ws.PathParameter("member", "username")). Returns(http.StatusOK, ok, errors.Error{}).