Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Is it possible to add enpoint description? #711

Closed
wkargul opened this issue Dec 21, 2023 · 1 comment
Closed

Is it possible to add enpoint description? #711

wkargul opened this issue Dec 21, 2023 · 1 comment
Labels
question Further information is requested

Comments

@wkargul
Copy link

wkargul commented Dec 21, 2023

Is it possible to add such a description to the endpoint?

image
@wkargul wkargul added the question Further information is requested label Dec 21, 2023
@wkargul
Copy link
Author

wkargul commented Dec 22, 2023

Resolved this!

I discovered that the distinction between summary and description in poem-openapi is based on the /n/n split. This is outlined in the source code, specifically at poem-openapi-derive/src/utils.rs#L63.

To illustrate with the given example, it would be structured like this:

/// Endpoint for deleting many resources by ids body. <- summary
/// <- necessary gap
/// <- necessary gap
/// Endpoint for deleting many resources by ids body. <- description for your method
#[oai(path = "/timeseries/delete", method = "post")]

@wkargul wkargul closed this as completed Dec 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question Further information is requested
Projects
None yet
Development

No branches or pull requests

1 participant