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: re-add studio document validation and change code snippet #2276

Conversation

AnimeshKumar923
Copy link
Contributor

Description

  • Re-added the studio document validation in the next-major-spec branch.
  • Changed the code snippet to match v3.

Related issue(s)
Fixes #1862

changes:

- Re-added the `studio document validation` in
the next-major-spec branch.
- Changed the code snippet to match v3.
@netlify
Copy link

netlify bot commented Oct 29, 2023

Deploy Preview for shimmering-choux-eb0798 ready!

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

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.

@AnimeshKumar923 made some suggestions

Comment on lines 17 to 21
<Remember>

If you did not follow the previous tutorial and do not have an `asyncapi.yaml` file ready, then generate one using `asyncapi new --example=tutorial.yml --no-tty` command.

</Remember>
Copy link
Member

Choose a reason for hiding this comment

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

I don't think this should be here in this tutorial as this tutorial is about validating invalid document in studio, basing on example provided in studio - and command under remember note talks about generating a valid document

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@derberg
okay, so if the command generates a valid document, it should not be there. Any command to generate and invalid one? If not there is a way to generate one from AsyncAPI Studio as far as I've tested. Thoughts? 👀

Copy link
Member

Choose a reason for hiding this comment

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

nah, I will just remove it

pages/docs/tutorials/studio-document-validation.md Outdated Show resolved Hide resolved
pages/docs/tutorials/studio-document-validation.md Outdated Show resolved Hide resolved
pages/docs/tutorials/studio-document-validation.md Outdated Show resolved Hide resolved
pages/docs/tutorials/studio-document-validation.md Outdated Show resolved Hide resolved
pages/docs/tutorials/studio-document-validation.md Outdated Show resolved Hide resolved
pages/docs/tutorials/studio-document-validation.md Outdated Show resolved Hide resolved
pages/docs/tutorials/studio-document-validation.md Outdated Show resolved Hide resolved
pages/docs/tutorials/studio-document-validation.md Outdated Show resolved Hide resolved
pages/docs/tutorials/studio-document-validation.md Outdated Show resolved Hide resolved
AnimeshKumar923 and others added 8 commits November 9, 2023 01:01
applied suggestion from: asyncapi#2276 (comment)

Co-authored-by: Lukasz Gornicki <lpgornicki@gmail.com>
applied suggstion from: asyncapi#2276 (comment)

Co-authored-by: Lukasz Gornicki <lpgornicki@gmail.com>
applied suggestion from: asyncapi#2276 (comment)

Co-authored-by: Lukasz Gornicki <lpgornicki@gmail.com>
applied suggestion from: asyncapi#2276 (comment)

Co-authored-by: Lukasz Gornicki <lpgornicki@gmail.com>
applied suggestion from: asyncapi#2276 (comment)

Co-authored-by: Lukasz Gornicki <lpgornicki@gmail.com>
applied suggestion from: asyncapi#2276 (comment)

Co-authored-by: Lukasz Gornicki <lpgornicki@gmail.com>
applied suggestion from: asyncapi#2276 (comment)

Co-authored-by: Lukasz Gornicki <lpgornicki@gmail.com>
derberg
derberg previously approved these changes Nov 9, 2023
@quetzalliwrites
Copy link
Member

/rtm

@asyncapi-bot asyncapi-bot merged commit eafbc7a into asyncapi:next-major-spec Nov 10, 2023
10 checks passed
@AnimeshKumar923 AnimeshKumar923 deleted the adapt-studio-document-validation-tutorial-for-v3 branch November 11, 2023 07:10
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