Skip to content

Swagger#695

Merged
Rigidity merged 4 commits intoxch-dev:mainfrom
dkackman:swagger
Oct 9, 2025
Merged

Swagger#695
Rigidity merged 4 commits intoxch-dev:mainfrom
dkackman:swagger

Conversation

@dkackman
Copy link
Collaborator

@dkackman dkackman commented Oct 9, 2025

This PR adds OpenAPI/Swagger doc generation.

Of note:

  • the sage rpc does not host or serve the openapi doc or swagger plugin (it would require a way to bypass the mutual tls auth which isn't worth it)
  • the doc json can be generated with cargo run --bin sage rpc generate_openapi -o dist/openapi.json
  • as part of the release process this can then be uploaded to docusaurus
  • install this vscode extension to be able to view the generated json in the swagger-ui from within VSCode/Cursor (open dist/openapi.json and the extention will have an option to view in the plugin
image

@dkackman dkackman mentioned this pull request Oct 9, 2025
@Rigidity Rigidity merged commit 569ea57 into xch-dev:main Oct 9, 2025
5 of 8 checks passed
@dkackman dkackman deleted the swagger branch October 10, 2025 00:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants