跳到主要内容
API docs by Redocly

v1/group.proto (version not set)

Download OpenAPI specification:Download

GroupService

获取小组列表

query Parameters
name
string
mygroup
boolean
sort
string
parentId
integer <int32>
type
string
Default: "GROUP"
Enum: "GROUP" "TEAM"
page
integer <int32>
perPage
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total": "string"
}

GroupService_CreateGroup

Request Body schema: application/json
parentId
integer <int32>
name
string
description
string
type
string (groupGroupType)
Default: "GROUP"
Enum: "GROUP" "TEAM"

Responses

Request samples

Content type
application/json
{
  • "parentId": 0,
  • "name": "string",
  • "description": "string",
  • "type": "GROUP"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "memberCount": 0,
  • "privacy": 0,
  • "membership": 0,
  • "invitationCode": "string",
  • "userId": 0,
  • "userNickname": "string",
  • "userAvatar": "string",
  • "role": "ADMIN",
  • "type": "GROUP",
  • "team": { },
  • "createdAt": "2019-08-24T14:15:22Z"
}

新增小组用户

path Parameters
gid
required
integer <int32>
Request Body schema: application/json
username
string
nickname
string
invitationCode
string

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "nickname": "string",
  • "invitationCode": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "nickname": "string",
  • "userAvatar": "string",
  • "userId": 0,
  • "groupId": 0,
  • "role": "ADMIN",
  • "createdAt": "2019-08-24T14:15:22Z"
}

GroupService_GetGroupUser

path Parameters
gid
required
integer <int32>
uid
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "nickname": "string",
  • "userAvatar": "string",
  • "userId": 0,
  • "groupId": 0,
  • "role": "ADMIN",
  • "createdAt": "2019-08-24T14:15:22Z"
}

移除小组用户

path Parameters
gid
required
integer <int32>
uid
required
integer <int32>

Responses

Response samples

Content type
application/json
{ }

修改小组用户

path Parameters
gid
required
integer <int32>
uid
required
integer <int32>
Request Body schema: application/json
nickname
string
role
string (groupGroupUserRole)
Default: "ADMIN"
Enum: "ADMIN" "MANAGER" "MEMBER" "GUEST"

Responses

Request samples

Content type
application/json
{
  • "nickname": "string",
  • "role": "ADMIN"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "nickname": "string",
  • "userAvatar": "string",
  • "userId": 0,
  • "groupId": 0,
  • "role": "ADMIN",
  • "createdAt": "2019-08-24T14:15:22Z"
}

GroupService_GetGroup

path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "memberCount": 0,
  • "privacy": 0,
  • "membership": 0,
  • "invitationCode": "string",
  • "userId": 0,
  • "userNickname": "string",
  • "userAvatar": "string",
  • "role": "ADMIN",
  • "type": "GROUP",
  • "team": { },
  • "createdAt": "2019-08-24T14:15:22Z"
}

GroupService_DeleteGroup

path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/json
{ }

GroupService_UpdateGroup

path Parameters
id
required
integer <int32>
Request Body schema: application/json
name
string
privacy
integer <int32>
membership
integer <int32>
invitationCode
string
description
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "privacy": 0,
  • "membership": 0,
  • "invitationCode": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "memberCount": 0,
  • "privacy": 0,
  • "membership": 0,
  • "invitationCode": "string",
  • "userId": 0,
  • "userNickname": "string",
  • "userAvatar": "string",
  • "role": "ADMIN",
  • "type": "GROUP",
  • "team": { },
  • "createdAt": "2019-08-24T14:15:22Z"
}

获取小组用户列表

path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total": "string"
}