feat!: split out definitions

README.md

@@ -37,3 +37,9 @@ const asyncapi = versions['1.1.0'];
 
 // Do something with the schema.
 ```
+
+# Modifying the schemas
+Making changes to schemas version 2.2.0 or beyond should no longer be manually changed in the `./schemas` folder, but instead be done in their definition located in `definitions`.
+
+## Creating a new version
+To create a new version, simply copy paste the prior version (such as `2.2.0`) and adapt what ever changes is needed from there.

definitions/2.2.0/APIKeyHTTPSecurityScheme.json

@@ -0,0 +1,38 @@
+{
+ "type": "object",
+ "required": [
+ "type",
+ "name",
+ "in"
+ ],
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "httpApiKey"
+ ]
+ },
+ "name": {
+ "type": "string"
+ },
+ "in": {
+ "type": "string",
+ "enum": [
+ "header",
+ "query",
+ "cookie"
+ ]
+ },
+ "description": {
+ "type": "string"
+ }
+ },
+ "patternProperties": {
+ "^x-[\\w\\d.\\-_]+$": {
+ "$ref": "http://asyncapi.com/draft-07/schemas/specificationExtension"
+ }
+ },
+ "additionalProperties": false,
+ "$schema": "http://json-schema.org/draft-07/schema#",
+ "$id": "http://asyncapi.com/draft-07/schemas/APIKeyHTTPSecurityScheme"
+}

definitions/2.2.0/BearerHTTPSecurityScheme.json

@@ -0,0 +1,35 @@
+{
+ "type": "object",
+ "required": [
+ "type",
+ "scheme"
+ ],
+ "properties": {
+ "scheme": {
+ "type": "string",
+ "enum": [
+ "bearer"
+ ]
+ },
+ "bearerFormat": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "http"
+ ]
+ },
+ "description": {
+ "type": "string"
+ }
+ },
+ "patternProperties": {
+ "^x-[\\w\\d.\\-_]+$": {
+ "$ref": "http://asyncapi.com/draft-07/schemas/specificationExtension"
+ }
+ },
+ "additionalProperties": false,
+ "$schema": "http://json-schema.org/draft-07/schema#",
+ "$id": "http://asyncapi.com/draft-07/schemas/BearerHTTPSecurityScheme"
+}

definitions/2.2.0/HTTPSecurityScheme.json

@@ -0,0 +1,15 @@
+{
+ "oneOf": [
+ {
+ "$ref": "http://asyncapi.com/draft-07/schemas/NonBearerHTTPSecurityScheme"
+ },
+ {
+ "$ref": "http://asyncapi.com/draft-07/schemas/BearerHTTPSecurityScheme"
+ },
+ {
+ "$ref": "http://asyncapi.com/draft-07/schemas/APIKeyHTTPSecurityScheme"
+ }
+ ],
+ "$schema": "http://json-schema.org/draft-07/schema#",
+ "$id": "http://asyncapi.com/draft-07/schemas/HTTPSecurityScheme"
+}

definitions/2.2.0/NonBearerHTTPSecurityScheme.json

@@ -0,0 +1,40 @@
+{
+ "not": {
+ "type": "object",
+ "properties": {
+ "scheme": {
+ "type": "string",
+ "enum": [
+ "bearer"
+ ]
+ }
+ }
+ },
+ "type": "object",
+ "required": [
+ "scheme",
+ "type"
+ ],
+ "properties": {
+ "scheme": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "http"
+ ]
+ }
+ },
+ "patternProperties": {
+ "^x-[\\w\\d.\\-_]+$": {
+ "$ref": "http://asyncapi.com/draft-07/schemas/specificationExtension"
+ }
+ },
+ "additionalProperties": false,
+ "$schema": "http://json-schema.org/draft-07/schema#",
+ "$id": "http://asyncapi.com/draft-07/schemas/NonBearerHTTPSecurityScheme"
+}

definitions/2.2.0/Reference.json

@@ -0,0 +1,13 @@
+{
+ "type": "object",
+ "required": [
+ "$ref"
+ ],
+ "properties": {
+ "$ref": {
+ "$ref": "http://asyncapi.com/draft-07/schemas/ReferenceObject"
+ }
+ },
+ "$schema": "http://json-schema.org/draft-07/schema#",
+ "$id": "http://asyncapi.com/draft-07/schemas/Reference"
+}

definitions/2.2.0/ReferenceObject.json

@@ -0,0 +1,6 @@
+{
+ "type": "string",
+ "format": "uri-reference",
+ "$schema": "http://json-schema.org/draft-07/schema#",
+ "$id": "http://asyncapi.com/draft-07/schemas/ReferenceObject"
+}

definitions/2.2.0/SaslGssapiSecurityScheme.json

@@ -0,0 +1,25 @@
+{
+ "type": "object",
+ "required": [
+ "type"
+ ],
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "gssapi"
+ ]
+ },
+ "description": {
+ "type": "string"
+ }
+ },
+ "patternProperties": {
+ "^x-[\\w\\d.\\-_]+$": {
+ "$ref": "http://asyncapi.com/draft-07/schemas/specificationExtension"
+ }
+ },
+ "additionalProperties": false,
+ "$schema": "http://json-schema.org/draft-07/schema#",
+ "$id": "http://asyncapi.com/draft-07/schemas/SaslGssapiSecurityScheme"
+}

definitions/2.2.0/SaslPlainSecurityScheme.json

@@ -0,0 +1,25 @@
+{
+ "type": "object",
+ "required": [
+ "type"
+ ],
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "plain"
+ ]
+ },
+ "description": {
+ "type": "string"
+ }
+ },
+ "patternProperties": {
+ "^x-[\\w\\d.\\-_]+$": {
+ "$ref": "http://asyncapi.com/draft-07/schemas/specificationExtension"
+ }
+ },
+ "additionalProperties": false,
+ "$schema": "http://json-schema.org/draft-07/schema#",
+ "$id": "http://asyncapi.com/draft-07/schemas/SaslPlainSecurityScheme"
+}

definitions/2.2.0/SaslScramSecurityScheme.json

@@ -0,0 +1,26 @@
+{
+ "type": "object",
+ "required": [
+ "type"
+ ],
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "scramSha256",
+ "scramSha512"
+ ]
+ },
+ "description": {
+ "type": "string"
+ }
+ },
+ "patternProperties": {
+ "^x-[\\w\\d.\\-_]+$": {
+ "$ref": "http://asyncapi.com/draft-07/schemas/specificationExtension"
+ }
+ },
+ "additionalProperties": false,
+ "$schema": "http://json-schema.org/draft-07/schema#",
+ "$id": "http://asyncapi.com/draft-07/schemas/SaslScramSecurityScheme"
+}

definitions/2.2.0/SaslSecurityScheme.json

@@ -0,0 +1,15 @@
+{
+ "oneOf": [
+ {
+ "$ref": "http://asyncapi.com/draft-07/schemas/SaslPlainSecurityScheme"
+ },
+ {
+ "$ref": "http://asyncapi.com/draft-07/schemas/SaslScramSecurityScheme"
+ },
+ {
+ "$ref": "http://asyncapi.com/draft-07/schemas/SaslGssapiSecurityScheme"
+ }
+ ],
+ "$schema": "http://json-schema.org/draft-07/schema#",
+ "$id": "http://asyncapi.com/draft-07/schemas/SaslSecurityScheme"
+}

definitions/2.2.0/SecurityRequirement.json

@@ -0,0 +1,12 @@
+{
+ "type": "object",
+ "additionalProperties": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "uniqueItems": true
+ },
+ "$schema": "http://json-schema.org/draft-07/schema#",
+ "$id": "http://asyncapi.com/draft-07/schemas/SecurityRequirement"
+}

definitions/2.2.0/SecurityScheme.json

@@ -0,0 +1,33 @@
+{
+ "oneOf": [
+ {
+ "$ref": "http://asyncapi.com/draft-07/schemas/userPassword"
+ },
+ {
+ "$ref": "http://asyncapi.com/draft-07/schemas/apiKey"
+ },
+ {
+ "$ref": "http://asyncapi.com/draft-07/schemas/X509"
+ },
+ {
+ "$ref": "http://asyncapi.com/draft-07/schemas/symmetricEncryption"
+ },
+ {
+ "$ref": "http://asyncapi.com/draft-07/schemas/asymmetricEncryption"
+ },
+ {
+ "$ref": "http://asyncapi.com/draft-07/schemas/HTTPSecurityScheme"
+ },
+ {
+ "$ref": "http://asyncapi.com/draft-07/schemas/oauth2Flows"
+ },
+ {
+ "$ref": "http://asyncapi.com/draft-07/schemas/openIdConnect"
+ },
+ {
+ "$ref": "http://asyncapi.com/draft-07/schemas/SaslSecurityScheme"
+ }
+ ],
+ "$schema": "http://json-schema.org/draft-07/schema#",
+ "$id": "http://asyncapi.com/draft-07/schemas/SecurityScheme"
+}

definitions/2.2.0/X509.json

@@ -0,0 +1,25 @@
+{
+ "type": "object",
+ "required": [
+ "type"
+ ],
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "X509"
+ ]
+ },
+ "description": {
+ "type": "string"
+ }
+ },
+ "patternProperties": {
+ "^x-[\\w\\d.\\-_]+$": {
+ "$ref": "http://asyncapi.com/draft-07/schemas/specificationExtension"
+ }
+ },
+ "additionalProperties": false,
+ "$schema": "http://json-schema.org/draft-07/schema#",
+ "$id": "http://asyncapi.com/draft-07/schemas/X509"
+}

definitions/2.2.0/apiKey.json

@@ -0,0 +1,33 @@
+{
+ "type": "object",
+ "required": [
+ "type",
+ "in"
+ ],
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "apiKey"
+ ]
+ },
+ "in": {
+ "type": "string",
+ "enum": [
+ "user",
+ "password"
+ ]
+ },
+ "description": {
+ "type": "string"
+ }
+ },
+ "patternProperties": {
+ "^x-[\\w\\d.\\-_]+$": {
+ "$ref": "http://asyncapi.com/draft-07/schemas/specificationExtension"
+ }
+ },
+ "additionalProperties": false,
+ "$schema": "http://json-schema.org/draft-07/schema#",
+ "$id": "http://asyncapi.com/draft-07/schemas/apiKey"
+}