-
-
Notifications
You must be signed in to change notification settings - Fork 681
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
docs: add URL variables in AsyncAPI Document #1890
Conversation
✅ Deploy Preview for shimmering-choux-eb0798 ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Hi, could you assign this to me? @alequetzalli |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
great first draft, still work left to do and feedback to address ✌🏽
btw, the first thing we want to do moving forward is remember to review your work in the preview links... you should be doing this in each PR, this is why you missed several of these mistakes 😄✌🏽
Co-authored-by: Fran Méndez <[email protected]>
Co-authored-by: Fran Méndez <[email protected]>
Co-authored-by: Fran Méndez <[email protected]>
Co-authored-by: Alejandra Quetzalli <[email protected]>
Co-authored-by: Alejandra Quetzalli <[email protected]>
Co-authored-by: Alejandra Quetzalli <[email protected]>
Co-authored-by: Alejandra Quetzalli <[email protected]>
Co-authored-by: Fran Méndez <[email protected]>
Co-authored-by: Alejandra Quetzalli <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Links are technically accurate but suggested a better relative path that works just as good and suggested by Lukasz on my PRs.
The diagram below describes how to use variable urls in AsyncAPI. | ||
|
||
```mermaid | ||
graph TD | ||
|
||
A[AsyncAPI Server] | ||
B[Components] | ||
C[Server URL] | ||
|
||
style A fill:#47BCEE,stroke:#47BCEE; | ||
style B fill:#47BCEE,stroke:#47BCEE; | ||
style C fill:#47BCEE,stroke:#47BCEE; | ||
|
||
B -->|Defines serverVariables| C | ||
C -->|Reusable variables| A | ||
``` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I honestly don't think a diagram is helping here. I'd completely remove it.
Co-authored-by: Fran Méndez <[email protected]>
Co-authored-by: Fran Méndez <[email protected]>
Co-authored-by: Fran Méndez <[email protected]>
Co-authored-by: Fran Méndez <[email protected]>
Co-authored-by: Fran Méndez <[email protected]>
Co-authored-by: Fran Méndez <[email protected]>
Co-authored-by: Fran Méndez <[email protected]>
Description : Add Variables in URL
Refer: #1509