Skip to content

v3.2: Clarify JSON-compatible YAML - #4758

Merged
lornajane merged 2 commits into
OAI:v3.2-devfrom
handrews:yaml
Jul 19, 2025
Merged

v3.2: Clarify JSON-compatible YAML#4758
lornajane merged 2 commits into
OAI:v3.2-devfrom
handrews:yaml

Conversation

@handrews

@handrewshandrews commented Jul 4, 2025

Copy link
Copy Markdown
Member

I'm stuck at home bored and getting over a cold, so have a PR as I distract myself from missing holiday plans!

This fixes:

Everything in this area is a RECOMMENDED (== SHOULD) so we have some leeway. I have tightened what is recommended but acknowledged previous guidance and simply said that depending on anything allowed by the old guidance but not by the new is NOT RECOMMENDED. I suspect most tools never even noticed, TBH.

  • no schema changes are needed for this pull request

@handrewshandrews added this to the v3.2.0 milestone Jul 4, 2025
@handrews
handrews requested review from a team as code ownersJuly 4, 2025 19:10
@handrewshandrews added the clarification requests to clarify, but not change, part of the spec label Jul 4, 2025
mikekistler
mikekistler previously approved these changes Jul 4, 2025

@mikekistlermikekistler left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. 👍

Comment threadsrc/oas.md Outdated
@handrews

Copy link
Copy Markdown
MemberAuthor

After further discussions with @hudlow the character set stuff may not be needed regarding the Example Object, so it's worth considering whether that part needs to be here at all, or whether what's in the JSON and YAML RFCs is sufficient (it probably is).

We don't really need the stuff about character encodings, as it
was there because I was confused about something else.
Also minimize the explanation of the change.
@handrewshandrews changed the title v3.2: Clarify JSON-compatible YAML and UTF-8 usev3.2: Clarify JSON-compatible YAMLJul 5, 2025
@handrews

Copy link
Copy Markdown
MemberAuthor

@hudlow@mikekistler I have removed the bit about character encodings (it is truly not needed, after getting a night of sleep- I've been under the weather, please forgive the confusion) and have slimmed down the explanation as much as I can while still conveying that there's a bit of a danger zone that was technically previously recommended, but was never really intended to work.

@ralfhandl
ralfhandl requested review from a team and mikekistlerJuly 13, 2025 14:09

@mkistlermkistler left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! 👍

@handrews

Copy link
Copy Markdown
MemberAuthor

@mkistler@mikekistler GitHub won't let me merge unless you approve as @mikekistler

@lornajanelornajane left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Indeed, much clearer

@lornajane
lornajane self-requested a review July 19, 2025 17:02
@lornajane
lornajane merged commit 00dbb5d into OAI:v3.2-devJul 19, 2025

@mikekistlermikekistler left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. 👍

Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

clarificationrequests to clarify, but not change, part of the spec

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants

@handrews@lornajane@mkistler@ralfhandl@hudlow@mikekistler