refactor and fix references handling #2849
Merged
Conversation
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
Kortanul
added a commit
to Kortanul/wrensec-commons
that referenced
this pull request
Nov 30, 2018
- `OpenApiTransformerTest.testBuildModel()` was revised to address two issues:
- The way that exceptions were being tested was inadvertently squelching legitimate exceptions that might crop-up during the test, since it was catching `Exception` but only handling the exception if the data provider indicated an exception was expected. This has been re-written to use `assertThatExceptionOfType()` instead.
- The way that models were being compared no longer worked after the update to Swagger 1.5.21. The "actual" and "expected" model instances can't be compared with `equals()` because Swagger changed the equality comparison rules in such a way that the models are no longer 100% equivalent. Instead, we have to compare the two models via their JSON representation.
Specifically, Swagger now takes the `originalRef` field into account in the `equals()` method of `GenericRef`. For the "expected" model, the `originalRef` is `"urn:jsonschema:org:forgerock:api:transform:PojoInner"` but for the "actual" model, it is `"#/definitions/urn:jsonschema:org:forgerock:api:transform:PojoInner"`.
For more details, see: swagger-api/swagger-core#2849
- Per notes in swagger-api/swagger-core#2944, JacksonUtils has been modified to use Swagger's own `Json.mapper()` factory method instead of constructing the `ObjectMapper` itself. Among other things, this ensures that `WRITE_DATES_AS_TIMESTAMPS` is off by default, and prevents the `originalRef` field from appearing in JSON schema output.
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.
This PR addresses issues related to "reference items" instantiation, serialization and resolving, triggered originally by swagger-api/swagger-parser/issues/727 and swagger-api/swagger-parser/issues/713; it would replace #2847
It updates related code mainly:
originalRefgetter in "reference items" (e.g.RefModel,RefProperty, etc)originalRefmapped to$refJSON property via MixIn or addedReferenceSerializationConfigurerhelper classGenericRef.internalRefWithAnyDot()please see tests added in PR for some examples.