Is there a way of updating the generated Swagger spec?

First Check

• I added a very descriptive title to this issue.
• I used the GitHub search to find a similar issue and didn’t find it.
• I searched the FastAPI documentation, with the integrated search.
• I already searched in Google “How to X in FastAPI” and didn’t find any information.
• I already read and followed all the tutorial in the docs and didn’t find an answer.
• I already checked if it is not related to FastAPI but to Pydantic.
• I already checked if it is not related to FastAPI but to Swagger UI.
• I already checked if it is not related to FastAPI but to ReDoc.

Commit to Help

• I commit to help with one of those options 👆

Example Code

app = FastAPI()
app.openapi_version = "3.1.0"

Description

Hi, we have an internal tooling of linting the generated swagger (aka, OpenAPI) doc, which requires the API spec to follow 3.1.0. However, the current generated version is 3.0.2.

I used the above code to update it to 3.1.0, and it works. 😄

However, it looks like I am hard coding the version number, rather than generating with the real v3.1.0 spec, so I wonder is there a way to update the internal swagger spec version?

Thanks 😄

Operating System

Windows

Operating System Details

No response

FastAPI Version

0.65.2

Python Version

3.8.8

Additional Context

No response

[tiangolo]

Thanks! I’m very glad you have liked it like that! 😁😊 And thanks for coming back to close the issue.

Also thanks @iudeen for the help! 🍰

[tiangolo]

Hey there! Yep, differences are but too big in the specs. And in fact, FastAPI does a couple of things a tiny bit more compatible with 3.1.0.

The only reason why I haven’t updated it is because Swagger UI breaks. But once they support it I’ll be able to update the generated version.

For now, you should be mostly fine by simply overriding it. I know it feels weird, but it shouldn’t be too problematic if at all.