diff --git a/.all-contributorsrc b/.all-contributorsrc index ef18e312b9..2f19c78ed9 100644 --- a/.all-contributorsrc +++ b/.all-contributorsrc @@ -817,6 +817,15 @@ "contributions": [ "doc" ] + }, + { + "login": "officialasishkumar", + "name": "Asish Kumar", + "avatar_url": "https://avatars.githubusercontent.com/u/87874775?v=4", + "profile": "https://github.com/officialasishkumar", + "contributions": [ + "doc" + ] } ], "contributorsPerLine": 7, diff --git a/README.md b/README.md index 71329d22f0..093b1a8e19 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ [![Discussions](https://img.shields.io/github/discussions/asyncapi/modelina)](https://github.com/asyncapi/modelina/discussions) [![Website](https://img.shields.io/website?label=website&url=https%3A%2F%2Fwww.modelina.org)](https://www.modelina.org) [![Playground](https://img.shields.io/website?label=playground&url=https%3A%2F%2Fwww.modelina.org%2Fplayground)](https://www.modelina.org/playground) -[![All Contributors](https://img.shields.io/badge/all_contributors-75-orange.svg?style=flat-square)](#contributors-) +[![All Contributors](https://img.shields.io/badge/all_contributors-76-orange.svg?style=flat-square)](#contributors-) Your one-stop tool for generating accurate and well-tested models for representing the message payloads. Use it as a tool in your development workflow, or a library in a larger integrations, entirely in your control. @@ -419,6 +419,7 @@ Thanks go out to these wonderful people ([emoji key](https://allcontributors.org Harshil Jani
Harshil Jani
💻 ⚠️ Mintu Gogoi
Mintu Gogoi
⚠️ Devansh Mahant
Devansh Mahant
📖 + Asish Kumar
Asish Kumar
📖 diff --git a/docs/constraints/CSharp.md b/docs/constraints/CSharp.md index 17e1d5be9e..556cfd7a9a 100644 --- a/docs/constraints/CSharp.md +++ b/docs/constraints/CSharp.md @@ -21,7 +21,7 @@ These are the constraints that is applied to object properties and the naming of |NO_NUMBER_START_CHAR|No numbers as starting characters|Default behavior is pre pending `number_` in front of the first character| |NO_EMPTY_VALUE|No empty values|Default behavior is to use `empty` as name. | |NO_RESERVED_KEYWORDS|No reserved keywords|C# has a list of reserved keywords ([see the full list here](../../src/generators/csharp/Constants.ts))| -|NAMING_FORMATTER|Must be formatted equally|Model name is formatted using pascal case| +|NAMING_FORMATTER|Must be formatted equally|Property name is formatted using pascal case| |NO_DUPLICATE_PROPERTIES|No duplicate properties|If any of the above constraints changes the property name, we must make sure that no duplicates exist within the same object. If any is encountered `reserved_` is pre-pended. This is done recursively until no duplicates are found.| @@ -34,7 +34,7 @@ These are the constraints that is applied to enum keys. The `Rule key` is what y |NO_NUMBER_START_CHAR|No numbers as starting characters|Default behavior is pre pending `number_` in front of the first character| |NO_EMPTY_VALUE|No empty values|Default behavior is to use `empty` as name. | |NO_RESERVED_KEYWORDS|No reserved keywords|C# has a list of reserved keywords ([see the full list here](../../src/generators/csharp/Constants.ts))| -|NAMING_FORMATTER|Must be formatted equally|Model name is formatted using pascal case| +|NAMING_FORMATTER|Must be formatted equally|Enum name is formatted using pascal case| |NO_DUPLICATE_KEYS|No duplicate enum keys|If any of the above constraints changes the enum key, we must make sure that no duplicates exist within the same enum. If any is encountered `reserved_` is pre-pended. This is done recursively until no duplicates are found.| ## Constant diff --git a/docs/constraints/Dart.md b/docs/constraints/Dart.md index d545a6f9bd..1639f0a2d2 100644 --- a/docs/constraints/Dart.md +++ b/docs/constraints/Dart.md @@ -21,7 +21,7 @@ These are the constraints that is applied to object properties and the naming of |NO_NUMBER_START_CHAR|No numbers as starting characters|Default behavior is pre pending `number_` in front of the first character| |NO_EMPTY_VALUE|No empty values|Default behavior is to use `empty` as name. | |NO_RESERVED_KEYWORDS|No reserved keywords|Dart has a list of reserved keywords ([see the full list here](../../src/generators/dart/Constants.ts))| -|NAMING_FORMATTER|Must be formatted equally|Model name is formatted using pascal case| +|NAMING_FORMATTER|Must be formatted equally|Property name is formatted using pascal case| |NO_DUPLICATE_PROPERTIES|No duplicate properties|If any of the above constraints changes the property name, we must make sure that no duplicates exist within the same object. If any is encountered `reserved_` is pre-pended. This is done recursively until no duplicates are found.| @@ -34,7 +34,7 @@ These are the constraints that is applied to enum keys. The `Rule key` is what y |NO_NUMBER_START_CHAR|No numbers as starting characters|Default behavior is pre pending `number_` in front of the first character| |NO_EMPTY_VALUE|No empty values|Default behavior is to use `empty` as name. | |NO_RESERVED_KEYWORDS|No reserved keywords|Dart has a list of reserved keywords ([see the full list here](../../src/generators/dart/Constants.ts))| -|NAMING_FORMATTER|Must be formatted equally|Model name is formatted using pascal case| +|NAMING_FORMATTER|Must be formatted equally|Enum name is formatted using pascal case| |NO_DUPLICATE_KEYS|No duplicate enum keys|If any of the above constraints changes the enum key, we must make sure that no duplicates exist within the same enum. If any is encountered `reserved_` is pre-pended. This is done recursively until no duplicates are found.| ## Constant diff --git a/docs/constraints/Go.md b/docs/constraints/Go.md index ef693d8383..7ee88faddb 100644 --- a/docs/constraints/Go.md +++ b/docs/constraints/Go.md @@ -21,7 +21,7 @@ These are the constraints that is applied to object properties and the naming of |NO_NUMBER_START_CHAR|No numbers as starting characters|Default behavior is pre pending `number_` in front of the first character| |NO_EMPTY_VALUE|No empty values|Default behavior is to use `empty` as name. | |NO_RESERVED_KEYWORDS|No reserved keywords|Go has a list of reserved keywords ([see the full list here](../../src/generators/go/Constants.ts))| -|NAMING_FORMATTER|Must be formatted equally|Model name is formatted using pascal case| +|NAMING_FORMATTER|Must be formatted equally|Property name is formatted using pascal case| |NO_DUPLICATE_PROPERTIES|No duplicate properties|If any of the above constraints changes the property name, we must make sure that no duplicates exist within the same object. If any is encountered `reserved_` is pre-pended. This is done recursively until no duplicates are found.| @@ -34,7 +34,7 @@ These are the constraints that is applied to enum keys. The `Rule key` is what y |NO_NUMBER_START_CHAR|No numbers as starting characters|Default behavior is pre pending `number_` in front of the first character| |NO_EMPTY_VALUE|No empty values|Default behavior is to use `empty` as name. | |NO_RESERVED_KEYWORDS|No reserved keywords|Go has a list of reserved keywords ([see the full list here](../../src/generators/go/Constants.ts))| -|NAMING_FORMATTER|Must be formatted equally|Model name is formatted using pascal case| +|NAMING_FORMATTER|Must be formatted equally|Enum name is formatted using pascal case| |NO_DUPLICATE_KEYS|No duplicate enum keys|If any of the above constraints changes the enum key, we must make sure that no duplicates exist within the same enum. If any is encountered `reserved_` is pre-pended. This is done recursively until no duplicates are found.| ## Constant diff --git a/docs/constraints/Java.md b/docs/constraints/Java.md index 29f0ff2f82..60db4a7b80 100644 --- a/docs/constraints/Java.md +++ b/docs/constraints/Java.md @@ -21,7 +21,7 @@ These are the constraints that is applied to object properties and the naming of |NO_NUMBER_START_CHAR|No numbers as starting characters|Default behavior is pre pending `number_` in front of the first character| |NO_EMPTY_VALUE|No empty values|Default behavior is to use `empty` as name. | |NO_RESERVED_KEYWORDS|No reserved keywords|Java has a list of reserved keywords ([see the full list here](../../src/generators/java/Constants.ts))| -|NAMING_FORMATTER|Must be formatted equally|Model name is formatted using pascal case| +|NAMING_FORMATTER|Must be formatted equally|Property name is formatted using pascal case| |NO_DUPLICATE_PROPERTIES|No duplicate properties|If any of the above constraints changes the property name, we must make sure that no duplicates exist within the same object. If any is encountered `reserved_` is pre-pended. This is done recursively until no duplicates are found.| @@ -34,7 +34,7 @@ These are the constraints that is applied to enum keys. The `Rule key` is what y |NO_NUMBER_START_CHAR|No numbers as starting characters|Default behavior is pre pending `number_` in front of the first character| |NO_EMPTY_VALUE|No empty values|Default behavior is to use `empty` as name. | |NO_RESERVED_KEYWORDS|No reserved keywords|Java has a list of reserved keywords ([see the full list here](../../src/generators/java/Constants.ts))| -|NAMING_FORMATTER|Must be formatted equally|Model name is formatted using pascal case| +|NAMING_FORMATTER|Must be formatted equally|Enum name is formatted using pascal case| |NO_DUPLICATE_KEYS|No duplicate enum keys|If any of the above constraints changes the enum key, we must make sure that no duplicates exist within the same enum. If any is encountered `reserved_` is pre-pended. This is done recursively until no duplicates are found.| ## Constant diff --git a/docs/constraints/JavaScript.md b/docs/constraints/JavaScript.md index 742a580086..96b685be25 100644 --- a/docs/constraints/JavaScript.md +++ b/docs/constraints/JavaScript.md @@ -21,7 +21,7 @@ These are the constraints that is applied to object properties and the naming of |NO_NUMBER_START_CHAR|No numbers as starting characters|Default behavior is pre pending `number_` in front of the first character| |NO_EMPTY_VALUE|No empty values|Default behavior is to use `empty` as name. | |NO_RESERVED_KEYWORDS|No reserved keywords|JavaScript has a list of reserved keywords ([see the full list here](../../src/generators/javascript/Constants.ts))| -|NAMING_FORMATTER|Must be formatted equally|Model name is formatted using pascal case| +|NAMING_FORMATTER|Must be formatted equally|Property name is formatted using pascal case| |NO_DUPLICATE_PROPERTIES|No duplicate properties|If any of the above constraints changes the property name, we must make sure that no duplicates exist within the same object. If any is encountered `reserved_` is pre-pended. This is done recursively until no duplicates are found.| @@ -34,7 +34,7 @@ These are the constraints that is applied to enum keys. The `Rule key` is what y |NO_NUMBER_START_CHAR|No numbers as starting characters|Default behavior is pre pending `number_` in front of the first character| |NO_EMPTY_VALUE|No empty values|Default behavior is to use `empty` as name. | |NO_RESERVED_KEYWORDS|No reserved keywords|JavaScript has a list of reserved keywords ([see the full list here](../../src/generators/javascript/Constants.ts))| -|NAMING_FORMATTER|Must be formatted equally|Model name is formatted using pascal case| +|NAMING_FORMATTER|Must be formatted equally|Enum name is formatted using pascal case| |NO_DUPLICATE_KEYS|No duplicate enum keys|If any of the above constraints changes the enum key, we must make sure that no duplicates exist within the same enum. If any is encountered `reserved_` is pre-pended. This is done recursively until no duplicates are found.| ## Constant diff --git a/docs/constraints/Rust.md b/docs/constraints/Rust.md index 611532c9c5..fd304b7e28 100644 --- a/docs/constraints/Rust.md +++ b/docs/constraints/Rust.md @@ -33,7 +33,7 @@ These are the constraints that is applied to enum keys. The `Rule key` is what y |NO_NUMBER_START_CHAR|No numbers as starting characters|Default behavior is pre pending `number_` in front of the first character| |NO_EMPTY_VALUE|No empty values|Default behavior is to use `empty` as name. | |NO_RESERVED_KEYWORDS|No reserved keywords|Rust has a list of reserved keywords ([see the full list here](../../src/generators/rust/Constants.ts))| -|NAMING_FORMATTER|Must be formatted equally|Model name is formatted using pascal case| +|NAMING_FORMATTER|Must be formatted equally|Enum name is formatted using pascal case| |NO_DUPLICATE_KEYS|No duplicate enum keys|If any of the above constraints changes the enum key, we must make sure that no duplicates exist within the same enum. If any is encountered `reserved_` is pre-pended. This is done recursively until no duplicates are found.| ## Constant diff --git a/docs/constraints/TypeScript.md b/docs/constraints/TypeScript.md index 85fc33b9cc..41095ddcfa 100644 --- a/docs/constraints/TypeScript.md +++ b/docs/constraints/TypeScript.md @@ -21,7 +21,7 @@ These are the constraints that is applied to object properties and the naming of |NO_NUMBER_START_CHAR|No numbers as starting characters|Default behavior is pre pending `number_` in front of the first character| |NO_EMPTY_VALUE|No empty values|Default behavior is to use `empty` as name. | |NO_RESERVED_KEYWORDS|No reserved keywords|TypeScript has a list of reserved keywords ([see the full list here](../../src/generators/typescript/Constants.ts))| -|NAMING_FORMATTER|Must be formatted equally|Model name is formatted using pascal case| +|NAMING_FORMATTER|Must be formatted equally|Property name is formatted using pascal case| |NO_DUPLICATE_PROPERTIES|No duplicate properties|If any of the above constraints changes the property name, we must make sure that no duplicates exist within the same object. If any is encountered `reserved_` is pre-pended. This is done recursively until no duplicates are found.| @@ -34,7 +34,7 @@ These are the constraints that is applied to enum keys. The `Rule key` is what y |NO_NUMBER_START_CHAR|No numbers as starting characters|Default behavior is pre pending `number_` in front of the first character| |NO_EMPTY_VALUE|No empty values|Default behavior is to use `empty` as name. | |NO_RESERVED_KEYWORDS|No reserved keywords|TypeScript has a list of reserved keywords ([see the full list here](../../src/generators/typescript/Constants.ts))| -|NAMING_FORMATTER|Must be formatted equally|Model name is formatted using pascal case| +|NAMING_FORMATTER|Must be formatted equally|Enum name is formatted using pascal case| |NO_DUPLICATE_KEYS|No duplicate enum keys|If any of the above constraints changes the enum key, we must make sure that no duplicates exist within the same enum. If any is encountered `reserved_` is pre-pended. This is done recursively until no duplicates are found.| ## Constant diff --git a/package-lock.json b/package-lock.json index 6a3ee911c1..707514e08f 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@asyncapi/modelina", - "version": "2.1.0", + "version": "2.1.1", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@asyncapi/modelina", - "version": "2.1.0", + "version": "2.1.1", "license": "Apache-2.0", "dependencies": { "@apidevtools/json-schema-ref-parser": "^9.0.9", diff --git a/package.json b/package.json index 32f587c203..3e895bf582 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@asyncapi/modelina", - "version": "2.1.0", + "version": "2.1.1", "description": "Library for generating data models based on inputs such as AsyncAPI, OpenAPI, or JSON Schema documents", "license": "Apache-2.0", "homepage": "https://www.modelina.org",