How to get Schema added to components/parameters?

[lukaskoeller]

I have the following setup:

from apispec import APISpec
from apispec.ext.marshmallow import MarshmallowPlugin
from apispec_webframeworks.flask import FlaskPlugin

Schema

class FilterParams(Schema):
    month = fields.Int()
    quarter = fields.Int()
    scope_cat = fields.Str()
    scope_val = fields.Str()
    year = fields.Int()

Input

"""
# …
parameters:
    - FilterParams
"""

Output

"parameters": [
    {
        "$ref": "#/components/parameters/FilterParams"
    },

But it is actually not added to components/parameters. How can I fix this?

[lafrech]

https://apispec.readthedocs.io/en/latest/using_plugins.html#example-flask-and-marshmallow-plugins ```py spec.components.schema("FilterParams", schema=FilterParams) ```

[lukaskoeller]

@lafrech Thanks for the quick answer. I tried that, it works, but the schema is then added to #/components/schemas not #/components/parameters

[lafrech]

You may also define parameters https://apispec.readthedocs.io/en/latest/api_core.html#apispec.core.Components.parameter although I'm not sure you can declare a set of parameters (not only in apispec, but also in OpenAPI standard).

…

-- Jérôme

[lukaskoeller]

Yeah you got a point here! I'm still quite new and didn't image that it would not be possible. Will close on that behalf. Thank you very much!

[lukaskoeller]

For anybody interested, there is an eternally open PR to implement parameter grouping in openapi.