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

docs: add URL variables in AsyncAPI Document #1890

Closed

Conversation

kakabisht
Copy link
Contributor

Description : Add Variables in URL

  • Define server section
  • Define components server.Variables section
  • Define domain and port variables

Refer: #1509

@netlify
Copy link

netlify bot commented Jul 3, 2023

Deploy Preview for shimmering-choux-eb0798 ready!

Name Link
🔨 Latest commit 8f23fe2
🔍 Latest deploy log https://app.netlify.com/sites/shimmering-choux-eb0798/deploys/656aead0d2a3d700083bdbc0
😎 Deploy Preview https://deploy-preview-1890--shimmering-choux-eb0798.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

TRohit20

This comment was marked as outdated.

@kakabisht kakabisht marked this pull request as ready for review July 31, 2023 18:08
@kakabisht
Copy link
Contributor Author

Hi, could you assign this to me? @alequetzalli

@kakabisht kakabisht mentioned this pull request Aug 30, 2023
pages/docs/concepts/asyncapi-document/variable-url.md Outdated Show resolved Hide resolved
pages/docs/concepts/asyncapi-document/variable-url.md Outdated Show resolved Hide resolved
pages/docs/concepts/asyncapi-document/variable-url.md Outdated Show resolved Hide resolved
pages/docs/concepts/asyncapi-document/variable-url.md Outdated Show resolved Hide resolved
pages/docs/concepts/asyncapi-document/variable-url.md Outdated Show resolved Hide resolved
pages/docs/concepts/asyncapi-document/variable-url.md Outdated Show resolved Hide resolved
pages/docs/concepts/asyncapi-document/variable-url.md Outdated Show resolved Hide resolved
pages/docs/concepts/asyncapi-document/variable-url.md Outdated Show resolved Hide resolved
@quetzalliwrites quetzalliwrites added 📑 docs area/docs Specify what technical area given issue relates to. Its goal is to ease filtering good first issues. gsod This label should be used for issues or discussions related to ideas for Google Season of Docs labels Sep 1, 2023
Copy link
Member

@quetzalliwrites quetzalliwrites left a 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 😄✌🏽

Copy link
Collaborator

@TRohit20 TRohit20 left a 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.

pages/docs/concepts/asyncapi document/url-variable.md Outdated Show resolved Hide resolved
pages/docs/concepts/asyncapi document/variable-url.md Outdated Show resolved Hide resolved
pages/docs/concepts/asyncapi document/variable-url.md Outdated Show resolved Hide resolved
pages/docs/concepts/asyncapi document/variable-url.md Outdated Show resolved Hide resolved
Comment on lines +14 to +29
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
```
Copy link
Member

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.

pages/docs/concepts/asyncapi document/variable-url.md Outdated Show resolved Hide resolved
pages/docs/concepts/asyncapi document/variable-url.md Outdated Show resolved Hide resolved
pages/docs/concepts/asyncapi document/variable-url.md Outdated Show resolved Hide resolved
pages/docs/concepts/asyncapi document/variable-url.md Outdated Show resolved Hide resolved
pages/docs/concepts/asyncapi document/variable-url.md Outdated Show resolved Hide resolved
@derberg derberg deleted the branch asyncapi:next-major-spec December 5, 2023 09:40
@derberg derberg closed this Dec 5, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs Specify what technical area given issue relates to. Its goal is to ease filtering good first issues. 📑 docs gsod This label should be used for issues or discussions related to ideas for Google Season of Docs
Projects
Status: Community PR under Review 🧐
Development

Successfully merging this pull request may close these issues.

5 participants