-
Notifications
You must be signed in to change notification settings - Fork 4
Description
In the file there is a statement "openapi: 3.1.0".
In our current API specification we hence state that we use OpenAPI specification 3.1.0, which was released 2021-02-15
However, on 2025-09-19 the OpenAPI initiative released its OpenAPI specification of version 3.2.0.
I suggest that we change the openapi statement to "openapi : 3.2.0".
Key advantage: Unlike the 3.0 to 3.1 transition, OpenAPI 3.2 does not introduce breaking changes. All existing 3.1 documents will work without modification after updating the version number.
OpenAPI 3.2 represents a significant enhancement while maintaining complete backward compatibility. The upgrade of OpenAPI descriptions is low-risk, requiring only a version number change. The real value comes from gradually adopting new features that enhance your API documentation, improve developer experience, and support modern API patterns.
This approach allows teams to upgrade immediately for compatibility benefits while planning feature adoption based on their specific needs and timeline.