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.

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

feat(type-safe-api): support documentation generation for websocket apis #754

Merged
merged 1 commit into from
Apr 11, 2024

Conversation

cogwirrel
Copy link
Member

@cogwirrel cogwirrel commented Apr 9, 2024

Convert the OpenAPI spec to AsyncAPI, and use AsyncAPI's documentation generators for html and markdown documentation.

Note that there's a race condition when running two asyncapi generate commands at the same time - not sure exactly what the conflict is, have tried a few things like copying node_modules from ~/.pdk dir instead of symlinking, but the issue persists. As a workaround, we force the asyncapi documentation builds to run sequentially to ensure they do not conflict.

Fixes #742

Convert the OpenAPI spec to AsyncAPI, and use AsyncAPI's documentation generators for html and
markdown documentation

Fixes #742
@cogwirrel cogwirrel marked this pull request as ready for review April 10, 2024 07:12
@agdimech agdimech merged commit aad17d9 into mainline Apr 11, 2024
6 checks passed
@agdimech agdimech deleted the feat/ts-ws-html-docs branch April 11, 2024 01:45
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.

[FEATURE] (type-safe-api) WebSocket API Documentation Generation
2 participants