Nested marshmellow schemas about flask_accepts

[apryor6]

There’s no reason for it not to work, so it must be a bug. I’ll look into it, thanks!

…

Sent from my iPhone

On Sep 1, 2019, at 6:44 PM, edkb ***@***.***> wrote: This lib is really nice and works great with simple marshmallow schemas. Unfortunately Swagger doesn't display correctly when using nested schemas like [this] https://marshmallow.readthedocs.io/en/stable/nesting.html) — You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub, or mute the thread.

[apryor6]

I should add that nested Schemas work as far as serialization goes. It’s only the documentation that is lacking, as it just defaults to empty curly braces for the nested object.

[edkb]

Thanks AJ, it works perfectly!

[apryor6]

The default values are not currently being passed through, so that is a relatively simple change for me to make within flask_accepts.

However, it appears that default parameters in the body are not being used in flask-RESTplus. I've got an open discussion upstream with them.

Both of these will need to be resolved, and then this should work.

[edkb]

Nice, I've opened this issue here because I had problems to make this work with RESTplus too and the auto-docs is one of the main reasons to use this framework. Hope its a simple fix

[apryor6]

For api.model, it turns out the proper keyword for modifying the default value is example and NOT default. I'll just need to create a mapping from marshmallow default to this example param (with a default value if one was not provided), and this should be good to go

[apryor6]

Thanks to @j5awry for the help with that

[apryor6]

Thanks for bringing this up, should now be fixed. Let me know if there are still issues.

[edkb]

Thanks, it worked! But there there's still is one more small thing. It uses a default name for the nested models and the correct name just for the root, so I think it should display the correct name for the nested models too.

Example: When I use the model Cog nested in the Widget(POST), swagger shows "DefaultResponseModel_2". But when I use just the Cog not as a nested model (GET) it shows it's correct name.

class CogSchema(Schema):
    cog_foo = fields.String(default="cog")
    cog_baz = fields.Integer(default=999)


class WidgetSchema(Schema):
    foo = fields.String(default="test string")
    baz = fields.Integer(default=42)
    flag = fields.Bool(default=False)
    date = fields.Date(default="01-01-1900")
    dec = fields.Decimal(default=42.42)
    dct = fields.Dict(default={"key": "value"})

    cog = fields.Nested(CogSchema)


@api.route("/restplus/make_a_widget")
class WidgetResource(Resource):
    
    @accepts(dict(name="some_arg", type=str), schema=CogSchema, api=api)
    @responds(schema=CogSchema, api=api)
    def get(self):
        from flask import jsonify

        return request.parsed_obj
    
    @accepts(dict(name="some_arg", type=str), schema=WidgetSchema, api=api)
    @responds(schema=WidgetSchema, api=api)
    def post(self):
        from flask import jsonify

        return request.parsed_obj

[apryor6]

Thanks for such careful testing -- this will be a simple change

[apryor6]

This should be fixed in 0.11.2. Give it a try.