Change additionalProperties default #612
Merged
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
drwpow
commented
May 25, 2021
| required: Object.keys(schema), | ||
| version, | ||
| })}\n}`; | ||
| output.definitions = transformSchemaObjMap(schema, { ...ctx, required }); |
There was a problem hiding this comment.
Changing transformAll()’s default output to be an object rather than a string is required for the upcoming #602. But I wanted to get that change in before we release v4, so that v3 patches will be easier to work on (less codebase distance between v3 and v4)
Codecov Report
@@ Coverage Diff @@
## main #612 +/- ##
==========================================
+ Coverage 88.53% 90.15% +1.61%
==========================================
Files 9 10 +1
Lines 349 386 +37
Branches 123 140 +17
==========================================
+ Hits 309 348 +39
- Misses 37 38 +1
+ Partials 3 0 -3
Continue to review full report at Codecov.
|
Merged
gr2m
added a commit
to octokit/openapi-types.ts
that referenced
this pull request
May 28, 2021
1 task
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.
Resolves #607. A recent change (#585) allowed for the automatic addition of additional properties, so
& { [key: string]: any }was added to all schema objects. The intent was to better reflect OpenAPI’s specification, and there is precedent for that. However, based on feedback, and previous expectations this library set, it was a little too disruptive.And so, this PR reverts that behavior, turning this off by default
, but adding a new--additional-properties` flag to enable this behavior (outlined in the README). This is a good compromise of allowing that behavior, but requiring it to be opt-in (which is also probably better to be stricter by default).