Skip to content

v3.3: Add a global parameters field#5446

Open
handrews wants to merge 1 commit into
OAI:v3.3-devfrom
handrews:global-params
Open

v3.3: Add a global parameters field#5446
handrews wants to merge 1 commit into
OAI:v3.3-devfrom
handrews:global-params

Conversation

@handrews

Copy link
Copy Markdown
Member

Fixes #5320 : Add global parameters field without changing any of the ways in which parameters behave at different levels.

This is the simplest expansion, and should support known use cases like universal request headers or cookies.

This feature does not interact productively with in: querystring, and that should be fine for now. We can add complexity there if and when clear use cases emerge. It is not even entirely clear how common a global in: query parameter (which would prevent use of in: querystring everywhere) would be.

Global path parameters would also be odd, but could be used somewhat like Server Variables. The oddness of them does not seem sufficient reason to forbid them, although I could be persuaded given that they would not be clearly associated with any one path template.

  • schema changes are included in this pull request
  • schema changes are needed for this pull request but not done yet
  • no schema changes are needed for this pull request

This just adds the field without any special handling.
It is already possible with the Path Item Object's parameters
field to specify parameters that don't make sense for all
of the operations, and we don't attempt to compensate for
it.

The only truly new situation is that there is no one path
to which path parameters would correspond.  I suspect that
global path parameters will be rare, and mostly used in a
prefix as more powerful analogues of Server Variables.
@handrews
handrews marked this pull request as ready for review July 25, 2026 19:39
@handrews
handrews requested review from a team as code owners July 25, 2026 19:39
@handrews handrews changed the title Add a global parameters field v3.3: Add a global parameters field Jul 25, 2026
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.

1 participant