Correct invalid example in management service OpenAPI spec #2801
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.
The
examplewas incorrectly placed as a sibling of$refwithin aschemaobject inpolaris-management-service.yml. According to the OpenAPI specification, properties that are siblings of a$refare ignored.This was causing a
NullPointerExceptionin OpenAPI Generator v7.13.0+ due to a change in how examples are processed. The generator now expects allexamplesto be valid and non-empty, and a misplacedexamplecan lead to a null reference when the generator tries to access it (we are not yet using v7.13.0+, thus not a problem at the moment).This commit moves the
exampleto be a sibling of theschemaobject, which is the correct placement according to the OpenAPI specification.Reference error when using newer version of openapi-generator-cli: