Remove abused allOf from OpenAPI v3 spec #319
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
chrisgacsal
previously approved these changes
May 24, 2023
ghost
force-pushed
the
fix_empty_interfaces_in_api
branch
2 times, most recently
from
721c4ee
to
e7b3cef
Compare
akpsgit
previously approved these changes
May 24, 2023
chrisgacsal
previously approved these changes
May 24, 2023
This commit removes the allOf from several objects in the openapi spec where properties of those fields needed to be overridden. Instead those fields are replicated between the object schemas. Unfortunately this does increase the maintainance requirement as schemas like ScanConfig and ScanConfigRelationship need to be kept in sync, but this ensures that the code generation understands the field typing correctly so that it can be used in the code properly.
ghost
force-pushed
the
fix_empty_interfaces_in_api
branch
from
e7b3cef
to
9dd9669
Compare
chrisgacsal
approved these changes
May 24, 2023
This pull request was closed.
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.
Description
This commit removes the allOf from several objects in the openapi spec where properties of those fields needed to be overridden. Instead those fields are replicated between the object schemas.
Unfortunately this does increase the maintenance requirement as schemas like ScanConfig and ScanConfigRelationship need to be kept in sync, but this ensures that the code generation understands the field typing correctly so that it can be used in the code properly.
Type of Change
[ ] Bug Fix
[ ] New Feature
[ ] Breaking Change
[X] Refactor
[ ] Documentation
[ ] Other (please describe)
Checklist