You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The spectral rule schemaValidation currently enforces that all examples have the same type as the schema type. However, we believe that there are cases in AsyncAPI, where it is needed to accept string examples regardless of the schema type.
Expected behavior
No error/validation message when using string examples
See the error: 66:11 error asyncapi-schema-examples "0" property type must be object components.schemas.io.github.springwolf.examples.kafka.dtos.XmlPayloadDto.examples[0]
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. Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.
Relates to stoplightio/spectral#2624 (Now I believe that async api studio uses parser-js only, not the spectral ruleset)
Relates to asyncapi/spec#1038 (embedding xml examples as strings in a (JSON) AsyncAPI document)
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.
Describe the bug.
The spectral rule schemaValidation currently enforces that all examples have the same type as the schema type. However, we believe that there are cases in AsyncAPI, where it is needed to accept string examples regardless of the schema type.
Expected behavior
No error/validation message when using string examples
Screenshots
N/A
How to Reproduce
string
in Message Example Object field payload for non-json payloads (like xml, yaml) spec#1038 (comment)🥦 Browser
None
👀 Have you checked for similar open issues?
🏢 Have you read the Contributing Guidelines?
Are you willing to work on this issue ?
Yes I am willing to submit a PR!
Initial proposal, after issue is approved: https://github.com/asyncapi/parser-js/compare/master...timonback:parser-js:fix/GH-997?expand=1
The text was updated successfully, but these errors were encountered: