Add support for OpenAPI schema generation#231
Open
zZHorizonZz wants to merge 1 commit intoeclipse-vertx:mainfrom
Open
Add support for OpenAPI schema generation#231zZHorizonZz wants to merge 1 commit intoeclipse-vertx:mainfrom
zZHorizonZz wants to merge 1 commit intoeclipse-vertx:mainfrom
Conversation
8757ca5 to
7873045
Compare
7873045 to
d72671b
Compare
Motivation: Enable enhanced flexibility in OpenAPI schema generation by allowing users to provide a custom YAML/JSON configuration file for overriding and merging API specification details like metadata, servers, security, and tags. Changes: - Added a `schema-config` option in `GenerationOptions` to specify the OpenAPI configuration file path. - Updated `SchemaModelBuilder` to merge generated schemas with user-provided configuration values. - Introduced `SchemaConfigLoader` for loading and parsing configuration files. - Enhanced `SchemaGenerator` to handle schema customization during the generation process. - Updated documentation with examples for using the `schema-config` option. - Added integration tests to verify the functionality of schema customization using configuration files. - Refactored relevant classes and methods to support the new feature. Signed-off-by: Daniel Fiala <danfiala23@gmail.com>
d72671b to
4b7cb32
Compare
This file contains hidden or 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
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.
Motivation:
Add OpenAPI schema generation for enhanced transcoding use, as at the moment users would need to create schema themselves or use not java friendly generator plugin.
Changes:
schema-configoption inGenerationOptionsto specify the OpenAPI configuration file path.SchemaModelBuilderto merge generated schemas with user-provided configuration values.SchemaConfigLoaderfor loading and parsing configuration files.SchemaGeneratorto handle schema customization during the generation process.schema-configoption.