Fix synthetic schema naming #695
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
srchase
requested review from
mtdowling and
JordonPhillips
and removed request for
mtdowling
JordonPhillips
requested changes
Jan 27, 2021
| String pointer = context.putSynthesizedSchema(synthesizedName, schema); | ||
| MediaTypeObject mediaTypeObject = MediaTypeObject.builder() | ||
| .schema(Schema.builder().ref(pointer).build()) | ||
| .build(); | ||
|
|
||
| responseBuilder.putContent(mediaType, mediaTypeObject); | ||
| } | ||
|
|
||
| private String stripNonAlphaNumericCharsIfNecessary(Context<T> context, String name) { | ||
| return context.getConfig().getAlphanumericOnlyRefs() |
There was a problem hiding this comment.
Gonna want to at least log an info / warning here saying what's happening
There was a problem hiding this comment.
Added logging in cd8a781.
| InputStream openApiStream = getClass().getResourceAsStream(openApiModel); | ||
|
|
||
| if (openApiStream == null) { | ||
| LOGGER.warning("OpenAPI model not found for test case: " + openApiModel); |
There was a problem hiding this comment.
you should fail the test here
There was a problem hiding this comment.
I updated all the cases to fail in 5333705.
JordonPhillips
approved these changes
Jan 28, 2021
| : name; | ||
| String alphanumericOnly = NON_ALPHA_NUMERIC.matcher(name).replaceAll(""); | ||
| if (context.getConfig().getAlphanumericOnlyRefs() && !alphanumericOnly.equals(name)) { | ||
| LOGGER.info("Removing non-alphanumeric characters from " + name); |
There was a problem hiding this comment.
This should say why you're doing that
Merged
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.
Some vendors, including Amazon API Gateway, require that shape names are alphanumeric only.
This PR assures that the synthesized
ResponseContentandRequestContentshapes have alphanumeric names when thealphanumericOnlyRefsconfiguration setting has been set totrue, as withsmithy-aws-apigateway-openapi. The descriptions on schemas are updated to match when non-alphanumeric characters have been removed.By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.