MicroProfile OpenAPI 1.1

MicroProfile OpenAPI 1.1

NOTE: due to an issue with the TCK, a release 1.1.1 was made. It is recommended to use it instead of this version.

Javadocs | Spec

Changes include:

• the addition of the JAXRS 2.1 PATCH method
• automatic hide MicroProfile Rest Client interfaces
• OASFactoryResolver is now a proper SPI artifact
• builder methods now have default implementations
• @Content now supports a singular example field
• @Extension now has a parseValue field for complex values
• TCK updated to support newer 3.0.x versions
• overall Javadoc enhancements (classes and packages)
• various other minor improvements to the annotations, models and TCK
  • bug fixes, documentation updates, more convenience methods, deprecations, etc.
  • list of issues here

Commits since 1.0.1 release here

Coordinates on maven central:

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

MR1- MicroProfile OpenAPI 2.0

Milestone Release 1 for MicroProfile OpenAPI 2.0

Javadocs | Spec

• Methods that were renamed (and deprecated) in 1.1 are removed
• Changes to model interfaces: interfaces no longer extend java.util.Map
• Tck ensure that model interfaces are creating copy of lists/maps and are returning immutable copies of lists/maps
• Delegate document / property location to MP Config

Coordinates on maven central:

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

RC1- MicroProfile OpenAPI 1.1

RC1 for MicroProfile OpenAPI 1.1

Javadocs | Spec

Changes include:

• the addition of the JAXRS 2.1 PATCH method
• various improvements to the TCK, annotations and models
  • bug fixes, documentation updates, more convenience methods, etc.

Coordinates on maven central:

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

MicroProfile OpenAPI 1.0.1

MicroProfile OpenAPI 1.0.1 final release.

This patch release updates only the TCK.

Changes:

• fixes issues in the TCK such as incorrect assertions and test application invalid scenarios
• enhanced the TCK framework such that a separately deployed proxy.war is no longer needed.
• query which describes the fixed items: https://github.com/eclipse/microprofile-open-api/issues?q=label%3A%221.0.1+candidate%22+is%3Aclosed

Maven central artifacts: https://search.maven.org/#search%7Cga%7C1%7Cmicroprofile-openapi

Specification artifacts: HTML PDF Javadocs

MicroProfile OpenAPI 1.0.1 RC1

Release Candidate 1 for MP OpenAPI 1.0.1 patch release.

Changes:

• fixes issues in the TCK such as incorrect assertions and test application invalid scenarios
• enhanced the TCK framework such that a separately deployed proxy.war is no longer needed.
• query which describes the fixed items: https://github.com/eclipse/microprofile-open-api/issues?q=label%3A%221.0.1+candidate%22+is%3Aclosed

MicroProfile OpenAPI 1.0

Official release for MicroProfile OpenAPI 1.0

Specification artifacts: HTML PDF Javadocs

Maven dependency for APIs:

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

MicroProfile OpenAPI RC2

Release Candidate 2 for the MicroProfile OpenAPI specification.

Changes since RC1:

• simplification of the @Operation annotation
• minor text edits and clarifications in the spec
• additional TCK coverage (annotations, models)
• Collapsed the various Parameter sub-types into a single one (consistent with Schema)

Specification artifacts: HTML PDF

MicroProfile OpenAPI RC1

Release Candidate 1 for the MicroProfile OpenAPI Specification.

Specification artifacts:
HTML
PDF