Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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
fix: wrong validation with AsyncAPI v3 in VS Code and JetBrains IDEs #495
fix: wrong validation with AsyncAPI v3 in VS Code and JetBrains IDEs #495
Changes from 6 commits
03965248af32be518e3e078ce54db5f213987a6097981c80d212cc82e8ee4a2b573b5462c5193297e778dddb3d3a4c5ef0acfb26e469431cb45e61052b06c5d34130da9a7d47eba77edFile filter
Filter by extension
Conversations
Jump to
There are no files selected for viewing
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
After a deep investigation, I concluded this cannot be changed to
anyOfand should stay asallOf.The reason is that
anyOfwill try to match with any schema in the array. The problem is that since those schemas areif, and anifconditional fails, it is considered an empty schema, which is equivalent totrueassertion of that element in theanyOfarray.See this example I made by extracting the logic in place and reducing the complexity for test purposes: https://www.jsonschemavalidator.net/s/q0RfvVqb
As you can see, the
ifis failing (doesn't match the schemaFormat), but theanyOfis resulting in a true assertion. Totally against what we expect.How can we fix then the issue?
Let's read what the JSON Schema validator says:
The issue comes not at this line, but at this other one.
The point is that the keyword
$refis both defined in theReferenceschema and in theschema, which is a superset of JSON Schema and it does include the$refkeyword itself.That's why JSON Schema validation says the schema is matching with more than one schema in this
oneOf.By changing that
oneOftoanyOf, we ensure that by matching with any of those schemas will be considered a valid doc.I spent some time trying to find edge-cases for the change I'm suggesting. For example, what if we change how our Reference Object (
$ref) look like? Then, it will differ from JSON Schema provided one, and we could set it back then tooneOfif needed.Btw, this change should be propagated to the
oneOfin OpenAPI since OpenAPI schema is also a superset of JSON Schema and it includes the$refproperty.Additionally, I investigated a bit if we could get rid of those
if/thenand I believe we could just useallOfwith all the possible cases as schemas right directly, without theif/then, including the case when theschemaFormatis just an unknownstring.But this, is out of the scope of this issue I believe. Just for the record.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@smoya check out new validation rules. I have removed all
if/thenconstructionsPlayground: https://www.jsonschemavalidator.net/s/JmGON4jI
Specification to test:
{ "asyncapi": "3.0.0", "info": { "version": "", "title": "" }, "components": { "messages": { "asyncAPISchema1": { "payload": { "schemaFormat": "application/vnd.aai.asyncapi+json;version=3.0.0", "schema": { "$ref": "#/components/schemas/asyncAPISchema1" } }, "name": "asyncAPISchema1", "title": "asyncAPISchema1", "description": "asyncAPISchema1 payload model", "bindings": { "amqp": { "bindingVersion": "0.3.0" } } }, "asyncAPISchema2": { "payload": { "schemaFormat": "application/vnd.aai.asyncapi+json;version=3.0.0", "schema": { "externalDocs": { "description": "description field", "url": "https://local.url" }, "$ref": "#/components/schemas/asyncAPISchema2" } }, "name": "asyncAPISchema2", "title": "asyncAPISchema2", "description": "asyncAPISchema2 payload model", "bindings": { "amqp": { "bindingVersion": "0.3.0" } } }, "asyncAPIReference": { "payload": { "$ref": "#/components/schemas/asyncAPIReference" }, "name": "asyncAPIReference", "title": "asyncAPIReference", "description": "asyncAPIReference payload model", "bindings": { "amqp": { "bindingVersion": "0.3.0" } } }, "jsonSchema": { "payload": { "schemaFormat": "application/schema+json;version=draft-07", "schema": { "title": "AnotherPayloadDto", "uniqueItems": true, "$ref": "#/components/schemas/jsonSchema" } }, "name": "jsonSchema", "title": "jsonSchema", "description": "jsonSchema payload model", "bindings": { "amqp": { "bindingVersion": "0.3.0" } } }, "openAPISchema1": { "payload": { "schemaFormat": "application/vnd.oai.openapi+json;version=3.0.0", "schema": { "$ref": "#/components/schemas/openAPISchema1" } }, "name": "openAPISchema1", "title": "openAPISchema1", "description": "openAPISchema1 payload model", "bindings": { "amqp": { "bindingVersion": "0.3.0" } } }, "openAPISchema2": { "payload": { "schemaFormat": "application/vnd.oai.openapi+json;version=3.0.0", "schema": { "writeOnly": true, "readOnly": true, "nullable": true } }, "name": "openAPISchema2", "title": "openAPISchema2", "description": "openAPISchema2 payload model", "bindings": { "amqp": { "bindingVersion": "0.3.0" } } }, "avroSchema1": { "payload": { "schemaFormat": "application/vnd.apache.avro+json;version=1.9.0", "schema": { "type" : "record", "namespace" : "Tutorialspoint", "name" : "Employee", "fields" : [ { "name" : "Name" , "type" : "string" }, { "name" : "Age" , "type" : "int" } ] } }, "name": "avroSchema1", "title": "avroSchema1", "description": "avroSchema-1 payload model", "bindings": { "amqp": { "bindingVersion": "0.3.0" } } }, "avroSchema2": { "payload": { "schemaFormat": "application/vnd.apache.avro+json;version=1.9.0", "schema": { "$ref": "#/components/schemas/avroSchema2" } }, "name": "avroSchema2", "title": "avroSchema2", "description": "avroSchema-2 payload model", "bindings": { "amqp": { "bindingVersion": "0.3.0" } } } } } }