Std.App.describing
1 declaration
fn
describing: &Std.App.App -> &Std.App.OpenApi.Document -> Str -> Result[Std.App.App, Std.App.AppError]The application publishing its API description at path.
Refused when the description is inconsistent, when it describes an operation the router does not serve, or when the router serves a route it does not describe. Routes added after this call are not checked, which is where operational endpoints such as health reports belong.
