From 37dca3a7a3690cfcbbd57070b78ec34e0d30177b Mon Sep 17 00:00:00 2001 From: Ray Zhou Date: Thu, 27 Jun 2019 16:32:53 +0800 Subject: [PATCH] Update IM api docs --- pkg/apis/iam/v1alpha2/register.go | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/pkg/apis/iam/v1alpha2/register.go b/pkg/apis/iam/v1alpha2/register.go index 955448c5..fe4758b3 100644 --- a/pkg/apis/iam/v1alpha2/register.go +++ b/pkg/apis/iam/v1alpha2/register.go @@ -135,20 +135,20 @@ func addWebService(c *restful.Container) error { Metadata(restfulspec.KeyOpenAPITags, tags)) ws.Route(ws.DELETE("/users/{user}"). To(iam.DeleteUser). - Doc("Remove a specified user."). + Doc("Delete a specified user."). Param(ws.PathParameter("user", "username")). Returns(http.StatusOK, ok, errors.Error{}). Metadata(restfulspec.KeyOpenAPITags, tags)) ws.Route(ws.PUT("/users/{user}"). To(iam.UpdateUser). - Doc("Updates information about the specified user."). + Doc("Update information about the specified user."). Param(ws.PathParameter("user", "username")). Reads(UserUpdateRequest{}). Returns(http.StatusOK, ok, errors.Error{}). Metadata(restfulspec.KeyOpenAPITags, tags)) ws.Route(ws.GET("/users/{user}/logs"). To(iam.UserLoginLogs). - Doc("This method is used to retrieve the \"login logs\" for the specified user."). + Doc("Retrieve the \"login logs\" for the specified user."). Param(ws.PathParameter("user", "username")). Returns(http.StatusOK, ok, LoginLog{}). Metadata(restfulspec.KeyOpenAPITags, tags)) @@ -184,20 +184,20 @@ func addWebService(c *restful.Container) error { Metadata(restfulspec.KeyOpenAPITags, tags)) ws.Route(ws.PUT("/groups/{group}"). To(iam.UpdateGroup). - Doc("Updates information about the user group."). + Doc("Update information about the user group."). Param(ws.PathParameter("group", "user group path separated by colon.")). Reads(models.Group{}). Returns(http.StatusOK, ok, models.Group{}). Metadata(restfulspec.KeyOpenAPITags, tags)) ws.Route(ws.GET("/users/{user}/roles"). To(iam.ListUserRoles). - Doc("This method is used to retrieve all the roles that are assigned to the user."). + Doc("Retrieve all the roles that are assigned to the user."). Param(ws.PathParameter("user", "username")). Returns(http.StatusOK, ok, iam.RoleList{}). Metadata(restfulspec.KeyOpenAPITags, tags)) ws.Route(ws.GET("/namespaces/{namespace}/roles"). To(iam.ListRoles). - Doc("This method is used to retrieve the roles that are assigned to the user in the specified namespace."). + Doc("Retrieve the roles that are assigned to the user in the specified namespace."). Param(ws.PathParameter("namespace", "kubernetes namespace")). Returns(http.StatusOK, ok, RoleList{}). Metadata(restfulspec.KeyOpenAPITags, tags)) @@ -208,14 +208,14 @@ func addWebService(c *restful.Container) error { Metadata(restfulspec.KeyOpenAPITags, tags)) ws.Route(ws.GET("/namespaces/{namespace}/roles/{role}/users"). To(iam.ListRoleUsers). - Doc("This method is used to retrieve the users that are bound to the role in the specified namespace."). + Doc("Retrieve the users that are bound to the role in the specified namespace."). Param(ws.PathParameter("namespace", "kubernetes namespace")). Param(ws.PathParameter("role", "role name")). Returns(http.StatusOK, ok, []models.User{}). Metadata(restfulspec.KeyOpenAPITags, tags)) ws.Route(ws.GET("/namespaces/{namespace}/users"). To(iam.ListNamespaceUsers). - Doc("List all users in the specified namespace"). + Doc("List all users in the specified namespace."). Param(ws.PathParameter("namespace", "kubernetes namespace")). Returns(http.StatusOK, ok, []models.User{}). Metadata(restfulspec.KeyOpenAPITags, tags)) @@ -233,15 +233,15 @@ func addWebService(c *restful.Container) error { Metadata(restfulspec.KeyOpenAPITags, tags)) ws.Route(ws.GET("/namespaces/{namespace}/roles/{role}/rules"). To(iam.ListRoleRules). - Doc("List all policy rules of the specified role."). + Doc("List all policy rules of the specified role in the given namespace."). Param(ws.PathParameter("namespace", "kubernetes namespace")). Param(ws.PathParameter("role", "role name")). Returns(http.StatusOK, ok, []models.SimpleRule{}). Metadata(restfulspec.KeyOpenAPITags, tags)) ws.Route(ws.GET("/devops/{devops}/roles/{role}/rules"). To(iam.ListDevopsRoleRules). - Doc("List all policy rules of the specified role."). - Param(ws.PathParameter("devops", "devops project id")). + Doc("List all policy rules of the specified role in the given devops project."). + Param(ws.PathParameter("devops", "devops project ID")). Param(ws.PathParameter("role", "devops role name")). Returns(http.StatusOK, ok, []models.SimpleRule{}). Metadata(restfulspec.KeyOpenAPITags, tags)) @@ -283,21 +283,21 @@ func addWebService(c *restful.Container) error { Metadata(restfulspec.KeyOpenAPITags, tags)) ws.Route(ws.POST("/workspaces/{workspace}/members"). To(iam.InviteUser). - Doc("Invite members to a workspace."). + Doc("Invite members to the workspace."). Param(ws.PathParameter("workspace", "workspace name")). Reads(InviteUserRequest{}). Returns(http.StatusOK, ok, errors.Error{}). Metadata(restfulspec.KeyOpenAPITags, tags)) ws.Route(ws.DELETE("/workspaces/{workspace}/members/{member}"). To(iam.RemoveUser). - Doc("Remove members from workspace."). + Doc("Remove members from the workspace."). Param(ws.PathParameter("workspace", "workspace name")). Param(ws.PathParameter("member", "username")). Returns(http.StatusOK, ok, errors.Error{}). Metadata(restfulspec.KeyOpenAPITags, tags)) ws.Route(ws.GET("/workspaces/{workspace}/members/{member}"). To(iam.DescribeWorkspaceUser). - Doc("Describe the specified user."). + Doc("Describe the specified user in the given workspace."). Param(ws.PathParameter("workspace", "workspace name")). Param(ws.PathParameter("member", "username")). Returns(http.StatusOK, ok, DescribeWorkspaceUserResponse{}). -- GitLab