Skip to content

feat: Adds auto openapi doc generation + swagger UI for API #779

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

Merged
merged 6 commits into from
Apr 29, 2025

Conversation

teeohhem
Copy link

@teeohhem teeohhem commented Apr 25, 2025

  • Adds support for auto-openapi doc generation
  • Adds a swagger route for local development
  • Adds a script to manually generate the openapi doc (to be used later if we publish to our site, etc...)

Ref: HDX-1661

Copy link

changeset-bot bot commented Apr 25, 2025

🦋 Changeset detected

Latest commit: 9ee2154

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 2 packages
Name Type
@hyperdx/api Patch
@hyperdx/app Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

Copy link

vercel bot commented Apr 25, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
hyperdx-v2-oss-app ✅ Ready (Inspect) Visit Preview 💬 Add feedback Apr 29, 2025 5:54pm

@teeohhem teeohhem changed the base branch from v2 to tom/v2-api-alerts April 25, 2025 16:03
@dhable dhable self-requested a review April 29, 2025 16:44
dhable
dhable previously approved these changes Apr 29, 2025
Copy link

@dhable dhable left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Pulled the changes down, managed to build the openapi docs with the included script. Local API server is hosting the swagger UI.

@teeohhem teeohhem changed the base branch from tom/v2-api-alerts to v2 April 29, 2025 17:19
@teeohhem teeohhem dismissed dhable’s stale review April 29, 2025 17:19

The base branch was changed.

@kodiakhq kodiakhq bot merged commit 293a2af into v2 Apr 29, 2025
5 of 6 checks passed
@kodiakhq kodiakhq bot deleted the tom/auto-api-doc-gen branch April 29, 2025 17:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants