Skip to content

Conversation

@tieneupin
Copy link
Contributor

As part of improving our ability to keep the Murfey frontend in lockstep with changes to the API endpoints in Murfey, we need a way to quickly generate and pass the latest OpenAPI schema for Murfey to the frontend.

This PR introduces a CLI to do just that, allowing you to generate OpenAPI schemas of either the instrument or backend servers and to save them in either JSON or YAML format. This can then be used by the frontend to generate and update its own copy of the OpenAPI schema.

…e with multiple files; added formatter for the argument parser
…ver or backend server and save it as either a JSON or YAML file
@codecov
Copy link

codecov bot commented Nov 12, 2025

Codecov Report

❌ Patch coverage is 73.86364% with 23 lines in your changes missing coverage. Please review.
✅ Project coverage is 38.51%. Comparing base (e292f91) to head (c8189c3).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #691      +/-   ##
==========================================
+ Coverage   38.24%   38.51%   +0.27%     
==========================================
  Files          97       99       +2     
  Lines       11594    11662      +68     
  Branches     1529     1542      +13     
==========================================
+ Hits         4434     4492      +58     
- Misses       6964     6972       +8     
- Partials      196      198       +2     
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@tieneupin tieneupin marked this pull request as ready for review November 12, 2025 14:32
@tieneupin tieneupin requested a review from d-j-hatton November 12, 2025 14:33
@tieneupin tieneupin self-assigned this Nov 12, 2025
@tieneupin tieneupin added server Relates to the server component enhancement New feature or request labels Nov 12, 2025
@tieneupin tieneupin merged commit 36511c9 into main Nov 18, 2025
17 checks passed
@tieneupin tieneupin deleted the generate-openapi-schema branch November 18, 2025 13:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request server Relates to the server component

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants