docs: add free form properties schema type #3555
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
ndr-brt
added
documentation
ndr-brt
force-pushed
the
3552-additional-properties
branch
from
446eecb to
5c0a6c3
Compare
paullatzelsperger
approved these changes
Oct 20, 2023
wolf4ood
approved these changes
Oct 20, 2023
Codecov ReportAttention:
❗ Your organization needs to install the Codecov GitHub app to enable full functionality. Additional details and impacted files@@ Coverage Diff @@
## main #3555 +/- ##
==========================================
- Coverage 72.49% 72.49% -0.01%
==========================================
Files 877 877
Lines 17473 17474 +1
Branches 994 994
==========================================
Hits 12667 12667
- Misses 4390 4391 +1
Partials 416 416
☔ View full report in Codecov by Sentry. |
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.
What this PR changes/adds
Adds the
FreeFormPropertiesSchematype for openapi documentationWhy it does that
It will better describe the properties field, that are not strictly
string -> object, butstring -> any(in java there's no difference, but in the openapi domain there is)Further notes
List other areas of code that have changed but are not necessarily linked to the main feature. This could be method
signature changes, package declarations, bugs that were encountered and were fixed inline, etc.
Linked Issue(s)
Also part of #3552
Please be sure to take a look at the contributing guidelines and our etiquette for pull requests.