MicroProfile OpenAPI 4.0
Overview
WildFly currently provides MicroProfile OpenAPI 3.1 support to applications to expose an /openapi endpoint that serves an OpenAPI 3.0 document of the application’s Jakarta RESTful Web Services.
This feature request upgrades support for this specification to version 4.0 as part of version 7.0 of the MicroProfile platform specification.
Most notably, this release of the MicroProfile OpenAPI specification generates OpenAPI documentation conforming to version 3.1 of the OpenAPI specification.
For details, see the Release Notes.
User Stories
A user would like to expose an endpoint that serves an OpenAPI 3.1 document describing the Jakarta RESTful Web Services of their application.
Issue Metadata
Related Issues
Affected Projects or Components
-
WildFly Quickstarts (updates to version numbers references only)
Other Interested Projects
Relevant Installation Types
-
Traditional standalone server (unzipped or provisioned by Galleon)
-
Managed domain
-
OpenShift Source-to-Image (S2I)
-
Bootable jar
Requirements
-
Upgrade version of MicroProfile OpenAPI specification API from 3.1 to 4.0.
-
Upgrade version of SmallRye OpenAPI to the final 4.0.x release that implements the new spec version.
Changed requirements
N/A
Non-Requirements
N/A
Future Work
N/A
Backwards Compatibility
Default Configuration
N/A
Importing Existing Configuration
N/A
Deployments
See Release Notes for the list of incompatible changes between the current and previous versions of the MicroProfile OpenAPI specification.
Interoperability
N/A
Implementation Plan
The implementation of MicroProfile OpenAPI 4.0 is provided by SmallRye OpenAPI 4.0.x. The implemetation plan consist of simple version upgrade of the following components:
-
org.eclipse.microprofile.openapi API
-
org.eclipse.microprofile.openapi TCK
-
io.smallrye.openapi
Admin Clients
N/A
Security Considerations
N/A
Test Plan
The following testsuites will be used to validate this feature:
-
Version 4.0 of the MicroProfile OpenAPI TCK
-
The existing MicroProfile OpenAPI tests within WildFly’s MicroProfile integration testsuite.
-
The MicroProfile OpenAPI tests from https://github.com/jboss-eap-qe/eap-microprofile-test-suite
Community Documentation
References the MicroProfile OpenAPI and OpenAPI specifications need to be updated to reflect the current versions.
Release Note Content
Support for the MicroProfile OpenAPI specification was updated from 3.1 to 4.0.