app.endpoints.v1.example

Endpoint definition for example.

example

example(request: starlette.requests.Request, params: app.endpoints.v1.models.GetExample = Schema(default: Ellipsis, extra: {'example': {'msg': 'some message.'}})) -> app.endpoints.v1.models.Example

Example docstring.

Parameters:

request (Request): the original request.
params (Example): the request-parameters converted to an instance of
    `Example`.

Returns:

(Output) the result for the request.