-
-
Notifications
You must be signed in to change notification settings - Fork 109
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
Does not render any documentation on minor validation errors #873
Comments
Welcome to AsyncAPI. Thanks a lot for reporting your first issue. Please check out our contributors guide and the instructions about a basic recommended setup useful for opening a pull request. |
This issue has been automatically marked as stale because it has not had recent activity 😴 It will be closed in 120 days if no further activity occurs. To unstale this issue, add a comment with a detailed explanation. There can be many reasons why some specific issue has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model. Let us figure out together how to push this issue forward. Connect with us through one of many communication channels we established here. Thank you for your patience ❤️ |
If asyncapi.yml contains any minor validation error this react component does not render any documentation at all even if the rest of the file contains useful and valid information.
Example 1: if 'info.contact.email' does not validate as an email, the component does not render anything else.
Example 2: If there is an un expected section on the yml file it does not render the rest of the information.
Expected result
I would expect the component to render the doc on a best-effort-basis rendering as much as it can interpret, leaving validations to the linter component.
Editing is a dynamic process where the asyncapi definition may not be on a finished/complete state, as long as it contains valid/complete sections those should render.
It could render invalid sections with a different (error) color.
Actual result
It does not render anything at all after any error.
The text was updated successfully, but these errors were encountered: