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

Improve swagger doc generation #434

Merged
merged 4 commits into from
Sep 28, 2024
Merged

Improve swagger doc generation #434

merged 4 commits into from
Sep 28, 2024

Conversation

myssto
Copy link
Contributor

@myssto myssto commented Sep 28, 2024

Improves the swagger doc generation in preparation for automatic client code generation

  • Prevents the RequestLoggingMiddleware from logging requests to /swagger when running in debug environments
  • Startup flag to generate and write the swagger spec to disc
  • Adds Database assembly xml comments
  • Add custom JSON extensions to enums in the swagger spec for better documentation

@myssto myssto added type:documentation project:API Items related to the API project labels Sep 28, 2024
@myssto myssto mentioned this pull request Sep 28, 2024
Open
@hburn7 hburn7 merged commit 8acc17e into master Sep 28, 2024
2 checks passed
@hburn7 hburn7 deleted the client-codegen branch September 28, 2024 15:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@hburn7 hburn7 hburn7 approved these changes

@alixdotsh alixdotsh Awaiting requested review from alixdotsh

Assignees
No one assigned
Labels
project:API Items related to the API project size/L type:documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@myssto @hburn7