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 payload #2414

Merged
merged 4 commits into from
Dec 16, 2023
Merged

Conversation

kakabisht
Copy link
Contributor

This document covers:

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

Refer: #1515

Copy link

netlify bot commented Dec 9, 2023

Deploy Preview for asyncapi-website ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 292cbdb
🔍 Latest deploy log https://app.netlify.com/sites/asyncapi-website/deploys/657ce7961fe6d100086f5c2a
😎 Deploy Preview https://deploy-preview-2414--asyncapi-website.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.

@asyncapi-bot
Copy link
Contributor

asyncapi-bot commented Dec 9, 2023

⚡️ Lighthouse report for the changes in this PR:

Category Score
🔴 Performance 44
🟢 Accessibility 98
🟢 Best practices 92
🟢 SEO 100
🔴 PWA 33

Lighthouse ran on https://deploy-preview-2414--asyncapi-website.netlify.app/

@derberg derberg changed the title docs: add complex payload docs: add payload Dec 13, 2023
Copy link
Member

@derberg derberg left a comment

Choose a reason for hiding this comment

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

@alequetzalli I rewrote completely as there were many generic parts, so instead of talking about complex schemas (completely different document, about JSON schema allOf, anyOf, oneOf and many others) I rewrote it to talk about payload and how it is different now in v3, its tuple nature, schema formats and stuff

@quetzalliwrites
Copy link
Member

@alequetzalli I rewrote completely as there were many generic parts...

Go it, sorry to hear you had to completely rewrite and we weren't able to use the writer's work for this doc. Thank you for going the extra mile and completely rewriting some of the docs ❤️, appreciate you! @derberg

@quetzalliwrites
Copy link
Member

@kakabisht I would love to have you comment back on this PR and detail what you thought this doc was supposed to cover or where the confusion was, so we can identify how to improve instructions next year with writers 😸

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.

I'm proud of our work on this one, @derberg 😃

@quetzalliwrites
Copy link
Member

/rtm

@asyncapi-bot asyncapi-bot merged commit 6a75ac9 into asyncapi:master Dec 16, 2023
19 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants