You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Describe the bug
Using the versioning breaks some of the tags_metadata functionality .
To Reproduce
Steps to reproduce the behavior:
create a small app:
tags_metadata = [
{
"name": "users",
"description": "Operations with users. The **login** logic is also here.",
},
]
app = FastAPI(openapi_tags=tags_metadata)
@app.get("/users/", tags=["users"])
@version(1)
async def get_users():
return [{"name": "Harry"}, {"name": "Ron"}]
app = VersionedFastAPI(
app,
version_format="{major}",
prefix_format="/api/v{major}",
)
2.run it and check the generated documentation at:
/api/v1/docs
Expected behavior
Notice that above the get_users method you will see the expected tag
"Users"
but the description will not be displayed.
The expected behavior obtained if versioning is not used is that both the Tag and the Description will be displayed:
"Users Operations with users. The login logic is also here."
The text was updated successfully, but these errors were encountered:
Describe the bug
Using the versioning breaks some of the tags_metadata functionality .
To Reproduce
Steps to reproduce the behavior:
2.run it and check the generated documentation at:
/api/v1/docs
Expected behavior
Notice that above the get_users method you will see the expected tag
"Users"
but the description will not be displayed.
The expected behavior obtained if versioning is not used is that both the Tag and the Description will be displayed:
"Users Operations with users. The login logic is also here."
The text was updated successfully, but these errors were encountered: