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.

Sign up for GitHub

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

Jump to bottom

Support for description and summary attributes on #[utoipa::path] macro. #781

Closed
mortifia opened this issue Oct 17, 2023 · 2 comments · Fixed by #948
Closed

Support for description and summary attributes on #[utoipa::path] macro. #781

mortifia opened this issue Oct 17, 2023 · 2 comments · Fixed by #948

Comments

@mortifia
Copy link

https://swagger.io/specification/?sbsearch=description#path-item-object

in #[utoipa::path()]

when i add description or summary
unexpected identifier, expected any of: operation_id, path, get, post, put, delete, options, head, patch, trace, connect, request_body, responses, params, tag, security, context_path
@juhaku
Copy link
Owner

juhaku commented Oct 26, 2023

That is by design. There is no description nor summary attributes on #[utoipa::path] macro. The description and summary is currently only resolved from the doc comment above the handler function. There has been a request for having support for these values as attributes on #[utoipa::path] path macro. This is something that can be added in future.

Relatead #439

@juhaku juhaku changed the title Bug: path description Support for description and summary attributes on #[utoipa::path] macro. Oct 26, 2023
@juhaku juhaku mentioned this issue Oct 26, 2023
Closed
@clechasseur clechasseur mentioned this issue Nov 15, 2023
Closed
juhaku added a commit that referenced this issue May 24, 2024
@juhaku
Add support for description and summary overriding
3d9b628 
Add `description = ...` and `summary = ...` attributes for
`#[utoipa::path(...)]` attribute macro to allow description and summary
overriding. When these attributes are defined the values are not
resolved from the doc comment above the function.

The value can be either literal string or expression e.g. reference to a
`const` variable or `include_str!(...)` statement.

Relates to #802

Resolves #439 Resolves #781
@juhaku juhaku mentioned this issue May 24, 2024
Merged
@juhaku juhaku moved this to In Progress in utoipa kanban May 24, 2024
@juhaku
Copy link
Owner

juhaku commented May 24, 2024

I have now implemented support for the description = ... and summary = ... attributes here #948

@juhaku juhaku closed this as completed in f7750fc May 24, 2024
@github-project-automation github-project-automation bot moved this from In Progress to Done in utoipa kanban May 24, 2024
@drbh drbh mentioned this issue Jul 2, 2024
Merged
@juhaku juhaku moved this from Done to Released in utoipa kanban Oct 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
utoipa kanban
Status: Released
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add support for description and summary overriding juhaku/utoipa
2 participants
@mortifia @juhaku