Forum Discussion

arty13's avatar
arty13
New Contributor
4 years ago

OpenApi 3 specify all Query Parameters using a single Schema ref with Marshmallow Plugin

Hi, I have a python project and I am using Marshmallow to define my schemas for input, output and query parameters. I am now trying to create my OpenAPI 3 docs using apispec library and I'm run...
Swagger Core
ponelat's avatar
ponelat
Staff

Hi arty13 

 

I'm not familiar with the Marshmellow enough to comment on that side, but for the OpenAPI side it sounds like you're after a groups of $refs which isn't support in OpenAPI yet (unfortunately, I think it's an important feature too). You can track the spec issue here https://github.com/OAI/OpenAPI-Specification/issues/445 (it's old, but you can ping to get it to the attention of the OpenAPI spec team which meets weekly).

 

Not many workarounds exist.

You could write a script to inject a bunch of $refs, something that would create the following:

parameters:
- $ref: '#/components/parameters/One'
- $ref: '#/components/parameters/Two'
- $ref: '#/components/parameters/N'
# etc...
components:
  parameters:
    One: 
      name: one
      in: query
      schema:
        type: string
# etc...

 

We're also looking to address this with a new side-spec called Overlays (https://github.com/OAI/Overlay-Specification/) which would be a standard way of defining mutations to a base definition.

 

At this rate there may be a way of doing this with Marshmellow (to inject all those parameters), perhaps reach out to the Marshmellow team and/or GitHub issues there? Feel free to link to this issue if it helps.