v3.3: cleanup: removed json-style format from yaml examples#5301
v3.3: cleanup: removed json-style format from yaml examples#5301karenetheridge wants to merge 1 commit intoOAI:v3.3-devfrom
Conversation
...and fixed a deprecated "value" in an example
karenetheridge
changed the title
|
I did all of that on purpose. I'm not going to fight over it, but it was intentional to make it feel more JSON-like for JSON examples. |
| petType: Cat | ||
| color: White | ||
| gender: male | ||
| breed: Persian |
There was a problem hiding this comment.
The immediately preceding text no longer makes sense...
Alternatively, since all JSON is valid YAML, the example value can use JSON syntax within a YAML document
... since the example value now does not use JSON syntax
| "title": "An Older Book", | ||
| "rating": 4.5 | ||
| } | ||
| serializedValue: {"author":"A. Writer","title":"An Older Book","rating":4.5} |
There was a problem hiding this comment.
this changes serializedValue from a string to a json object, does not look correct
|
It's not touched by this PR, but related - I notice that https://spec.openapis.org/oas/v3.2.0.html#json-examples says "When writing in YAML, JSON syntax can be used for |
3 participants
...and fixed a deprecated "value" in an example