flip_api.project_services.edit_project

Attributes

router

Functions

edit_project_endpoint(request[, project_id, ...])

Edits a project with the provided ID. This endpoint allows users with the appropriate permissions to update the

Module Contents

flip_api.project_services.edit_project.router
flip_api.project_services.edit_project.edit_project_endpoint(request: fastapi.Request, project_id: uuid.UUID = Path(..., description='The ID of the project to edit.'), project_details: flip_api.domain.interfaces.project.IEditProject = Body(..., description='Details of the project to edit.'), user_id: uuid.UUID = Depends(verify_token), db: sqlmodel.Session = Depends(get_session))

Edits a project with the provided ID. This endpoint allows users with the appropriate permissions to update the project’s name and description.

Parameters:

  • request (Request) – FastAPI request object.

  • project_id (UUID) – The ID of the project to edit.

  • project_details (IEditProject) – Details of the project to edit.

  • user_id (UUID) – The ID of the user making the request.

  • db (Session) – The database session.

Returns:

The updated project details.

Return type:

Projects

Raises:

HTTPException – If the user is not allowed, if the project does not exist, or if there are validation errors.