Move swagger param description creation under generator/swagger/param_description
#810
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
PanosCodes
force-pushed
the
swagger-param-description-builder
branch
from
5757703 to
2ddf301
Compare
PanosCodes
changed the title
generator/swagger
PanosCodes
force-pushed
the
swagger-param-description-builder
branch
8 times, most recently
from
2f9d697 to
f2bdaf1
Compare
instead of `OpenStruct` Instead of creating an OpenStruct the mimics `ParamDescription` it creates a `ParamDescription` that is marked as `required` and has in it's options the information that is created from path (`added_from_path`) and not from the DSL.
- Introduces `Apipie::Generator::Swagger::ParamDescription::Composite` for nested param descritpions, that recursively loops though it's children. Replaces the `json_schema_obj_from_params_array` & `json_schema_param_defs_from_params_array` with `Apipie::Generator::Swagger::ParamDescription::Composite` - Introduces `Apipie::Generator::Swagger::ParamDescription::Builder` that provides a builder interface responsible for constructing the Swagger parameters. Replaces the `swagger_atomic_param` method with `Apipie::Generator::Swagger::ParamDescription::Builder` Swagger parameters that have some king of logic like `description`, `in`, `name`, `type`, `items` & `enum` live under their respected classes - `Apipie::Generator::Swagger::ParamDescription::Description` - `Apipie::Generator::Swagger::ParamDescription::In` - `Apipie::Generator::Swagger::ParamDescription::Name` - `Apipie::Generator::Swagger::ParamDescription::Type` (This one also handles `items` & `enum` attributes) and get instantiated through the `Apipie::Generator::Swagger::ParamDescription::Builder` api.
PanosCodes
force-pushed
the
swagger-param-description-builder
branch
from
f2bdaf1 to
233ff9b
Compare
PanosCodes
changed the title
generator/swaggergenerator/swagger/param_description
| @@ -434,105 +430,14 @@ def add_missing_params(method, path) | |||
|
|
|||
| missing.each do |name| | |||
| warn_path_parameter_not_described(name, path) | |||
| result[name.to_sym] = OpenStruct.new({ | |||
There was a problem hiding this comment.
Always happy to see an OpenStruct being removed
It's meant to be an internal implementation for swagger generator, maybe once the refactor is done we could have a |
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.
Why
I'm woking on PR to make generators pluggable and allow external generators to be used by apipie.
This PR refactors and moves the param description generation under
lib/apipie/generator/swagger/param_description/namespace.How
Introduced
Apipie::Generator::Swagger::ParamDescription::CompositeNested
ParamDescritpions likeare converted to swagger by
Apipie::Generator::Swagger::ParamDescription::Compositethat recursively loops though it's children.json_schema_obj_from_params_arrayandjson_schema_param_defs_from_params_arrayreplaced byApipie::Generator::Swagger::CompositeIntroduced
Apipie::Generator::Swagger::ParamDescription::Builderswagger_atomic_paramreplaced byApipie::Generator::Swagger::ParamDescription::Builderthat provides an interface responsible for constructing the Swagger parameters.ParamDescription Swagger parameters
Swagger parameters that have some king of logic like
description,in,name,type,items,enumlive under their respected classes
Apipie::Generator::Swagger::ParamDescription::DescriptionApipie::Generator::Swagger::ParamDescription::InApipie::Generator::Swagger::ParamDescription::NameApipie::Generator::Swagger::ParamDescription::Type(This one also handlesitems&enumattributes)and get instantiated through the
Apipie::Generator::Swagger::ParamDescription::Builder's api.Missing attributes
Instead of creating an
OpenStructthe mimicsParamDescriptionwe create aParamDescriptionfrom that is required and has in it's options the information that is created from path (added_from_path) and not from the DSL. (ParamDescription.create_for_missing_param)Final thoughts
Although this PR adds more lines than it removes, I think it makes it easer to navigate the generator code by having different classes for different responsibilities.