Documenting path parameters in blueprint url_prefix

How do I document path parameters that appear in url_prefix in a Blueprint? Example:

blueprint = Blueprint(
    'Media',
    __name__,
    url_prefix='/brands/<int:brand_id>/media',
)

@blueprint.route(...)
...

I’ve read through https://github.com/marshmallow-code/flask-smorest/issues/23 but it only seems to apply to @blueprint.route(), not Blueprint().

[lafrech]

I just sent a PR for this. Sorry about the delay. It was less complicated than I expected.

url_prefix can be specified both at Blueprint init and when calling register_blueprint.

I was not totally comfortable with overriding Blueprint.__init__ and I figured it was enough to just add parameters to register_blueprint. The downside I see is that it requires the user to pass that parameter on each call to register_blueprint, which could lead to code duplication in the unlikely case of a Blueprint being registered several times with the same url_prefix (I don’t think this could happen until perhaps we support nested blueprints). It probably also adds a bit of complexity for apps where all blueprints are registered in a loop, as they must manage this special case. I assume codes with such advanced patterns can easily handle the added complexity.

I’m happy with this resolution and I shall merge #313 pretty soon.

[kaos]

how about

class MyBlueprint (Blueprint):
    def __init__(self, *args, prefix_parameters=None, **kwargs):
        super().__init__(*args, **kwargs)
        self._prefix_parameters = prefix_parameters

    def route(self, *args, parameters=None, **kwargs):
        if self._prefix_parameters is not None:
            parameters = self._prefix_parameters + (parameters or [])

        return super().route(*args, parameters=parameters, **kwargs)


# Usage:

blueprint = MyBlueprint(
    'Media',
    __name__,
    url_prefix='/brands/<int:brand_id>/media',
    prefix_parameters=[
        {...}
    ]
)

@blueprint.route(...)
...