fnhouse.schemas
Defines schemas for Handlers and HandlerInfo, fnhouse's API description format. See docstrings below for details.
Defines schemas for Handlers and HandlerInfo, fnhouse's API description format. See docstrings below for details.
AnnotatedHandlerclj
A bundle of a resource-injected fnhouse handler with its HandlerInfo
A bundle of a resource-injected fnhouse handler with its HandlerInfo
HandlerInfoclj
A schema for information about a specific HTTP handler.
path is the path to the handler, which can contain wildcards corresponding to uri-args; see fnhouse.routes for details.
request describes schemas for the request, broken down into uri-args, query-params, and body (when applicable).
responses is a mapping from status code to the response body schema for that status.
resources is a schema for the resources that the handler requires in addition to the request (i.e., database handles).
annotations is an arbitrary field that can be used to hold other user-defined fields; for example, authentication requirements or rate-limiting parameters. It can be populated by passing an extra-info-fn to the functions in fnhouse.handlers.
A schema for information about a specific HTTP handler. path is the path to the handler, which can contain wildcards corresponding to uri-args; see fnhouse.routes for details. request describes schemas for the request, broken down into uri-args, query-params, and body (when applicable). responses is a mapping from status code to the response body schema for that status. resources is a schema for the resources that the handler requires in addition to the request (i.e., database handles). annotations is an arbitrary field that can be used to hold other user-defined fields; for example, authentication requirements or rate-limiting parameters. It can be populated by passing an extra-info-fn to the functions in fnhouse.handlers.
Requestclj
A Ring-style request, one input to a fnhouse handler
A Ring-style request, one input to a fnhouse handler
Responseclj
A Ring-style response, the output of a fnhouse handler
A Ring-style response, the output of a fnhouse handler
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close