OpenAPI definition
Overview
Tags
groups
Operations about groups
users
Operations about users
Paths
GET /users
Get the list of all users
Responses
Code Description Links
200 Successful operation No Links
Content
application/json
PUT /users
Update an existing user
Responses
Code Description Links
200 User updated No Links
Content
application/json
404 User not found No Links
Content
application/json
1
POST /users
Create a new user
Responses
Code Description Links
409 User already exists No Links
Content
application/json
200 User Added No Links
Content
application/json
PUT /groups/{groupName}/owner/{newOwner}
Update the owner of a group
Parameters
Type Name Description Schema
path groupName string
required
path newOwner string
required
Responses
Code Description Links
200 Successful operation No Links
Content
application/json
404 Group/User not found No Links
Content
application/json
PUT /groups/{groupName}/members/{newMember}
Add a member to a group
Parameters
2
Type Name Description Schema
path newMember string
required
path groupName string
required
Responses
Code Description Links
200 Successful operation No Links
Content
application/json
404 Group not found No Links
Content
application/json
GET /users/{userName}/friends
Get the list of all friends of a user
Parameters
Type Name Description Schema
path userName string
required
Responses
Code Description Links
200 Successful operation No Links
Content
application/json
404 User not found No Links
Content
application/json
POST /users/{userName}/friends
Add a friend to a user
Parameters
3
Type Name Description Schema
path userName string
required
Responses
Code Description Links
200 Friend Added No Links
Content
application/json
404 User not found No Links
Content
application/json
POST /groups
Create a new group
Responses
Code Description Links
200 Group Added No Links
Content
application/json
409 Group already exists No Links
Content
application/json
GET /users/{userName}
Get a user
Parameters
Type Name Description Schema
path userName string
required
Responses
4
Code Description Links
200 Successful operation No Links
Content
application/json
404 User not found No Links
Content
application/json
DELETE /users/{userName}
Delete a user
Parameters
Type Name Description Schema
path userName string
required
Responses
Code Description Links
200 User deleted No Links
Content
application/json
404 User not found No Links
Content
application/json
GET /users/{userName}/groups
Get the list of all groups of a user
Parameters
Type Name Description Schema
path userName string
required
Responses
5
Code Description Links
200 Successful operation No Links
Content
application/json
404 User not found No Links
Content
application/json
GET /groups/{groupName}
Get a group
Parameters
Type Name Description Schema
path groupName string
required
Responses
Code Description Links
200 Successful operation No Links
Content
application/json
404 Group not found No Links
Content
application/json
DELETE /groups/{groupName}
Delete a group
Parameters
Type Name Description Schema
path groupName string
required
Responses
6
Code Description Links
200 Successful operation No Links
Content
application/json
404 Group not found No Links
Content
application/json
GET /groups/{groupName}/members
Get the members of a group
Parameters
Type Name Description Schema
path groupName string
required
Responses
Code Description Links
200 Successful operation No Links
Content
application/json
404 Group not found No Links
Content
application/json
DELETE /users/{userName}/friends/{friendName}
Remove a friend from a user
Parameters
Type Name Description Schema
path friendName string
required
path userName string
required
Responses
7
Code Description Links
200 Friend Removed No Links
Content
application/json
404 User not found No Links
Content
application/json
DELETE /groups/{groupName}/members/{memberName}
Remove a member from a group
Parameters
Type Name Description Schema
path groupName string
required
path memberNa string
me
required
Responses
Code Description Links
200 Successful operation No Links
Content
application/json
404 Group/User not found No Links
Content
application/json
Components
Schemas
UserShortDTO
Data Transfer Object for User
Properties
8
Name Description Schema
userName string
optional
name optional string
email optional string
GroupDTO
Data Transfer Object for Group
Properties
Name Description Schema
name optional string
owner optional UserShortDTO
UserDTO
Data Transfer Object for User
Properties
Name Description Schema
userName string
optional
name optional string
email optional string
friends <
optional UserShortDTO
> array
groups < GroupDTO >
optional array
