fix: pass default openapi object to any case #1105
Merged
+129
−1
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
starfy84
force-pushed
the
DX-2582-pass-jsdoc-descriptions
branch
from
133ca05 to
cb82337
Compare
Ticket: DX-2582 This commit passes the defaultOpenAPIObject to the any case. This allows for us to not drop the jsdoc information on t.any types. It is valid openapi to have descriptions and other metadata on any types: https://swagger.io/docs/specification/v3_0/data-models/data-types/#any-type From the following slack thread: https://bitgo.slack.com/archives/C057BHBRG4B/p1765481932730759 \# Test Tested in `entity-validation`: ``` $ > diff test.json test2.json 3123,3137c3123,3125 < "frontPhoto": { < "description": "Front photo of the identity document", < "example": "\"passport-front.jpg\"", < "format": "binary" < }, < "backPhoto": { < "description": "Back photo of the identity document", < "example": "\"drivers-license-back.png\"", < "format": "binary" < }, < "proofOfResidency": { < "description": "Proof of residency", < "example": "\"rental-lease.pdf\"", < "format": "binary" < } --- > "frontPhoto": {}, > "backPhoto": {}, > "proofOfResidency": {} 3264,3278c3252,3254 < "frontPhoto": { < "description": "Front photo of the identity document", < "example": "\"passport-front.jpg\"", < "format": "binary" < }, < "backPhoto": { < "description": "Back photo of the identity document", < "example": "\"drivers-license-back.png\"", < "format": "binary" < }, < "proofOfResidency": { < "description": "Proof of residency", < "example": "\"rental-lease.pdf\"", < "format": "binary" < } --- > "frontPhoto": {}, > "backPhoto": {}, > "proofOfResidency": {} ```
starfy84
force-pushed
the
DX-2582-pass-jsdoc-descriptions
branch
from
cb82337 to
942cc2f
Compare
ericcrosson-bitgo
approved these changes
Dec 16, 2025
Contributor
ericcrosson-bitgo
left a comment
ericcrosson-bitgo
left a comment
There was a problem hiding this comment.
Love the ratio of test code to prod code (100:1 !)
Thanks @starfy84 🚀
|
Thanks for this change @starfy84 🚀 |
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.
Ticket: DX-2582
This commit passes the defaultOpenAPIObject to the any case. This allows for us to not drop the jsdoc information on t.any types.
It is valid openapi to have descriptions and other metadata on any types: https://swagger.io/docs/specification/v3_0/data-models/data-types/#any-type
From the following slack thread: https://bitgo.slack.com/archives/C057BHBRG4B/p1765481932730759
Test
Tested in
entity-validation(test2.jsonis before the changes)