Skip to content

v3.3: remove invalid mention of prefixEncoding, itemEncoding here#5441

Open
karenetheridge wants to merge 2 commits into
OAI:v3.3-devfrom
karenetheridge:ether/invalid-prefixEncoding
Open

v3.3: remove invalid mention of prefixEncoding, itemEncoding here#5441
karenetheridge wants to merge 2 commits into
OAI:v3.3-devfrom
karenetheridge:ether/invalid-prefixEncoding

Conversation

@karenetheridge

Copy link
Copy Markdown
Member

In section 4.14.5.2 (Encoding by Position) we already said: "To use the prefixEncoding and/or itemEncoding fields, either itemSchema or a schema indicating an array type MUST be present.", however there is no parallel guidance in 4.14.5.1 (Encoding by Name) that says that the encoding field MUST also have a schema indicating an object type present.

(I already edited this sentence earlier in this release cycle to add mention of prefixEncoding alongside itemEncoding, but this entire sentence is inconsistent with the previous section, so we should either remove this sentence entirely, or soften the previous statement about prefixEncoding and itemEncoding requiring an array schema.)

  • no schema changes are needed for this pull request

@karenetheridge
karenetheridge requested review from a team as code owners July 20, 2026 22:48
@karenetheridge karenetheridge changed the title remove invalid mention of prefixEncoding, itemEncoding here v3.3: remove invalid mention of prefixEncoding, itemEncoding here Jul 20, 2026
@karenetheridge
karenetheridge force-pushed the ether/invalid-prefixEncoding branch from 7cc6e85 to 82fb935 Compare July 21, 2026 00:21

@karenetheridge karenetheridge left a comment

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

some extra commentary here as I keep re-reading various sections of the spec and noticing inconsistencies between them, or things that we mandate without a clear reason for doing so.

Comment thread src/oas.md
Comment thread src/oas.md
Comment thread src/oas.md
@karenetheridge

Copy link
Copy Markdown
Member Author

I would like to determine if this can be backported to 3.2.1. I would argue it should, as it is a simplification in both understanding and implementation, and not an imposition of new requirements. (I am also not aware of anyone having implemented prefixEncoding/itemEncoding yet, either, so fixing this now makes everything nicer).

handrews
handrews previously approved these changes Jul 27, 2026
In section 4.14.5.2 (Encoding by Position) we already said: "To use the
prefixEncoding and/or itemEncoding fields, either itemSchema or a schema
indicating an array type MUST be present.", however there is no parallel
guidance in 4.14.5.1 (Encoding by Name) that says that the encoding field MUST
also have a schema indicating an object type present.
This is the same phrasing as in "Encoding by Name" which states that the
`encoding` fields do nothing if they don't have a corresponding data
instance.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants