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.

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

Jump to bottom

docs: add complex payload schema in AsyncAPI Document #1889

Closed
wants to merge 22 commits into from
Closed

docs: add complex payload schema in AsyncAPI Document #1889

wants to merge 22 commits into from

Conversation

kakabisht
Copy link
Contributor

@kakabisht kakabisht commented Jul 3, 2023 •
edited
Loading

  • What is json schemas, and why to use them
  • Specify json schemas in AsyncAPI
  • Resume schema from component

Refer: #1515

@netlify
Copy link

netlify bot commented Jul 3, 2023 •
edited
Loading

✅ Deploy Preview for shimmering-choux-eb0798 ready!

Name Link
🔨 Latest commit c337d2a
🔍 Latest deploy log https://app.netlify.com/sites/shimmering-choux-eb0798/deploys/656af83f628c080008cfe06a
😎 Deploy Preview https://deploy-preview-1889--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.

@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 Jul 20, 2023
@kakabisht kakabisht marked this pull request as ready for review July 31, 2023 18:13
@kakabisht kakabisht mentioned this pull request Aug 30, 2023
Closed
fmvilas
fmvilas requested changes Aug 31, 2023
View reviewed changes
Copy link
Member

@fmvilas fmvilas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left some comments. Overall, I think we shouldn't recommend Avro over JSON Schema, especially because the default format in AsyncAPI is JSON Schema.

Also, why is this a concept page? Feels weird to me tbh. Looks more like a guide.

pages/docs/concepts/asyncapi-document/payload-schema.md Outdated Show resolved Hide resolved
pages/docs/concepts/asyncapi-document/payload-schema.md Outdated Show resolved Hide resolved
pages/docs/concepts/asyncapi-document/payload-schema.md Outdated Show resolved Hide resolved
pages/docs/concepts/asyncapi-document/payload-schema.md Outdated Show resolved Hide resolved
pages/docs/concepts/asyncapi-document/payload-schema.md Outdated Show resolved Hide resolved
pages/docs/concepts/asyncapi-document/payload-schema.md Outdated Show resolved Hide resolved
pages/docs/concepts/asyncapi-document/payload-schema.md Outdated Show resolved Hide resolved
pages/docs/concepts/asyncapi-document/payload-schema.md Outdated Show resolved Hide resolved
quetzalliwrites
quetzalliwrites requested changes Sep 1, 2023
View reviewed changes
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.

Thanks for another great first draft! ✨✨

Same as the other PRs, let's work on reviewing your work in detail and catching mistakes. ✌🏽This PR specifically had more punctuation errors, showing a lack of proper review. (i.e., You had dangling commas instead of colons for introducing code snippets.)

kakabisht and others added 7 commits September 4, 2023 14:39
@kakabisht @fmvilas
Update pages/docs/concepts/asyncapi-document/payload-schema.md
900be20 
Co-authored-by: Fran Méndez <[email protected]>
@kakabisht @fmvilas
Update pages/docs/concepts/asyncapi-document/payload-schema.md
bd03c28 
Co-authored-by: Fran Méndez <[email protected]>
@kakabisht @fmvilas
Update pages/docs/concepts/asyncapi-document/payload-schema.md
47f7c50 
Co-authored-by: Fran Méndez <[email protected]>
@kakabisht @fmvilas
Update pages/docs/concepts/asyncapi-document/payload-schema.md
167644c 
Co-authored-by: Fran Méndez <[email protected]>
@kakabisht @fmvilas
Update pages/docs/concepts/asyncapi-document/payload-schema.md
583c51b 
Co-authored-by: Fran Méndez <[email protected]>
@kakabisht @quetzalliwrites
Update pages/docs/concepts/asyncapi-document/_section.md
42fbf4d 
Co-authored-by: Alejandra Quetzalli  <[email protected]>
@kakabisht @quetzalliwrites
Update pages/docs/concepts/asyncapi-document/payload-schema.md
7a6b76d 
Co-authored-by: Alejandra Quetzalli  <[email protected]>
@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
Reviewers

@asyncapi-bot-eve asyncapi-bot-eve Awaiting requested review from asyncapi-bot-eve

@quetzalliwrites quetzalliwrites Awaiting requested review from quetzalliwrites

@derberg derberg Awaiting requested review from derberg

@fmvilas fmvilas Awaiting requested review from fmvilas

Assignees

@kakabisht kakabisht

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
AsyncAPI Docs Board
Status: Community PR under Review 🧐
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@kakabisht @fmvilas @derberg @quetzalliwrites