[Fix] Accept additional properties in API JSON responses #95
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
jhamon
force-pushed
the
jhamon/regen-openapi
branch
from
37ccd55 to
d9222ac
Compare
austin-denoble
approved these changes
Apr 6, 2024
| @@ -0,0 +1,116 @@ | |||
| package org.openapitools.client; | |||
There was a problem hiding this comment.
I know this issue basically forces it, but good idea for adding a testing section focused on some of the generated bits. 👍
| "status": { | ||
| "ready": true, | ||
| "state": "Ready", | ||
| "reticulating_splines": true |
jhamon
added a commit
that referenced
this pull request
Apr 9, 2024
When new properties are added to API responses, this causes the Java client to error. This prevents us from making additive API changes that would otherwise be non-breaking to the end user. - Add tests that exercise the JSON parsing behavior in `src/test/java/org/openapitools/client/JsonParsingTest.java` and ensure the presence of additional properties will not cause the SDK to error. These tests use JSON fixtures added in `src/test/resources`. - Regenerate the control plane rest client using the OpenAPI [java client generator](https://openapi-generator.tech/docs/generators/java/). This time, configuring the generator with `disallowAdditionalPropertiesIfNotPresent=false` should activate the correct JSON parsing behavior in the generated code. The code generation step was performed with this command: ```bash mkdir codegen mkdir codegen/gen cd codegen docker run --rm -v $(pwd):/workspace openapitools/openapi-generator-cli:v7.0.1 generate \ --input-spec $SPEC_FILE \ --additional-properties=dateLibrary='java8',disallowAdditionalPropertiesIfNotPresent=false \ --generator-name java \ --output /workspace/gen/java rm -rf ../src/main/java/org/openapitools/client cp -r gen/java/src/main/java/org/openapitools/client ../src/main/java/org/openapitools/client ``` It took some trial and error to discover an openapi generator version and spec version that produced similar results to the ones Rohan created previously using steps and commands that were not captured anywhere. These steps will be scripted and automated in a future PR to remove this element of guesswork. - [x] Bug fix (non-breaking change which fixes an issue) Since the new tests exercise all the generated code up to the boundary where a response is returned from the okhttp library used for making requests, that gives a high confidence this will work if unexpected fields appear in future API responses.
jhamon
added a commit
that referenced
this pull request
Apr 9, 2024
When new properties are added to API responses, this causes the Java client to error. This prevents us from making additive API changes that would otherwise be non-breaking to the end user. - Add tests that exercise the JSON parsing behavior in `src/test/java/org/openapitools/client/JsonParsingTest.java` and ensure the presence of additional properties will not cause the SDK to error. These tests use JSON fixtures added in `src/test/resources`. - Regenerate the control plane rest client using the OpenAPI [java client generator](https://openapi-generator.tech/docs/generators/java/). This time, configuring the generator with `disallowAdditionalPropertiesIfNotPresent=false` should activate the correct JSON parsing behavior in the generated code. The code generation step was performed with this command: ```bash mkdir codegen mkdir codegen/gen cd codegen docker run --rm -v $(pwd):/workspace openapitools/openapi-generator-cli:v7.0.1 generate \ --input-spec $SPEC_FILE \ --additional-properties=dateLibrary='java8',disallowAdditionalPropertiesIfNotPresent=false \ --generator-name java \ --output /workspace/gen/java rm -rf ../src/main/java/org/openapitools/client cp -r gen/java/src/main/java/org/openapitools/client ../src/main/java/org/openapitools/client ``` It took some trial and error to discover an openapi generator version and spec version that produced similar results to the ones Rohan created previously using steps and commands that were not captured anywhere. These steps will be scripted and automated in a future PR to remove this element of guesswork. - [x] Bug fix (non-breaking change which fixes an issue) Since the new tests exercise all the generated code up to the boundary where a response is returned from the okhttp library used for making requests, that gives a high confidence this will work if unexpected fields appear in future API responses.
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.
Problem
When new properties are added to API responses, this causes the Java client to error. This prevents us from making additive API changes that would otherwise be non-breaking to the end user.
Solution
src/test/java/org/openapitools/client/JsonParsingTest.javaand ensure the presence of additional properties will not cause the SDK to error. These tests use JSON fixtures added insrc/test/resources.disallowAdditionalPropertiesIfNotPresent=falseshould activate the correct JSON parsing behavior in the generated code.How the code was generated
The code generation step was performed with this command:
It took some trial and error to discover an openapi generator version and spec version that produced similar results to the ones Rohan created previously using steps and commands that were not captured anywhere. These steps will be scripted and automated in a future PR to remove this element of guesswork.
Type of Change
Test Plan
Since the new tests exercise all the generated code up to the boundary where a response is returned from the okhttp library used for making requests, that gives a high confidence this will work if unexpected fields appear in future API responses.