feat: Adds async deepdown template #80
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR Summary
Adds a new async API template to be used with Deepdown and fixes some output issues have thorough testing.
Brief Summary: Fixed AsyncAPI Documentation Generation Issues
Problems Identified:
# Channel
instead of# speak Channel
,# agent Channel
, etc.[object Object]
instead of actual server names'
instead of'
and<
instead of<
Root Causes:
{{@key}}
variable replacement wasn't working inoutputPattern
, causing file collisions@
prefix work for file paths but not template contentTechnical Fixes Applied:
AsyncAPI Template (
asyncapi.deepdown
):{{@pathName}}/index.md
for reliable directory creation{{@key}}
→{{pathName}}
in template content{{this}}
→{{this.host}} ({{this.protocol}})
{{description}}
→{{{description}}}
for all text fieldsOpenAPI Template (
openapi.deepdown
):Result:
✅ Complete documentation: All 3 channels (speak, listen, agent) now generate separate files
✅ Proper naming: Channel names display correctly in titles and metadata
✅ Server details: Shows actual server hostnames instead of object references
✅ Clean text: All apostrophes, quotes, and brackets render properly without HTML entities
The "uploads" (documentation generation) now work correctly for the entire AsyncAPI specification.
Testing
To fully validate the output just run:
ASYNC API
Open API
Or review the test output generated here: deepgram/deepdown#2
NOTE: Only includes async output data.