Skip to main content

MicroProfile Open API 4.1

MicroProfile OpenAPI provides a way for developers to automatically generate and serve OpenAPI-compliant documentation for RESTful APIs in their applications. It allows applications to expose structured API documentation, which can be accessed via a defined endpoint, making it easier for developers and external systems to understand and interact with the API .

MicroProfile OpenAPI 4.1 is a minor release which adds support for the jsonSchemaDialect property and other small enhancements.

Weekly meeting: (UTC / US Eastern time).

Functional changes

  • Incompatible changes:
    • None
  • API/SPI changes
    • New OpenAPI property jsonSchemaDialect 660
    • New methods added to ExtensiblegetExtension(String) and hasExtension(String) 666
    • Add @Target to @DependentRequired@DependentSchema and @SchemaProperty where it was missing 676

Maven coordinates

<dependency>
<groupId>org.eclipse.microprofile.openapi</groupId>
<artifactId>microprofile-openapi-api</artifactId>
<version>4.1</version>
</dependency>

Scope

Finalized

Released

Details

TCK

Compatible Implementations

Open Liberty

Product
Java version
Open Liberty cl250620250508-1902
Java 11, 17 and 21

SmallRye

Product
Java version
SmallRye OpenAPI 4.1.0-alpha2
Java 11, 17 and 21

Ballots

Plan Review

The Specification Committee Ballot concluded successfully on  Mon, 3 Mar 2025  with the following results.

Corporate/Community Member Vote
Atlanta JUG 1
Community (Emerson Castaneda) 1
Fujitsu 1
IBM 1
iJUG -1
Microsoft
Oracle 1
Payara
Primeton
Red Hat 1
Tomitribe 1
Binding total 7
Non-binding Votes
Binding + non-binding total 7

Release Review

The Specification Committee Ballot concluded successfully on  Fri, 6 Jun 2025  with the following results.

Corporate/Community Member Vote
Atlanta JUG no vote
Community (Emerson Castaneda) +1
Fujitsu +1
IBM +1
iJUG no vote
Microsoft +1
Oracle +1
Payara +1
Primeton +1
Red Hat +1
Tomitribe no vote
Binding total 8
Non-binding Votes
Garden State JUG 1
Binding + non-binding total 9

Help optimize Enterprise Java for a microservices architecture.

Join the MicroProfile Google Group, peruse recent topics or create your own, and join in on the conversation. It's that easy!

JOIN THE DISCUSSION