Skip to content

Routes

interfaces.tag.routes

Summary

Tag REST handlers — thin API entry points for the tag resource, wired to openapi.yaml operationIds by the OpenAPI-first router. All handlers delegate to TagCrudsService via request.app.state.db_resources.

Classes

Functions

create_tag async

create_tag(request: Request, body: dict)

Create a new tag.

Parameters:

Name Type Description Default
request Request

Incoming HTTP request; carries app.state.db_resources.

required
body dict

Tag payload forwarded to the service.

required

Returns:

Name Type Description
TagDocument

The created tag.

delete_tag async

delete_tag(request: Request, id: str)

Delete a tag by id.

Parameters:

Name Type Description Default
request Request

Incoming HTTP request; carries app.state.db_resources.

required
id str

Tag id.

required

Returns:

Name Type Description
Response

Empty 204 response on successful delete.

Raises:

Type Description
HTTPException

404 when no tag matches the id.

get_tag async

get_tag(request: Request, id: str)

Get a tag by id.

Parameters:

Name Type Description Default
request Request

Incoming HTTP request; carries app.state.db_resources.

required
id str

Tag id.

required

Returns:

Name Type Description
TagDocument

The matching tag.

Raises:

Type Description
HTTPException

404 when no tag matches the id.

list_tags async

1
2
3
list_tags(
    request: Request, skip: int = 0, limit: int = 1000
)

List tags with pagination.

Parameters:

Name Type Description Default
request Request

Incoming HTTP request; carries app.state.db_resources.

required
skip int

Number of tags to skip (offset). Defaults to 0.

0
limit int

Maximum number of tags to return. Defaults to 1000.

1000

Returns:

Type Description

list[TagDocument]: Matching tags from TagCrudsService.search.

update_tag async

update_tag(request: Request, id: str, body: dict)

Update a tag by id.

Parameters:

Name Type Description Default
request Request

Incoming HTTP request; carries app.state.db_resources.

required
id str

Tag id.

required
body dict

Fields to update, forwarded to the service.

required

Returns:

Name Type Description
TagDocument

The updated tag.

Raises:

Type Description
HTTPException

404 when no tag matches the id.