Skip to content

Commit

Permalink
fix: remove params from descriptions
Browse files Browse the repository at this point in the history
  • Loading branch information
Valimp committed Feb 28, 2024
1 parent 4532208 commit bcddffd
Showing 1 changed file with 6 additions and 7 deletions.
13 changes: 6 additions & 7 deletions app/api.py
Original file line number Diff line number Diff line change
Expand Up @@ -216,8 +216,11 @@ def create_flag(flag: FlagCreate, request: Request):
"""Create a flag for a product.
This function is used to create a flag for a product or an image.
At the same time,
it creates a ticket if it does not exist for this product or image.
A flag is a request for a product or an image to be reviewed.
A flag is associated with a ticket.
A ticket is created if it does not exist for this product or image.
A ticket can be associated with multiple flags.
:return: the created flag with the assigned ticket
"""
Expand Down Expand Up @@ -286,7 +289,6 @@ def get_flag(flag_id: int):
This function is used to get a flag by its ID.
:param flag_id: the ID of the flag
:return: the flag
"""
with db:
Expand All @@ -305,6 +307,7 @@ def create_ticket(ticket: TicketCreate) -> Ticket:
"""Create a ticket.
This function is used to create a ticket for a product or an image.
A ticket is a request for a product or an image to be reviewed.
:return: the created ticket
"""
Expand All @@ -330,7 +333,6 @@ def get_ticket(ticket_id: int):
This function is used to get a ticket by its ID.
:param ticket_id: the ID of the ticket
:return: the ticket
"""
with db:
Expand All @@ -346,7 +348,6 @@ def get_flags_by_ticket(ticket_id: int):
This function is used to get all flags for a ticket by its ID.
:param ticket_id: the ID of the ticket
:return: a list of flags
"""
with db:
Expand All @@ -366,8 +367,6 @@ def update_ticket_status(ticket_id: int, status: TicketStatus):
This function is used to update the status of a ticket by its ID.
:param ticket_id: the ID of the ticket
:param status: the new status of the ticket
:return: the updated ticket
"""
with db:
Expand Down

0 comments on commit bcddffd

Please sign in to comment.