faust.web.apps.router
HTTP endpoint showing partition routing destinations.
-
class faust.web.apps.router.TableList(app: AppT, web: Web)[source]
—
description: List routes for all tables.
tags:
- Faust
produces:
- application/json
-
async get(request: Request) → Response[source]
Return JSON response with list of all table routes.
- Return type:
Response
-
view_name: str
-
view_path: str
-
methods: Mapping[str, Callable[[Request], Awaitable]]
-
class faust.web.apps.router.TopicList(app: AppT, web: Web)[source]
List routes for all external topics.
-
async get(request: Request) → Response[source]
Return JSON response with list of all table routes.
- Return type:
Response
-
view_name: str
-
view_path: str
-
methods: Mapping[str, Callable[[Request], Awaitable]]
-
class faust.web.apps.router.TableDetail(app: AppT, web: Web)[source]
—
description: List route for a specific table.
tags:
- Faust
parameters:
- in: path
name: name
type: string
required: true
produces:
- application/json
-
async get(request: Request, name: str) → Response[source]
Return JSON response with table metadata.
- Return type:
Response
-
view_name: str
-
view_path: str
-
methods: Mapping[str, Callable[[Request], Awaitable]]
-
class faust.web.apps.router.TableKeyDetail(app: AppT, web: Web)[source]
—
description: List information about key.
tags:
- Faust
parameters:
- in: path
name: name
type: string
required: true
produces:
- application/json
-
async get(request: Request, name: str, key: str) → Response[source]
Return JSON response after looking up the route of a table key.
- Parameters:
-
- Raises:
faust.web.exceptions.ServiceUnavailable – if broker metadata
has not yet been received.
- Return type:
Response
-
view_name: str
-
view_path: str
-
methods: Mapping[str, Callable[[Request], Awaitable]]