SIGN IN SIGN UP

Consolidate guidance around examples (3.0.4) (#3893)

* Consolidate guidance around examples

The three (four in 3.1) ways of specifying parameter or media type
examples are confusing. There is a lot of guidance that is repeated,
making it harder to see the essentials.  Some of that guidance is
also contradictory, with most saying that the examples SHOULD
match various conditions, but one saying that they MUST.

Research shows that SHOULD was repeatedly advocated, and instances
of MUST corrected back to SHOULD, except for one final commit
where MUST was introduced, and the subsequent commit to revert
to SHOULD seems to have simply missed one instance.  So this
change takes the position that the MUST was an error and weakens
it to SHOULD to match the other four or five places where the
requirement was specified.

* Fix typo in examples changes
H
Henry Andrews committed
d3e02386ac195d706ce575c23c6e893506e71291
Parent: 82fe810
Committed by GitHub <noreply@github.com> on 6/9/2024, 10:02:59 PM