feat: add extensions from extensions catalog to schema (#443)

Co-authored-by: derberg <[email protected]>

.sonarcloud.properties

@@ -0,0 +1 @@
+sonar.exclusions=tools/**/*

README.md

@@ -134,6 +134,8 @@ This is the current project structure explained:
 - [./examples](./examples) - contain most individual definition examples that will automatically be bundled together to provide example for each definition in the schemas in [./schemas](./schemas).
 - [./tools/bundler](./tools/bundler) - is the tool that bundles all the individual schemas together.
 - [./schemas](./schemas) - contain all automatically bundled and complete schemas for each AsyncAPI version. These schemas should **NOT** be manually changed as they are automatically generated. Any changes should be done in [./definitions](./definitions).
+- [./extensions](./extensions) - contains all the schemas of the extensions that will automatically be bundled to provide informations about extensions.
+
 
 ## Schema Bundling
 
@@ -210,7 +212,18 @@ Whenever you make changes in AsyncAPI JSON Schema, you should always manually ve
    ```yaml
    # yaml-language-server: $schema=YOUR-PROJECTS-DIRECTORY/spec-json-schemas/schemas/2.6.0-without-$id.json
    ```
+
+## Extensions
+
+Extensions are a way to [extend AsyncAPI specification](https://www.asyncapi.com/docs/concepts/asyncapi-document/extending-specification) with fields that are not yet defined inside the specification. To add JSON schema of the extension in this repository, you need to first make sure it is added to the [extension-catalog](https://github.com/asyncapi/extensions-catalog) repository.
+### How to add schema of the extension
+
 
+1. All the extensions must be present in [./extensions](./extensions) folder.
+2. A proper folder structure must be followed to add the extensions.
+3. A new folder just as [x extension](./extensions/x) must be added with proper `versioning` and `schema file`.
+4. All the schemas must be added in a file named `schema.json` just as one is defined for [x extension](./extensions/x/0.1.0/schema.json).
 
+5. Extension schema should not be referenced directly in the definition of the object it extends. For example if you add an extension for `info`, your extension's schema should not be referenced from `info.json` but [infoExtensions.json](./definitions/3.0.0/infoExtensions.json). If the object that you extend doesn't have a corresponding `*Extensions.json` file, you need to create one.
 
 

definitions/3.0.0/info.json

@@ -1,66 +1,70 @@
 {
-  "type": "object",
   "description": "The object provides metadata about the API. The metadata can be used by the clients if needed.",
-  "required": [
-    "version",
-    "title"
-  ],
-  "additionalProperties": false,
-  "patternProperties": {
-    "^x-[\\w\\d\\.\\x2d_]+$": {
-      "$ref": "http://asyncapi.com/definitions/3.0.0/specificationExtension.json"
-    }
-  },
-  "properties": {
-    "title": {
-      "type": "string",
-      "description": "A unique and precise title of the API."
-    },
-    "version": {
-      "type": "string",
-      "description": "A semantic version number of the API."
-    },
-    "description": {
-      "type": "string",
-      "description": "A longer description of the API. Should be different from the title. CommonMark is allowed."
-    },
-    "termsOfService": {
-      "type": "string",
-      "description": "A URL to the Terms of Service for the API. MUST be in the format of a URL.",
-      "format": "uri"
-    },
-    "contact": {
-      "$ref": "http://asyncapi.com/definitions/3.0.0/contact.json"
-    },
-    "license": {
-      "$ref": "http://asyncapi.com/definitions/3.0.0/license.json"
-    },
-    "tags": {
-      "type": "array",
-      "description": "A list of tags for application API documentation control. Tags can be used for logical grouping of applications.",
-      "items": {
-        "oneOf": [
-          {
-            "$ref": "http://asyncapi.com/definitions/3.0.0/Reference.json"
-          },
-          {
-            "$ref": "http://asyncapi.com/definitions/3.0.0/tag.json"
-          }
-        ]
+  "allOf": [
+    {    
+      "type": "object",
+      "required": ["version", "title"],
+      "additionalProperties": false,
+      "patternProperties": {
+       "^x-[\\w\\d\\.\\x2d_]+$": {
+        "$ref": "http://asyncapi.com/definitions/3.0.0/specificationExtension.json"
+       }
       },
-      "uniqueItems": true
-    },
-    "externalDocs": {
-      "oneOf": [
-        {
-          "$ref": "http://asyncapi.com/definitions/3.0.0/Reference.json"
+      "properties": {
+        "title": {
+          "type": "string",
+          "description": "A unique and precise title of the API."
         },
-        {
-          "$ref": "http://asyncapi.com/definitions/3.0.0/externalDocs.json"
+        "version": {
+          "type": "string",
+          "description": "A semantic version number of the API."
+        },
+        "description": {
+          "type": "string",
+          "description": "A longer description of the API. Should be different from the title. CommonMark is allowed."
+        },
+        "termsOfService": {
+          "type": "string",
+          "description": "A URL to the Terms of Service for the API. MUST be in the format of a URL.",
+          "format": "uri"
+        },
+        "contact": {
+          "$ref": "http://asyncapi.com/definitions/3.0.0/contact.json"
+        },
+        "license": {
+          "$ref": "http://asyncapi.com/definitions/3.0.0/license.json"
+        },
+        "tags": {
+          "type": "array",
+          "description": "A list of tags for application API documentation control. Tags can be used for logical grouping of applications.",
+          "items": {
+            "oneOf": [
+              {
+                "$ref": "http://asyncapi.com/definitions/3.0.0/Reference.json"
+              },
+              {
+                "$ref": "http://asyncapi.com/definitions/3.0.0/tag.json"
+              }
+            ]
+          },
+          "uniqueItems": true
+        },
+        "externalDocs": {
+          "oneOf": [
+            {
+              "$ref": "http://asyncapi.com/definitions/3.0.0/Reference.json"
+            },
+            {
+              "$ref": "http://asyncapi.com/definitions/3.0.0/externalDocs.json"
+            }
+          ]
         }
-      ]
+      }
+    },
+    {
+      "$ref": "http://asyncapi.com/definitions/3.0.0/infoExtensions.json"
     }
-  },
+  ],
   "example": {
     "$ref": "http://asyncapi.com/examples/3.0.0/info.json"
   },

definitions/3.0.0/infoExtensions.json

@@ -0,0 +1,11 @@
+{
+    "type": "object",
+    "description": "The object that lists all the extensions of Info",
+    "properties": {
+        "x-x":{
+            "$ref": "http://asyncapi.com/extensions/x/0.1.0/schema.json"
+        }
+    },
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "$id": "http://asyncapi.com/definitions/3.0.0/infoExtensions.json"  
+}

extensions/x/0.1.0/schema.json

@@ -0,0 +1,10 @@
+{
+    "type": "string",
+    "description": "This extension allows you to provide the Twitter username of the account representing the team/company of the API.",
+    "example": [
+        "sambhavgupta75",
+        "AsyncAPISpec"
+    ],
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "$id": "http://asyncapi.com/extensions/x/0.1.0/schema.json"
+}

tools/bundler/index.js

@@ -4,10 +4,12 @@ const traverse = require('json-schema-traverse');
 const { url } = require('inspector');
 const definitionsDirectory = path.resolve(__dirname, '../../definitions');
 const bindingsDirectory = path.resolve(__dirname, '../../bindings');
+const extensionsDirectory = path.resolve(__dirname, '../../extensions');
 const outputDirectory = path.resolve(__dirname, '../../schemas');
 const JSON_SCHEMA_PROP_NAME = 'json-schema-draft-07-schema';
 console.log(`Looking for separate definitions in the following directory: ${definitionsDirectory}`);
 console.log(`Looking for binding version schemas in the following directory: ${bindingsDirectory}`);
+console.log(`Looking for extension version schemas in the following directory: ${extensionsDirectory}`);
 console.log(`Using the following output directory: ${outputDirectory}`);
 
 // definitionsRegex is used to transform the name of a definition into a valid one to be used in the -without-$id.json files.
@@ -16,13 +18,17 @@ const definitionsRegex = /http:\/\/asyncapi\.com\/definitions\/[^/]*\/(.+)\.json
 // definitionsRegex is used to transform the name of a binding into a valid one to be used in the -without-$id.json files.
 const bindingsRegex = /http:\/\/asyncapi\.com\/(bindings\/[^/]+)\/([^/]+)\/(.+)\.json(.*)/i
 
+// definitionsRegex is used to transform the name of a binding into a valid one to be used in the -without-$id.json files.
+const extensionsRegex = /http:\/\/asyncapi\.com\/(extensions\/[^/]+)\/([^/]+)\/(.+)\.json(.*)/i
+
 /**
  * Function to load all the core AsyncAPI spec definition (except the root asyncapi schema, as that will be loaded later) into the bundler.
  */
 async function loadDefinitions(bundler, versionDir) {
   const definitions = await fs.promises.readdir(versionDir);
   const definitionFiles = definitions.filter((value) => {return !value.includes('asyncapi')}).map((file) => fs.readFileSync(path.resolve(versionDir, file)));
   const definitionJson = definitionFiles.map((file) => JSON.parse(file));
+
   for (const jsonFile of definitionJson) {
     if (jsonFile.example) {
       // Replaced the example property with the referenced example property
@@ -38,20 +44,36 @@ async function loadDefinitions(bundler, versionDir) {
     }
   }
 }
+
+
 /**
- * Function to load all the binding version schemas into the bundler
+ * Function to load all schemas into bundler, by "type" you specify if these are "bindings" or "extensions"
  */
-async function loadBindings(bundler) {
-  const bindingDirectories = await fs.promises.readdir(bindingsDirectory);
-  for (const bindingDirectory of bindingDirectories) {
-    const bindingVersionDirectories = await fs.promises.readdir(path.resolve(bindingsDirectory, bindingDirectory));
-    const bindingVersionDirectoriesFiltered = bindingVersionDirectories.filter((file) => fs.lstatSync(path.resolve(bindingsDirectory, bindingDirectory, file)).isDirectory());
-    for (const bindingVersionDirectory of bindingVersionDirectoriesFiltered) {
-      const bindingFiles = await fs.promises.readdir(path.resolve(bindingsDirectory, bindingDirectory, bindingVersionDirectory));
-      const bindingFilesFiltered = bindingFiles.filter((bindingFile) => path.extname(bindingFile) === '.json').map((bindingFile) => path.resolve(bindingsDirectory, bindingDirectory, bindingVersionDirectory, bindingFile));
-      for (const bindingFile of bindingFilesFiltered) {
-        const bindingFileContent = require(bindingFile);
-        bundler.add(bindingFileContent);
+async function loadSchemas(bundler, type) {
+
+  let directory;
+
+  switch (type) {
+    case "bindings":
+      directory = bindingsDirectory;
+      break;
+    case "extensions":
+      directory = extensionsDirectory;
+      break;
+    default:
+      console.error("Invalid input. I'm not going to assume if you want bindings or extensions - these are different beasts.");
+  }
+
+  const directories = await fs.promises.readdir(directory);
+  for (const nestedDir of directories) {
+    const versionDirectories = await fs.promises.readdir(path.resolve(directory, nestedDir));
+    const versionDirectoriesFiltered = versionDirectories.filter((file) => fs.lstatSync(path.resolve(directory, nestedDir, file)).isDirectory());
+    for (const versionDir of versionDirectoriesFiltered) {
+      const files = await fs.promises.readdir(path.resolve(directory, nestedDir, versionDir));
+      const filesFiltered = files.filter((file) => path.extname(file) === '.json').map((file) => path.resolve(directory, nestedDir, versionDir, file));
+      for (const filteredFile of filesFiltered) {
+        const fileContent = require(filteredFile);
+        bundler.add(fileContent);
       }
     }
   }
@@ -74,7 +96,8 @@ async function loadBindings(bundler) {
       const outputFileWithoutId = path.resolve(outputDirectory, `${version}-without-$id.json`);
       const versionDir = path.resolve(definitionsDirectory, version);
       await loadDefinitions(Bundler, versionDir);
-      await loadBindings(Bundler);
+      await loadSchemas(Bundler, 'bindings');
+      await loadSchemas(Bundler, 'extensions');
 
       const filePathToBundle = `file://${versionDir}/asyncapi.json`;
       const fileToBundle = await Bundler.get(filePathToBundle);
@@ -155,6 +178,10 @@ function getDefinitionName(def) {
     const result = bindingsRegex.exec(def);
     if (result) return `${result[1].replace('/', '-')}-${result[2]}-${result[3]}`;
   }
+  if (def.startsWith('http://asyncapi.com/extensions')) {
+    const result = extensionsRegex.exec(def);
+    if (result) return `${result[1].replace('/', '-')}-${result[2]}-${result[3]}`;
+  }
 
   return path.basename(def, '.json')
 }