Skip to content

docs: add api generation for components #1767

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.

Sign up for GitHub

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
asyncapi-bot merged 52 commits into from
Feb 4, 2026
Merged

docs: add api generation for components #1767

Show file tree
Hide file tree
Changes from 38 commits
Commits
Show all changes
52 commits
Select commit Hold shift + click to select a range
3ff3f65
docs: add api generation for components
batchu5 Nov 23, 2025
810948d
Replaced ModelinaGenerator class with typedef
batchu5 Nov 23, 2025
431b8d1
Add Sequential execution in generate:assets command
batchu5 Nov 23, 2025
c521c81
Add glob Pattern to ./src/**/* in docs to ensure consistent behaviour…
batchu5 Nov 23, 2025
20dc33b
Fix grammar in source JSDoc descriptions
batchu5 Nov 23, 2025
3fcc3d4
Add API.md in files section of package.json
batchu5 Nov 23, 2025
a5b9b38
changed from src -> lib
batchu5 Nov 23, 2025
34f53ff
fix: replace '?' with | undefined for optional params
batchu5 Nov 28, 2025
228a776
Merge branch 'master' into api-generation-for-components
batchu5 Jan 12, 2026
35d4024
add jsdoc-to-markdown as a dev dependency
batchu5 Jan 12, 2026
20320a0
revert OnClose.test.js.snap
batchu5 Jan 17, 2026
1c62b60
revert packages/components/package.json
batchu5 Jan 17, 2026
fd81f90
move api.md to docs and api.hbs to jsdoc2-md-handlebars
batchu5 Jan 17, 2026
47f9121
remove functions inside the component from api.md
batchu5 Jan 17, 2026
f4b6f83
add EOF to packages/components/jsdoc2md-handlebars/api.hbs
batchu5 Jan 17, 2026
69fd777
add return type for QueryParamsVaribles component
batchu5 Jan 17, 2026
fd7bff6
add spacing in api.hbs
batchu5 Jan 17, 2026
85344e4
add jsdoc-helper to handle pipe character
batchu5 Jan 17, 2026
d1d83db
add jsdoc for escapeType(jsdoc-helper)
batchu5 Jan 17, 2026
ae8a7b6
disable markdownlint MDO24 in API.md
batchu5 Jan 17, 2026
547e6e2
Merge remote-tracking branch 'upstream/master' into api-generation-fo…
batchu5 Jan 18, 2026
6cba609
add examples for each component
batchu5 Jan 20, 2026
5c196f0
fix syntax in examples(jsdoc) - components
batchu5 Jan 20, 2026
52d3a00
add index section to the docs of components
batchu5 Jan 21, 2026
cab123a
Merge branch 'master' into api-generation-for-components
asyncapi-bot Jan 22, 2026
62a49f9
minor jsdoc updates
batchu5 Jan 22, 2026
f47f65f
refine jsdoc comments
batchu5 Jan 22, 2026
a9ae2de
remove unwanted variables
batchu5 Jan 22, 2026
a9be50e
make jsdoc consistent across all components
batchu5 Jan 22, 2026
80b3cfd
format type parameters as code blocks
batchu5 Jan 23, 2026
bd31cc1
wrap Asyncapi parse in async function
batchu5 Jan 23, 2026
39597ed
add semicolons to example block
batchu5 Jan 23, 2026
6c6cc6e
Merge branch 'master' into api-generation-for-components
asyncapi-bot Jan 24, 2026
23f1e29
add @returns descriptions to generator components
batchu5 Jan 24, 2026
97c4e57
add jsdocs for readme components
batchu5 Jan 24, 2026
2c7b85b
update imports to use named exports for MessageExamples and Operation…
batchu5 Jan 24, 2026
b32a1be
update imports to use named exports for MessageExamples and Operation…
batchu5 Jan 24, 2026
f820067
add typedef language to readme components
batchu5 Jan 25, 2026
759b0ad
invoke async render functions with .catch() handling
batchu5 Jan 25, 2026
01356d1
handle missing framework in QueryParamsVariables query param generation
batchu5 Jan 25, 2026
281f14c
standardize return types and component descriptions
batchu5 Jan 25, 2026
43b7af4
add missing imports to examples
batchu5 Jan 26, 2026
ec5ec92
add missing exports in index.js
batchu5 Jan 26, 2026
0334ec3
replace double quotes with single quotes in index.js
batchu5 Jan 26, 2026
efc670d
fix JSDoc to use props instead of params
batchu5 Jan 26, 2026
c4583e3
fix synchronous JSDoc examples to avoid top-level return
batchu5 Jan 26, 2026
0e952c4
Merge branch 'master' into api-generation-for-components
Adi-204 Jan 27, 2026
86578bf
fix lint errors
batchu5 Jan 28, 2026
cc3ff8d
add jsdocs for @private functions
batchu5 Jan 28, 2026
ea47af5
clarify framework requirement for framework-specific languages in onC…
batchu5 Jan 28, 2026
5f03eb3
Merge branch 'master' into api-generation-for-components
Adi-204 Jan 29, 2026
6d16479
Merge branch 'master' into api-generation-for-components
derberg Feb 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading