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.

Sign up for GitHub

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

Jump to bottom

fix: wrong validation with AsyncAPI v3 in VS Code and JetBrains IDEs #495

Merged
merged 21 commits into from
Apr 3, 2024
Merged

fix: wrong validation with AsyncAPI v3 in VS Code and JetBrains IDEs #495

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
0396524
fix: AsyncAPI v3 shows warning in Studio and IntelliJ plugin when ref…
Pakisan Mar 10, 2024
8af32be
fix: AsyncAPI v3 shows warning in Studio and IntelliJ plugin when ref…
Pakisan Mar 10, 2024
518e3e0
fix: AsyncAPI v3 shows warning in Studio and IntelliJ plugin when ref…
Pakisan Mar 11, 2024
78ce54d
Merge branch 'master' into fix/494
Pakisan Mar 12, 2024
b5f2139
fix: AsyncAPI v3 shows warning in Studio and IntelliJ plugin when ref…
Pakisan Mar 12, 2024
87a6097
fix: AsyncAPI v3 shows warning in Studio and IntelliJ plugin when ref…
Pakisan Mar 12, 2024
981c80d
fix: AsyncAPI v3 shows warning in Studio and IntelliJ plugin when ref…
Pakisan Mar 12, 2024
212cc82
Merge branch 'master' into fix/494
Pakisan Mar 15, 2024
e8ee4a2
Merge branch 'master' into fix/494
Pakisan Mar 19, 2024
b573b54
Update .gitignore
Pakisan Mar 19, 2024
62c5193
fix: AsyncAPI v3 shows warning in Studio and IntelliJ plugin when ref…
Pakisan Mar 19, 2024
297e778
fix: AsyncAPI v3 shows warning in Studio and IntelliJ plugin when ref…
Pakisan Mar 19, 2024
dddb3d3
fix: AsyncAPI v3 shows warning in Studio and IntelliJ plugin when ref…
Pakisan Mar 22, 2024
a4c5ef0
fix: AsyncAPI v3 shows warning in Studio and IntelliJ plugin when ref…
Pakisan Mar 25, 2024
acfb26e
fix: AsyncAPI v3 shows warning in Studio and IntelliJ plugin when ref…
Pakisan Mar 25, 2024
469431c
fix: AsyncAPI v3 shows warning in Studio and IntelliJ plugin when ref…
Pakisan Mar 28, 2024
b45e610
fix: AsyncAPI v3 shows warning in Studio and IntelliJ plugin when ref…
Pakisan Mar 28, 2024
52b06c5
fix: AsyncAPI v3 shows warning in Studio and IntelliJ plugin when ref…
Pakisan Mar 29, 2024
d34130d
fix: AsyncAPI v3 shows warning in Studio and IntelliJ plugin when ref…
Pakisan Apr 2, 2024
a9a7d47
fix: AsyncAPI v3 shows warning in Studio and IntelliJ plugin when ref…
Pakisan Apr 2, 2024
eba77ed
Merge branch 'master' into fix/494
smoya Apr 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
node_modules
.nyc_output
.vscode
coverage
coverage

.DS_Store
9 changes: 1 addition & 8 deletions definitions/3.0.0/components.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,7 @@
"description": "An object to hold reusable Schema Object. If this is a Schema Object, then the schemaFormat will be assumed to be 'application/vnd.aai.asyncapi+json;version=asyncapi' where the version is equal to the AsyncAPI Version String.",
"patternProperties": {
"^[\\w\\d\\.\\-_]+$": {
"oneOf": [
{
"$ref": "http://asyncapi.com/definitions/3.0.0/Reference.json"
},
{
"$ref": "http://asyncapi.com/definitions/3.0.0/anySchema.json"
}
]
"$ref": "http://asyncapi.com/definitions/3.0.0/anySchema.json"
Pakisan marked this conversation as resolved.
Show resolved Hide resolved
}
}
},
Expand Down
51 changes: 13 additions & 38 deletions definitions/3.0.0/multiFormatSchema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
{
"description": "The Multi Format Schema Object represents a schema definition. It differs from the Schema Object in that it supports multiple schema formats or languages (e.g., JSON Schema, Avro, etc.).",
"type": "object",
"patternProperties": {
"^x-[\\w\\d\\.\\x2d_]+$": {
"$ref": "http://asyncapi.com/definitions/3.0.0/specificationExtension.json"
}
},
"if": {
Copy link
Member

Choose a reason for hiding this comment

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

If you want, feel free to remove this if/then as #507 does ✌️

"not": {
"type": "object"
Expand All @@ -9,13 +15,6 @@
"$ref": "http://asyncapi.com/definitions/3.0.0/schema.json"
},
"else": {
"type": "object",
"additionalProperties": false,
"patternProperties": {
"^x-[\\w\\d\\.\\x2d_]+$": {
"$ref": "http://asyncapi.com/definitions/3.0.0/specificationExtension.json"
}
},
"properties": {
"schemaFormat": {
"description": "A string containing the name of the schema format that is used to define the information. If schemaFormat is missing, it MUST default to application/vnd.aai.asyncapi+json;version={{asyncapi}} where {{asyncapi}} matches the AsyncAPI Version String. In such a case, this would make the Multi Format Schema Object equivalent to the Schema Object. When using Reference Object within the schema, the schemaFormat of the resource being referenced MUST match the schemaFormat of the schema that contains the initial reference. For example, if you reference Avro schema, then schemaFormat of referencing resource and the resource being reference MUST match.",
Expand All @@ -37,21 +36,18 @@
{
"description": "All the schema formats tools are RECOMMENDED to support",
"enum": [
"application/vnd.oai.openapi;version=3.0.0",
"application/vnd.oai.openapi+json;version=3.0.0",
"application/vnd.oai.openapi;version=3.0.0",
"application/vnd.oai.openapi+json;version=3.0.0",
"application/vnd.oai.openapi+yaml;version=3.0.0",

"application/vnd.apache.avro;version=1.9.0",
"application/vnd.apache.avro+json;version=1.9.0",
"application/vnd.apache.avro+yaml;version=1.9.0",

"application/raml+yaml;version=1.0"
]
}
]
},
"schema": {
"description": "Definition of the message payload. It can be of any type but defaults to Schema Object. It MUST match the schema format defined in schemaFormat, including the encoding type. E.g., Avro should be inlined as either a YAML or JSON object instead of as a string to be parsed as YAML or JSON. Non-JSON-based schemas (e.g., Protobuf or XSD) MUST be inlined as a string."
}
},
"allOf": [
Expand All @@ -67,14 +63,7 @@
"then": {
"properties": {
"schema": {
"oneOf": [
{
"$ref": "http://asyncapi.com/definitions/3.0.0/Reference.json"
},
{
"$ref": "http://asyncapi.com/definitions/3.0.0/schema.json"
}
]
"$ref": "http://asyncapi.com/definitions/3.0.0/schema.json"
}
}
}
Expand Down Expand Up @@ -119,14 +108,7 @@
"then": {
"properties": {
"schema": {
"oneOf": [
{
"$ref": "http://asyncapi.com/definitions/3.0.0/Reference.json"
},
{
"$ref": "http://asyncapi.com/definitions/3.0.0/schema.json"
}
]
"$ref": "http://asyncapi.com/definitions/3.0.0/schema.json"
}
}
}
Expand All @@ -148,14 +130,7 @@
"then": {
"properties": {
"schema": {
"oneOf": [
{
"$ref": "http://asyncapi.com/definitions/3.0.0/Reference.json"
},
{
"$ref": "http://json-schema.org/draft-07/schema"
}
]
"$ref": "http://json-schema.org/draft-07/schema"
}
}
}
Expand Down
96 changes: 32 additions & 64 deletions schemas/3.0.0-without-$id.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2056,7 +2056,7 @@
"properties": {
"type": "array",
"items": {
"$ref": "#/definitions/bindings-jms-0.0.1-server"
"$ref": "#/definitions/bindings-jms-0.0.1-server/definitions/property"
},
"description": "Additional properties to set on the JMS ConnectionFactory implementation for the JMS Provider."
},
Expand Down Expand Up @@ -2702,6 +2702,12 @@
},
"multiFormatSchema": {
"description": "The Multi Format Schema Object represents a schema definition. It differs from the Schema Object in that it supports multiple schema formats or languages (e.g., JSON Schema, Avro, etc.).",
"type": "object",
"patternProperties": {
"^x-[\\w\\d\\.\\x2d_]+$": {
"$ref": "#/definitions/specificationExtension"
}
},
"if": {
"not": {
"type": "object"
Expand All @@ -2711,13 +2717,6 @@
"$ref": "#/definitions/schema"
},
"else": {
"type": "object",
"additionalProperties": false,
"patternProperties": {
"^x-[\\w\\d\\.\\x2d_]+$": {
"$ref": "#/definitions/specificationExtension"
}
},
"properties": {
"schemaFormat": {
"description": "A string containing the name of the schema format that is used to define the information. If schemaFormat is missing, it MUST default to application/vnd.aai.asyncapi+json;version={{asyncapi}} where {{asyncapi}} matches the AsyncAPI Version String. In such a case, this would make the Multi Format Schema Object equivalent to the Schema Object. When using Reference Object within the schema, the schemaFormat of the resource being referenced MUST match the schemaFormat of the schema that contains the initial reference. For example, if you reference Avro schema, then schemaFormat of referencing resource and the resource being reference MUST match.",
Expand Down Expand Up @@ -2748,9 +2747,6 @@
]
}
]
},
"schema": {
"description": "Definition of the message payload. It can be of any type but defaults to Schema Object. It MUST match the schema format defined in schemaFormat, including the encoding type. E.g., Avro should be inlined as either a YAML or JSON object instead of as a string to be parsed as YAML or JSON. Non-JSON-based schemas (e.g., Protobuf or XSD) MUST be inlined as a string."
}
},
"allOf": [
Expand All @@ -2766,14 +2762,7 @@
"then": {
"properties": {
"schema": {
"oneOf": [
{
"$ref": "#/definitions/Reference"
},
{
"$ref": "#/definitions/schema"
}
]
"$ref": "#/definitions/schema"
}
}
}
Expand Down Expand Up @@ -2818,14 +2807,7 @@
"then": {
"properties": {
"schema": {
"oneOf": [
{
"$ref": "#/definitions/Reference"
},
{
"$ref": "#/definitions/schema"
}
]
"$ref": "#/definitions/schema"
}
}
}
Expand All @@ -2847,14 +2829,7 @@
"then": {
"properties": {
"schema": {
"oneOf": [
{
"$ref": "#/definitions/Reference"
},
{
"$ref": "#/definitions/json-schema-draft-07-schema"
}
]
"$ref": "#/definitions/json-schema-draft-07-schema"
}
}
}
Expand Down Expand Up @@ -5719,10 +5694,10 @@
"description": "The name of the topic. Can be different from the channel name to allow flexibility around AWS resource naming limitations."
},
"ordering": {
"$ref": "#/definitions/bindings-sns-0.1.0-channel"
"$ref": "#/definitions/bindings-sns-0.1.0-channel/definitions/ordering"
},
"policy": {
"$ref": "#/definitions/bindings-sns-0.1.0-channel"
"$ref": "#/definitions/bindings-sns-0.1.0-channel/definitions/policy"
},
"tags": {
"type": "object",
Expand Down Expand Up @@ -5777,7 +5752,7 @@
"type": "array",
"description": "An array of statement objects, each of which controls a permission for this topic",
"items": {
"$ref": "#/definitions/bindings-sns-0.1.0-channel"
"$ref": "#/definitions/bindings-sns-0.1.0-channel/definitions/statement"
}
}
},
Expand Down Expand Up @@ -5864,11 +5839,11 @@
"properties": {
"queue": {
"description": "A definition of the queue that will be used as the channel.",
"$ref": "#/definitions/bindings-sqs-0.2.0-channel"
"$ref": "#/definitions/bindings-sqs-0.2.0-channel/definitions/queue"
},
"deadLetterQueue": {
"description": "A definition of the queue that will be used for un-processable messages.",
"$ref": "#/definitions/bindings-sqs-0.2.0-channel"
"$ref": "#/definitions/bindings-sqs-0.2.0-channel/definitions/queue"
},
"bindingVersion": {
"type": "string",
Expand Down Expand Up @@ -5947,10 +5922,10 @@
"default": 345600
},
"redrivePolicy": {
"$ref": "#/definitions/bindings-sqs-0.2.0-channel"
"$ref": "#/definitions/bindings-sqs-0.2.0-channel/definitions/redrivePolicy"
},
"policy": {
"$ref": "#/definitions/bindings-sqs-0.2.0-channel"
"$ref": "#/definitions/bindings-sqs-0.2.0-channel/definitions/policy"
},
"tags": {
"type": "object",
Expand All @@ -5972,7 +5947,7 @@
},
"properties": {
"deadLetterQueue": {
"$ref": "#/definitions/bindings-sqs-0.2.0-channel"
"$ref": "#/definitions/bindings-sqs-0.2.0-channel/definitions/identifier"
},
"maxReceiveCount": {
"type": "integer",
Expand Down Expand Up @@ -6016,7 +5991,7 @@
"type": "array",
"description": "An array of statement objects, each of which controls a permission for this queue.",
"items": {
"$ref": "#/definitions/bindings-sqs-0.2.0-channel"
"$ref": "#/definitions/bindings-sqs-0.2.0-channel/definitions/statement"
}
}
},
Expand Down Expand Up @@ -7638,19 +7613,19 @@
},
"properties": {
"topic": {
"$ref": "#/definitions/bindings-sns-0.1.0-operation",
"$ref": "#/definitions/bindings-sns-0.1.0-operation/definitions/identifier",
"description": "Often we can assume that the SNS Topic is the channel name-we provide this field in case the you need to supply the ARN, or the Topic name is not the channel name in the AsyncAPI document."
},
"consumers": {
"type": "array",
"description": "The protocols that listen to this topic and their endpoints.",
"items": {
"$ref": "#/definitions/bindings-sns-0.1.0-operation"
"$ref": "#/definitions/bindings-sns-0.1.0-operation/definitions/consumer"
},
"minItems": 1
},
"deliveryPolicy": {
"$ref": "#/definitions/bindings-sns-0.1.0-operation",
"$ref": "#/definitions/bindings-sns-0.1.0-operation/definitions/deliveryPolicy",
"description": "Policy for retries to HTTP. The field is the default for HTTP receivers of the SNS Topic which may be overridden by a specific consumer."
},
"bindingVersion": {
Expand Down Expand Up @@ -7718,7 +7693,7 @@
},
"endpoint": {
"description": "The endpoint messages are delivered to.",
"$ref": "#/definitions/bindings-sns-0.1.0-operation"
"$ref": "#/definitions/bindings-sns-0.1.0-operation/definitions/identifier"
},
"filterPolicy": {
"type": "object",
Expand Down Expand Up @@ -7759,10 +7734,10 @@
"description": "If true AWS SNS attributes are removed from the body, and for SQS, SNS message attributes are copied to SQS message attributes. If false the SNS attributes are included in the body."
},
"redrivePolicy": {
"$ref": "#/definitions/bindings-sns-0.1.0-operation"
"$ref": "#/definitions/bindings-sns-0.1.0-operation/definitions/redrivePolicy"
},
"deliveryPolicy": {
"$ref": "#/definitions/bindings-sns-0.1.0-operation",
"$ref": "#/definitions/bindings-sns-0.1.0-operation/definitions/deliveryPolicy",
"description": "Policy for retries to HTTP. The parameter is for that SNS Subscription and overrides any policy on the SNS Topic."
},
"displayName": {
Expand Down Expand Up @@ -7834,7 +7809,7 @@
},
"properties": {
"deadLetterQueue": {
"$ref": "#/definitions/bindings-sns-0.1.0-operation",
"$ref": "#/definitions/bindings-sns-0.1.0-operation/definitions/identifier",
"description": "The SQS queue to use as a dead letter queue (DLQ)."
},
"maxReceiveCount": {
Expand Down Expand Up @@ -7912,7 +7887,7 @@
"type": "array",
"description": "Queue objects that are either the endpoint for an SNS Operation Binding Object, or the deadLetterQueue of the SQS Operation Binding Object.",
"items": {
"$ref": "#/definitions/bindings-sqs-0.2.0-operation"
"$ref": "#/definitions/bindings-sqs-0.2.0-operation/definitions/queue"
}
},
"bindingVersion": {
Expand Down Expand Up @@ -7996,10 +7971,10 @@
"default": 345600
},
"redrivePolicy": {
"$ref": "#/definitions/bindings-sqs-0.2.0-operation"
"$ref": "#/definitions/bindings-sqs-0.2.0-operation/definitions/redrivePolicy"
},
"policy": {
"$ref": "#/definitions/bindings-sqs-0.2.0-operation"
"$ref": "#/definitions/bindings-sqs-0.2.0-operation/definitions/policy"
},
"tags": {
"type": "object",
Expand All @@ -8020,7 +7995,7 @@
},
"properties": {
"deadLetterQueue": {
"$ref": "#/definitions/bindings-sqs-0.2.0-operation"
"$ref": "#/definitions/bindings-sqs-0.2.0-operation/definitions/identifier"
},
"maxReceiveCount": {
"type": "integer",
Expand Down Expand Up @@ -8064,7 +8039,7 @@
"type": "array",
"description": "An array of statement objects, each of which controls a permission for this queue.",
"items": {
"$ref": "#/definitions/bindings-sqs-0.2.0-operation"
"$ref": "#/definitions/bindings-sqs-0.2.0-operation/definitions/statement"
}
}
},
Expand Down Expand Up @@ -8516,14 +8491,7 @@
"description": "An object to hold reusable Schema Object. If this is a Schema Object, then the schemaFormat will be assumed to be 'application/vnd.aai.asyncapi+json;version=asyncapi' where the version is equal to the AsyncAPI Version String.",
"patternProperties": {
"^[\\w\\d\\.\\-_]+$": {
"oneOf": [
{
"$ref": "#/definitions/Reference"
},
{
"$ref": "#/definitions/anySchema"
}
]
"$ref": "#/definitions/anySchema"
}
}
},
Expand Down
Loading
Loading