v3.1+: Should we change how non-schema examples "override" schema examples? #4664
Labels
example obj/keywords
Issues with the Example Object or exampel(s) keywords
Milestone
@mikekistler noticed the text that (since at least 3.0) has said that examples outside of the Schema Object "override" examples inside of it, and questioned why it should be there.
I think it has to do with the original purpose of the various fields. In this table, I use the PR #4647 field names to describe the intended purpose and actual implementation:
example
dataValue
dataValue
examples
dataValue
dataValue
example
serializedValue
(but inline if representable in JSONdataValue
but not always?value
serializedValue
(but inline if representable in JSONdataValue
but not always?externalValue
externalSerializedValue
(but inline if representable in JSONdataValue
but not always?So I think "override" just meant "the serialized version is what you actually send/receive", not "the Schema example is wrong and the other example is right."
So maybe there is a clarification of wording there?
The text was updated successfully, but these errors were encountered: