v3.2: Only use YAML for examples #4577
Merged
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
We still use JSON for example payloads, and there is one example in Appendix F that discusses retrieving OADs by content type, so those continue to show JSON. Also standardize on lowercase language names for fenced code blocks, as that was more common (I think the uppercase ones were mostly added by me).
ralfhandl
requested changes
May 15, 2025
|
@ralfhandl that's not what I recall being discussed, and it would be work that I don't really have bandwidth for to figure out which should be which and go back and change it. I also just disagree in general- people can figure out JSON from YAML and JSON wastes space. Also, Appendix F does show both and discusses retrieval strategies for supporting both media types. |
ralfhandl
approved these changes
May 15, 2025
|
@ralfhandl if later on you want to switch some to JSON to balance it out, I definitely will not object. But I appreciate being able to reduce the duplication for now as a first step. Thank you for the approval! 🙏 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
IIRC, we discussed a while ago that we don't need both JSON and YAML examples. And there are many examples now that are only shown in YAML. This standardizes on YAML for all OAD examples. In addition to cutting down on the ever-growing length of the spec, I find this more readable when there are a bunch of examples in a row, as you're not constantly skipping over duplicates.
We still use JSON for example payloads, and there is one example in Appendix F that discusses retrieving OADs by content type, so those continue to show JSON.
Also standardize on lowercase language names for fenced code blocks, as that was more common (I think the uppercase ones were mostly added by me).