api/openapi/docs/UserApi.md

\UserApi

All URIs are relative to http://localhost

Method	HTTP request	Description
create_user	POST /users	Create a new User
delete_user	DELETE /users/{id}	Deletes a User by ID
list_user	GET /users	List Users
list_user_card	GET /users/{id}/card	List attached Cards
list_user_ue	GET /users/{id}/ue	List attached Ues
read_user	GET /users/{id}	Find a User by ID
update_user	PATCH /users/{id}	Updates a User

create_user

models::UserCreate create_user(create_user_request) Create a new User

Creates a new User and persists it to storage.

Parameters

Name	Type	Description	Required	Notes
create_user_request	CreateUserRequest	User to create	[required]

Return type

models::UserCreate

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_user

delete_user(id) Deletes a User by ID

Deletes the User with the requested ID.

Parameters

Name	Type	Description	Required	Notes
id	i32	ID of the User	[required]

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_user

Vecmodels::UserList list_user(page, items_per_page) List Users

List Users.

Parameters

Name	Type	Description	Required	Notes
page	Option<i32>	what page to render
items_per_page	Option<i32>	item count to render per page

Return type

Vecmodels::UserList

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_user_card

Vecmodels::UserCardList list_user_card(id, page, items_per_page) List attached Cards

List attached Cards.

Parameters

Name	Type	Description	Required	Notes
id	i32	ID of the User	[required]
page	Option<i32>	what page to render
items_per_page	Option<i32>	item count to render per page

Return type

Vecmodels::UserCardList

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_user_ue

Vecmodels::UserUeList list_user_ue(id, page, items_per_page) List attached Ues

List attached Ues.

Parameters

Name	Type	Description	Required	Notes
id	i32	ID of the User	[required]
page	Option<i32>	what page to render
items_per_page	Option<i32>	item count to render per page

Return type

Vecmodels::UserUeList

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

read_user

models::UserRead read_user(id) Find a User by ID

Finds the User with the requested ID and returns it.

Parameters

Name	Type	Description	Required	Notes
id	i32	ID of the User	[required]

Return type

models::UserRead

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_user

models::UserUpdate update_user(id, update_user_request) Updates a User

Updates a User and persists changes to storage.

Parameters

Name	Type	Description	Required	Notes
id	i32	ID of the User	[required]
update_user_request	UpdateUserRequest	User properties to update	[required]

Return type

models::UserUpdate

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]