jeffgrunewald / maverick Goto Github PK

Per the OpenAPI specification, generating specs automatically for generated routes would allow for API clients to be auto-generated in many compatible languages.

Users should be able to provide a set of global response headers from the Api module. The module should implement a behaviour that returns response headers that are merged with any headers coming from the return value of a function.

Phoenix does this and it's a nice feature to check your routes across files; Maverick should, too.

By default, the body_params argument for incoming requests is deserialized to a map or is placed into a map with the top-level key of _json_body. However, when the arg_type is request (the user is explicitly selecting to receive the entire %Maverick.Request{} struct as the argument to the internal function), it should be possible to override this behavior and allow the body_params to be any valid json.

In this scenario, the body_params is not coerced to a map and thus not merged into the params map. It will be up to the user to handle the type received in this instance.

The default behavior should still be to coerce the body a map and merge it into the params value.

Configurable deadlines on functions for a return value/response

Required params should also enforce they are non-nil and return an error to the client if not all values supplied when arg_type is set to required_params are sent on the incoming request.

Currently, user modules can declare a shared path "scope" on a per-module basis by passing the scope: "/some/path" argument to the use Maverick macro. This is fine and should still be supported but gets redundant with multiple modules that implement Maverick routes and should also support defining a "root scope" that all routes handled by a Maverick will serve.

Define this root scope functionality from the Api module with no default value. The best solution is likely another argument to the use Maverick.Api macro like root_scope: "/some/route/prefix"