OpenAPI-Specification icon indicating copy to clipboard operation
OpenAPI-Specification copied to clipboard

Make patch optional in openapi field.

Open handrews opened this issue 5 months ago • 11 comments

See discussion #4233 and issue #4147. Requiring the patch version is creating tremendous amounts of confusion. While we cannot seem to reach consensus on forbidding it, there has long been a consensus on not requiring it. Let's at least do that.

Also, the regex in the schema allowed for -something in the openapi field, which is not part of the OAS field definition at all so I removed it. We used to do -rcN releases, but we have no plan to do so for 3.2 anyway, and we ought not further overload an already confusing mechanism. If we need to note a pre-release version in the future, let's add a field for it.

  • [X] schema changes are included in this pull request

handrews avatar Sep 08 '25 15:09 handrews

I am not in favour of introducing this change for 3.2 and delaying the release again. This is not a review of the change, but a logistical point. Please do not introduce changes for 3.2, and instead target this for 3.3 and we can review it there.

lornajane avatar Sep 08 '25 15:09 lornajane

@lornajane this is not a delay. There is a simple change that we had consensus on at one point. The amount of problems this is causing right now is worth the completely trivial amount of work to merge this PR.

handrews avatar Sep 08 '25 16:09 handrews

PLEASE DON'T MERGE this until the discussion on the relevant issues has concluded.

karenetheridge avatar Sep 08 '25 19:09 karenetheridge

@karenetheridge this is still a problem regardless of what happens with schema $ids.

handrews avatar Sep 08 '25 20:09 handrews

Rebased and force-pushed because of the merge of PR #4927, but there are no actual changes to the commits/text here (both touched the openapi field text but this PR already incorporated the change from 4927).

handrews avatar Sep 09 '25 15:09 handrews

@ralfhandl should be fixed now.

handrews avatar Sep 09 '25 16:09 handrews

@karenetheridge this PR still allows the point release to be present if people want to do something with it. Without opening another thread here on any other aspects, does that make any difference to you? Nothing you're doing now with point releases would be impossible after this for any OAD author who wants to specify the point release.

This PR just allows authors who want to make it very clear that they are using 3.2 in its most clarified/least buggy form, whatever that is, to say so.

handrews avatar Sep 10 '25 18:09 handrews

We discussed this in the 9/11/25 TDC meeting and could not get consensus on whether this should go in 3.2 or 3.3.

mikekistler avatar Sep 11 '25 16:09 mikekistler

I have made my points here and elsewhere. I will be traveling and will not be able to make next week's TDC call, but I encourage folks to make a decision one way or the other and ship the release in my absence. I feel like folks have listened sufficiently to what I have to say on this topic, so I don't need to be present for any final call.

Please feel free to edit the PR or replace it with another one if editing this one is inconvenient. I do not need to approve any edits.

handrews avatar Sep 11 '25 18:09 handrews

I vote for including this in v3.2.

ralfhandl avatar Sep 11 '25 18:09 ralfhandl

From discussing this on the TDC call, this one is locked at this point and needs to go through and @OAI/tsc vote.

baywet avatar Nov 06 '25 17:11 baywet