flask-smorest

flask-smorest copied to clipboard

Improved abort method

1

Currently flask-smorest republishes the `abort`-method of Flask-Restful, which accepts additional keyword-args and an exception. However, in `ErrorHandlerMixin.handle_http_exception` only `message`, `errors` and `headers` are supported as keyword-args. Everything else is ignored,...

der-joel

Custom error schema

1

Hi, in one of my projects, we're using custom error schemas, so we have customized responses when e.g. validation fails. For marshmallow's ValidationError, we're doing it as described [here in...

Petr-Pan

Schema description from docstring

1

I wondered why the models in the overview at the end of the Swagger UI didn't contain a model description and went down the rabbit hole to find that it...

heeplr

Query parameter for sorting response

11

Is there a native way to add a "sort" parameter to each QuerySchema to determine the order of the result set? With native I mean: is that part of smorest...

kettenbach-it

Allow alt_response on MethodView

5

It would be a nice enhancement to allow the usage of the `alt_response`-Decorator on `MethodView`-classes. It could act as a shortcut to decorating every endpoint of the view with `alt_response`....

der-joel

Optional pagination for view-endpoints

2

At the moment, using `Blueprint.paginate()` on a view-endpoint will enforce pagination, even if no pagination parameters were passed by the client (`DEFAULT_PAGINATION_PARAMETERS`). Adding a parameter to make the pagination optional...

der-joel

renaming args in api spec

6

This is either a feature request or a failure on my part to find documentation I'm making use of converters reasonably heavily to create endpoints with my model already extracted...

mcclurem

type annotations would improve Example docs and reduce confusion

1

I suggest adding type-annotations to these examples to clarify what's happening [We have this example: ](https://flask-smorest.readthedocs.io/en/latest/quickstart.html)@blp.arguments(PetSchema) @blp.response(201, PetSchema) def post(self, new_data): """Add a new pet""" item = Pet.create(**new_data) return item...

dgaedcke

I am following this guide to make my API as simple and standard as possible: https://cloud.google.com/apis/design/custom_methods I see this method is quite common as also I could found it at...

BorjaEst

How to configure body content-type text/plain

2

I would like to configure a method that would use text as body imput (a message) for example: ```json { "...": "...", "paths": { "/results/report": { "post": { "responses": {...

BorjaEst