Add endpoint descriptions to add_routes #111

Closed
opened 2026-02-16 00:18:51 -05:00 by yindo · 2 comments
Owner

Originally created by @annabelleg on GitHub (Jan 30, 2024).

Originally assigned to: @eyurtsev on GitHub.

With normal FastAPI routes, the function docstrings automatically become the function's description in the Swagger docs, or you can pass in a summary/description/name/etc.

It would be useful to either enable this with add_routes automatically or pass in a description as a parameter.

The description could be appended to the auto-generated description for each invoke/batch/... endpoint (e.g., Given a query, search the internet for a response. Invoke the runnable with the given input and config.)

Originally created by @annabelleg on GitHub (Jan 30, 2024). Originally assigned to: @eyurtsev on GitHub. With normal FastAPI routes, the function docstrings automatically become the function's description in the Swagger docs, or you can pass in a summary/description/name/etc. It would be useful to either enable this with `add_routes` automatically or pass in a `description` as a parameter. The description could be appended to the auto-generated description for each `invoke`/`batch`/... endpoint (e.g., `Given a query, search the internet for a response. Invoke the runnable with the given input and config.`)
yindo added the stale label 2026-02-16 00:18:51 -05:00
yindo closed this issue 2026-02-16 00:18:51 -05:00
Author
Owner

@eyurtsev commented on GitHub (Feb 1, 2024):

I think that this is already the case if using pydantic 1? which version of pydantic are you on?

@eyurtsev commented on GitHub (Feb 1, 2024): I think that this is already the case if using pydantic 1? which version of pydantic are you on?
Author
Owner

@eyurtsev commented on GitHub (Feb 22, 2024):

Closing issue due to lack of follow up

@eyurtsev commented on GitHub (Feb 22, 2024): Closing issue due to lack of follow up
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: langchain-ai/langserve#111