Skip to content

docs: add use-case for group API #110

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: add use-case for group API #110

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion docs/configuration/configuration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@

The standard AsyncAPI document contains all information, including channels, messages, schemas, etc.

A group is a filtered view onto specific parts of the AsyncAPI document.
A group is a filtered view onto specific parts of the AsyncAPI document, for example only the _public_ or _consumed_ interfaces.

Check failure on line 91 in docs/configuration/configuration.mdx

View workflow job for this annotation

GitHub Actions / Build

Emphasis style 

docs/configuration/configuration.mdx:91:116 MD049/emphasis-style Emphasis style [Expected: asterisk; Actual: underscore] https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md049.md

Check failure on line 91 in docs/configuration/configuration.mdx

View workflow job for this annotation

GitHub Actions / Build

Emphasis style 

docs/configuration/configuration.mdx:91:107 MD049/emphasis-style Emphasis style [Expected: asterisk; Actual: underscore] https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md049.md

Check failure on line 91 in docs/configuration/configuration.mdx

View workflow job for this annotation

GitHub Actions / Build

Emphasis style 

docs/configuration/configuration.mdx:91:102 MD049/emphasis-style Emphasis style [Expected: asterisk; Actual: underscore] https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md049.md

Check failure on line 91 in docs/configuration/configuration.mdx

View workflow job for this annotation

GitHub Actions / Build

Emphasis style 

docs/configuration/configuration.mdx:91:95 MD049/emphasis-style Emphasis style [Expected: asterisk; Actual: underscore] https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md049.md

The group configuration must have a name (`group`). The `info` object can be adjusted and *at most* one matcher can be used:

Expand Down
Loading