Add doc parameter to APIRouter

[PREPONDERANCE]

First Check

• I added a very descriptive title here.
• I used the GitHub search to find a similar question 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

router = APIRouter(prefix="stargazer", tags=["overview"], __doc__="")

Description

• I would prefer APIRouter adding a parameter description as in FastAPI class

Operating System

macOS

Operating System Details

No response

FastAPI Version

0.109.2

Pydantic Version

2.6.1

Python Version

Python 3.11.3

Additional Context

No response

[aanchlia]

I think APIRouter doesn't have description parameter, but you can do something like this?

router.description = 'description'

[PREPONDERANCE]

I think APIRouter doesn't have description parameter, but you can do something like this?

router.description = 'description'

Indeed APIRouter does not support such parameter which is also why I opened up this discussion.

Back to the code snippet, I actually want the doc string displayed in openAPI docs when I click on those API endpoints inheriting this APIRouter.

So that's not really what I'm anticipating.

[killjoy1221]

It's a bit complex since routers can have multiple tags, and multiple routers and routes can have the same tags.

Tag descriptions are officially documented here.

[PREPONDERANCE]

Thanks for the explanation! I'll go ahead and find a way that works best for me.