improvement: update 'any object' examples to be flatter #4083
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
dsinghvi
reviewed
Jul 19, 2024
| @@ -596,25 +588,17 @@ Creates a new document index.", | |||
| { | |||
| "key": { | |||
| "type": "string", | |||
| "value": "indexing_config", | |||
| "value": "key", | |||
There was a problem hiding this comment.
any thoughts on why the value here is now key ?
There was a problem hiding this comment.
Chatted offline, but this was similarly intentional for the same reason as the other comment! And since these are the example TRs, this is what we wanna see
dsinghvi
reviewed
Jul 19, 2024
| @@ -974,11 +974,11 @@ exports[`generate IR from OpenAPI 1`] = ` | |||
| "map": [ | |||
| { | |||
| "key": { | |||
| "jsonExample": "custom_fields", | |||
| "jsonExample": "key", | |||
There was a problem hiding this comment.
similar issue here with custom_fields -> key
There was a problem hiding this comment.
This one's intentional, it's outlined at the end of the pr body, but since it was {"custom_fields": "custom_fields"} I updated to {"key": "value"}
amckinney
approved these changes
Jul 19, 2024
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.
Previously, we'd create nested objects if we received an
any objecte.g. an unknown value we're binding to an object (since we make thosemap<string, unknown>).Those generated examples would become:
"object": {"object": {"key": "value"}}, now we short circuit the example generation to special casemap<string, unknown>to just return{"key": "value"}, making the above now"object": {"key": "value"}As a bonus I also changed the map key and value generation to fall back to "key" and "value" as opposed to the field name which led to some awkward examples like
{"custom_fields": "custom_fields" }seen below