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 Validate AsyncAPI documents #2303

Merged
merged 2 commits into from
Nov 10, 2023

Conversation

derberg
Copy link
Member

@derberg derberg commented Nov 9, 2023

resolves #1864

adding https://www.asyncapi.com/docs/guides/validate to v3

the only changes from oryginal document:

  1. Sentence One way this can be done is by using Spectral, an API linting tool which has a built-in custom ruleset properties with AsyncAPI rules for the AsyncAPI specification. It also enables you to define company-specific rules that you can use internally. to One way this can be done is by using Spectral open source tool. It enables you to define company-specific rules that you can use internally. because we do not know when spectral will have default AsyncAPI v3 rules
  2. In 4 steps tutorial, from code samples I removed part where we instruct how to extend default asyncapi v2 rules. Spectral works well without having default support for asyncapi v3. I tested my new instructions on local and was still able to apply some custom lint rules to my asyncapi document

Copy link

netlify bot commented Nov 9, 2023

Deploy Preview for shimmering-choux-eb0798 ready!

Name Link
🔨 Latest commit f539ee0
🔍 Latest deploy log https://app.netlify.com/sites/shimmering-choux-eb0798/deploys/654eaa02f7ac170008e177d7
😎 Deploy Preview https://deploy-preview-2303--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
Copy link
Member

/rtm

@asyncapi-bot asyncapi-bot merged commit 5a1a85a into asyncapi:next-major-spec Nov 10, 2023
9 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.

3 participants