docs: update usage documentation #857
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Kudos, SonarCloud Quality Gate passed!
|
Samridhi-98
previously approved these changes
Aug 24, 2022
# Conflicts: # docs/usage.md
|
Kudos, SonarCloud Quality Gate passed!
|
magicmatatjahu
approved these changes
Sep 15, 2022
Samridhi-98
approved these changes
Sep 15, 2022
|
/rtm |
|
🎉 This PR is included in version 1.0.0-next.7 🎉 The release is available on: Your semantic-release bot 📦🚀 |
jonaslagoni
added a commit
that referenced
this pull request
Jan 23, 2023
## [1.0.0](v0.59.9...v1.0.0) (2023-01-23) ### Upgrade Steps You can find the migration details here: https://github.com/asyncapi/modelina/blob/master/docs/migration.md Dont hesitate to reach out if you need help migrating to version 1. ### Breaking Changes There is no specific PR that contains the breaking changes but is part of multiple PRs. See the migration part above. ### New Features * feat: add Rust Generator (#818) * feat: add Kotlin model generator (#1074) * feat: add Python generator (#863) * feat: add jsonbinpack preset for TypeScript (#854) * feat: add support for AsyncAPI 2.5 (#893) * feat: add support for oneOf and anyOf as UnionModel (#899) * feat: integrate new AsyncAPI parser version (#925) * feat: add C# Newtonsoft preset (#970) * feat: add access to entire property object in constrainer (#985) * feat: add precise csharp enum type (#1047) * feat: add dependency manager (#1063) ### Bug Fixes * fix: unwrapping dictionaries not working in marshaling preset (#855) * fix: import path of helpers in DartRenderer (#794) * fix: modelina cannot be used in website environments (#843) * fix: duplicate dependencies being rendered (#842) * fix: inner references not being found (#844) * fix: root level references are not handled for JSON Schema (#829) * fix: wrong typescript number type used for integers (#902) * fix: merging CommonModel properties should not carry over properties to other models (#917) * fix: duplicate and self dependencies should not be rendered (#903) * fix: python generates unusable class for empty properties (#901) * fix: javascript should not split out enums (#926) * fix: typescript marshaling preset not caring about external models (#927) * fix: typescript rendering wrong array type when union (#928) * fix: java dictionary constrainer gives unusable integer type for map value (#929) * fix: remove unintended characters for typescript marshaling preset (#935) * fix: enable processor options to be passed processors (#920) * fix: references are getting incorrect model names (#951) * fix: enum generator for Java should use strict types for it's values (#944) * fix: implicit python import error (#981) * fix: rust compile errors on enum members containing digits (#994) * fix: add `exec` as a reserved keyword for Python (#1000) * fix: c# newtonsoft preset syntax errors (#1004) * fix: rust enum renderer only working for JSON Schema inputs (#1001) * fix: dependencies are rendered twice (#1002) * fix: rust impl new fn for Boxed values (#1013) * fix: solving blackbox tests problems (#905) * fix: structs missing pub keyword in RustGenerator (#1021) * fix: reserved keywords in Rust should be case-sensitive (#1031) * fix: pattern properties not being accounted for (#1006) * fix: csharp generator does not render optional types for optional properties (#1051) * fix: polymorphic / union models rendered with index in enum member name (#1056) * fix: add Jackson annotations at the field level (#1059) * fix: improve integration with old AsyncAPI parser (#1050) * fix: add Java constraints annotations at the field level (#1067) * fix: java generator could generate illegal package names (#1084) ### Other Changes * docs: new core data model (#530) * refactor: introduce new core models (#655) * refactor: add CommonModel conversion to MetaModel (#677) * refactor: add TypeScript constrainer (#683) * refactor: add JavaScript constrainer (#693) * refactor: add Go constrainer (#695) * refactor: add splitter (#676) * refactor: add C# constrainer (#696) * refactor: add Java constrainer (#694) * refactor: simplified constraints and type mapping (#725) * refactor: convert CSharp to new constraint setup (#735) * refactor: convert Go to new constraint setup (#732) * refactor: convert TS to new constraint setup (#736) * refactor: convert JS to new constraint setup (#741) * refactor: add object property model (#758) * chore: refactored model setup to support generators (#766) * chore: refactored input processors (#767) * chore: refactored TypeScript and generator implementation (#765) * chore: refactored Java to new core model (#769) * chore: refactored Go generator (#771) * chore: refactored CSharp generator (#770) * chore: refactored JavaScript generator (#773) * chore: refactored dart generator (#778) * chore: fix build errors (#779) * chore: fix file generator tests (#782) * chore: add test and fix constrain implementation (#781) * chore: fix wrongful import (#783) * refactor: switch interpretation of pattern properties (#791) * refactor: fix constrain helpers and add test (#792) * chore: convert to any model from common model (#793) * chore: remove old post interpreter and fix tests (#795) * chore: fix TypeHelpers tests (#802) * chore: fix generator and renderer tests (#803) * chore: remove unnecessary common model test (#798) * chore: remove name helpers (#801) * chore: fix tests for OutputModel (#800) * chore: give constrained properties access to the raw property (#799) * chore: fix enum model conversion (#797) * chore: fix contains property check failing (#810) * chore: removed unused property and fix general tests (#809) * chore: refactor dart generators and test (#796) * chore: rewrite java generator tests (#804) * chore: rewrite TypeScript generator tests (#806) * chore: rewrite CSharp generator tests (#807) * chore: rewrite javascript generator tests (#805) * fix: remaining test and implementation issues (#824) * docs: move banner location (#865) * docs: update language documentation (#862) * docs: add migration guidelines (#860) * docs: update input processing documentation (#859) * docs: update constraint documentation (#858) * chore: remove unused functions (#849) * docs: update usage documentation (#857) * docs: update preset documentation (#861) * refactor: simplified example tests (#868) * chore: add a template for new generators (#850) * docs: remove duplicate dart output (#892) * test: update snapshot for failing test (#907) * chore: add a new example for json-schema-draft4-from-object (#897) * chore: add a new example for JSON schema draft 6 (#933) * ci: use @swc/jest to speedup tests (#938) * ci: fix broken release pipeline (#956) * docs: add contribution guidelines for processors (#950) * chore: add missing test dependency for docker (#992) * docs: add contributing guidelines for presets (#990) * docs: improve readme with use-cases and examples (#1034) * chore: add missing blackbox scripts (#1046) * docs: add versioning and maintenance section (#991) * test: update snapshots (#1064) * docs: fix the wrong link to constraint example (#1065) * test: added example to generate all models within the same file (#1054) * chore: added prettier config (#838) * chore: format code (#1088) Co-authored-by: Kenneth Aasan <k.aasan@sportradar.com>, Co-authored-by: Leigh Johnson <hi@leighjohnson.me>, Co-authored-by: Maciej Urbańczyk <urbanczyk.maciej.95@gmail.com>, Co-authored-by: Nitin Tejuja <95347924+nitintejuja@users.noreply.github.com>, Co-authored-by: Amit Kumar Sharma <ksamit1110@gmail.com>, Co-authored-by: artur-ciocanu <artur.ciocanu@gmail.com>, Co-authored-by: Andrey Zaytsev <zaytsevand@outlook.com>, Co-authored-by: Zbigniew Malcherczyk <zmalcherczyk@gmail.com>, Co-authored-by: Yushi OMOTE <yushiomote@gmail.com>, Co-authored-by: Alejandra Quetzalli <alejandra.quetzalli@postman.com>, Co-authored-by: Artur Ciocanu <ciocanu@adobe.com>, Co-authored-by: Julian R <mail@julianrapp.de>, Co-authored-by: Anay Sarkar <53341181+anaysarkar7@users.noreply.github.com>, Co-authored-by: Louis Xhaferi <louis.xhaferi@gmx.de>, Co-authored-by: Akshat Nema <76521428+akshatnema@users.noreply.github.com>
jonaslagoni
added a commit
that referenced
this pull request
Jan 24, 2023
## [1.0.0](v0.59.9...v1.0.0) (2023-01-23) ### Upgrade Steps You can find the migration details here: https://github.com/asyncapi/modelina/blob/master/docs/migration.md Dont hesitate to reach out if you need help migrating to version 1. ### Breaking Changes There is no specific PR that contains the breaking changes but is part of multiple PRs. See the migration part above. ### New Features * feat: add Rust Generator (#818) * feat: add Kotlin model generator (#1074) * feat: add Python generator (#863) * feat: add jsonbinpack preset for TypeScript (#854) * feat: add support for AsyncAPI 2.5 (#893) * feat: add support for oneOf and anyOf as UnionModel (#899) * feat: integrate new AsyncAPI parser version (#925) * feat: add C# Newtonsoft preset (#970) * feat: add access to entire property object in constrainer (#985) * feat: add precise csharp enum type (#1047) * feat: add dependency manager (#1063) ### Bug Fixes * fix: unwrapping dictionaries not working in marshaling preset (#855) * fix: import path of helpers in DartRenderer (#794) * fix: modelina cannot be used in website environments (#843) * fix: duplicate dependencies being rendered (#842) * fix: inner references not being found (#844) * fix: root level references are not handled for JSON Schema (#829) * fix: wrong typescript number type used for integers (#902) * fix: merging CommonModel properties should not carry over properties to other models (#917) * fix: duplicate and self dependencies should not be rendered (#903) * fix: python generates unusable class for empty properties (#901) * fix: javascript should not split out enums (#926) * fix: typescript marshaling preset not caring about external models (#927) * fix: typescript rendering wrong array type when union (#928) * fix: java dictionary constrainer gives unusable integer type for map value (#929) * fix: remove unintended characters for typescript marshaling preset (#935) * fix: enable processor options to be passed processors (#920) * fix: references are getting incorrect model names (#951) * fix: enum generator for Java should use strict types for it's values (#944) * fix: implicit python import error (#981) * fix: rust compile errors on enum members containing digits (#994) * fix: add `exec` as a reserved keyword for Python (#1000) * fix: c# newtonsoft preset syntax errors (#1004) * fix: rust enum renderer only working for JSON Schema inputs (#1001) * fix: dependencies are rendered twice (#1002) * fix: rust impl new fn for Boxed values (#1013) * fix: solving blackbox tests problems (#905) * fix: structs missing pub keyword in RustGenerator (#1021) * fix: reserved keywords in Rust should be case-sensitive (#1031) * fix: pattern properties not being accounted for (#1006) * fix: csharp generator does not render optional types for optional properties (#1051) * fix: polymorphic / union models rendered with index in enum member name (#1056) * fix: add Jackson annotations at the field level (#1059) * fix: improve integration with old AsyncAPI parser (#1050) * fix: add Java constraints annotations at the field level (#1067) * fix: java generator could generate illegal package names (#1084) ### Other Changes * docs: new core data model (#530) * refactor: introduce new core models (#655) * refactor: add CommonModel conversion to MetaModel (#677) * refactor: add TypeScript constrainer (#683) * refactor: add JavaScript constrainer (#693) * refactor: add Go constrainer (#695) * refactor: add splitter (#676) * refactor: add C# constrainer (#696) * refactor: add Java constrainer (#694) * refactor: simplified constraints and type mapping (#725) * refactor: convert CSharp to new constraint setup (#735) * refactor: convert Go to new constraint setup (#732) * refactor: convert TS to new constraint setup (#736) * refactor: convert JS to new constraint setup (#741) * refactor: add object property model (#758) * chore: refactored model setup to support generators (#766) * chore: refactored input processors (#767) * chore: refactored TypeScript and generator implementation (#765) * chore: refactored Java to new core model (#769) * chore: refactored Go generator (#771) * chore: refactored CSharp generator (#770) * chore: refactored JavaScript generator (#773) * chore: refactored dart generator (#778) * chore: fix build errors (#779) * chore: fix file generator tests (#782) * chore: add test and fix constrain implementation (#781) * chore: fix wrongful import (#783) * refactor: switch interpretation of pattern properties (#791) * refactor: fix constrain helpers and add test (#792) * chore: convert to any model from common model (#793) * chore: remove old post interpreter and fix tests (#795) * chore: fix TypeHelpers tests (#802) * chore: fix generator and renderer tests (#803) * chore: remove unnecessary common model test (#798) * chore: remove name helpers (#801) * chore: fix tests for OutputModel (#800) * chore: give constrained properties access to the raw property (#799) * chore: fix enum model conversion (#797) * chore: fix contains property check failing (#810) * chore: removed unused property and fix general tests (#809) * chore: refactor dart generators and test (#796) * chore: rewrite java generator tests (#804) * chore: rewrite TypeScript generator tests (#806) * chore: rewrite CSharp generator tests (#807) * chore: rewrite javascript generator tests (#805) * fix: remaining test and implementation issues (#824) * docs: move banner location (#865) * docs: update language documentation (#862) * docs: add migration guidelines (#860) * docs: update input processing documentation (#859) * docs: update constraint documentation (#858) * chore: remove unused functions (#849) * docs: update usage documentation (#857) * docs: update preset documentation (#861) * refactor: simplified example tests (#868) * chore: add a template for new generators (#850) * docs: remove duplicate dart output (#892) * test: update snapshot for failing test (#907) * chore: add a new example for json-schema-draft4-from-object (#897) * chore: add a new example for JSON schema draft 6 (#933) * ci: use @swc/jest to speedup tests (#938) * ci: fix broken release pipeline (#956) * docs: add contribution guidelines for processors (#950) * chore: add missing test dependency for docker (#992) * docs: add contributing guidelines for presets (#990) * docs: improve readme with use-cases and examples (#1034) * chore: add missing blackbox scripts (#1046) * docs: add versioning and maintenance section (#991) * test: update snapshots (#1064) * docs: fix the wrong link to constraint example (#1065) * test: added example to generate all models within the same file (#1054) * chore: added prettier config (#838) * chore: format code (#1088) Co-authored-by: Kenneth Aasan <k.aasan@sportradar.com> Co-authored-by: Leigh Johnson <hi@leighjohnson.me> Co-authored-by: Maciej Urbańczyk <urbanczyk.maciej.95@gmail.com> Co-authored-by: Nitin Tejuja <95347924+nitintejuja@users.noreply.github.com> Co-authored-by: Amit Kumar Sharma <ksamit1110@gmail.com> Co-authored-by: artur-ciocanu <artur.ciocanu@gmail.com> Co-authored-by: Andrey Zaytsev <zaytsevand@outlook.com> Co-authored-by: Zbigniew Malcherczyk <zmalcherczyk@gmail.com> Co-authored-by: Yushi OMOTE <yushiomote@gmail.com> Co-authored-by: Alejandra Quetzalli <alejandra.quetzalli@postman.com> Co-authored-by: Artur Ciocanu <ciocanu@adobe.com> Co-authored-by: Julian R <mail@julianrapp.de> Co-authored-by: Anay Sarkar <53341181+anaysarkar7@users.noreply.github.com> Co-authored-by: Louis Xhaferi <louis.xhaferi@gmx.de> Co-authored-by: Akshat Nema <76521428+akshatnema@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
This PR updates the usage documentation to add specifics about the limitations of inputs.