src.endpoints.v1 package

Submodules

src.endpoints.v1.user module

This module contains the user-info-related endpoints for the FastAPI application.

src.endpoints.v1.user.create_user(user: UserCreate) UserResponse

Create a new user in the database.

Parameters:

user (UserCreate) – The user information to create.

Returns:

The created user information.

Return type:

UserResponse

src.endpoints.v1.user.delete_user(user_id: int) UserResponse

Delete a user from the database by user ID.

Parameters:

user_id (int) – The ID of the user to delete.

Returns:

The deleted user information.

Return type:

UserResponse

src.endpoints.v1.user.get_user(user_id: int) UserResponse

Retrieve a user from the database by user ID.

Parameters:

user_id (int) – The ID of the user to retrieve.

Returns:

The retrieved user information.

Return type:

UserResponse

src.endpoints.v1.version module

This module defines the version endpoint for the FastAPI application.

async src.endpoints.v1.version.get_version() VersionResponse

Retrieve the current version of the application.

Module contents

This module contains the API v1 endpoints.