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

Enrich Open API documentation using attributes #525

Open
Kaliumhexacyanoferrat opened this issue Oct 18, 2024 · 0 comments
Open

Enrich Open API documentation using attributes #525

Kaliumhexacyanoferrat opened this issue Oct 18, 2024 · 0 comments
Labels
enhancement New feature or request

Comments

@Kaliumhexacyanoferrat
Copy link
Owner

As a developer of a web application, I would like to attribute my methods so that the generated Open API specification is more useful to my API consumers.

Example

[ApiOperation("This thing does weird stuff")]
// ...

Acceptance criteria

  • The feature works for functional handlers as well
  • The feature is documented on the GenHTTP website
  • The feature is covered by acceptance tests
@Kaliumhexacyanoferrat Kaliumhexacyanoferrat added the enhancement New feature or request label Oct 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@Kaliumhexacyanoferrat