Skip to content

Commit

Permalink
Declare use of OASFactoryResolver in module-info
Browse files Browse the repository at this point in the history
Signed-off-by: Michael Edgar <michael@xlate.io>
  • Loading branch information
MikeEdgar committed Jan 23, 2024
1 parent c9a1661 commit 8545f2f
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 7 deletions.
2 changes: 1 addition & 1 deletion api/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@

<artifactId>microprofile-openapi-api</artifactId>
<name>MicroProfile OpenAPI API</name>
<description>MicroProfile OpenAPI API :: API</description>
<description>MicroProfile OpenAPI :: API</description>

<dependencies>
<dependency>
Expand Down
3 changes: 3 additions & 0 deletions api/src/main/java/module-info.java
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
* A set of Java interfaces, annotations, and programming models which allow Java developers to natively produce OpenAPI
* documents from Jakarta RESTful Web Services applications.
*/
@SuppressWarnings("module") // silence warning about unstable name `osgi.annotation`
module org.eclipse.microprofile.openapi {

exports org.eclipse.microprofile.openapi;
Expand Down Expand Up @@ -47,6 +48,8 @@
exports org.eclipse.microprofile.openapi.models.tags;
exports org.eclipse.microprofile.openapi.spi;

uses org.eclipse.microprofile.openapi.spi.OASFactoryResolver;

// Required for compilation, not used at runtime
requires static osgi.annotation;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,14 +46,14 @@
* }
* </pre>
* <p>
* When this annotation is applied to a Jakarta REST resource class, the response is added to the responses defined in all
* OpenAPI operations which correspond to a method on that class. If an operation already has a response with the
* When this annotation is applied to a Jakarta REST resource class, the response is added to the responses defined in
* all OpenAPI operations which correspond to a method on that class. If an operation already has a response with the
* specified responseCode the response is not added to that operation.
*
* <p>
* When this annotation is applied to an <code>ExceptionMapper</code> class or <code>toResponse</code> method, it allows
* developers to describe the API response that will be added to a generated OpenAPI operation based on a Jakarta REST method
* that declares an <code>Exception</code> of the type handled by the <code>ExceptionMapper</code>.
* developers to describe the API response that will be added to a generated OpenAPI operation based on a Jakarta REST
* method that declares an <code>Exception</code> of the type handled by the <code>ExceptionMapper</code>.
*
* <pre>
* &#64;Provider
Expand Down
4 changes: 2 additions & 2 deletions spi/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@

<artifactId>microprofile-openapi-spi</artifactId>
<name>MicroProfile OpenAPI SPI</name>
<description>MicroProfile OpenAPI SPI :: SPI</description>
<description>MicroProfile OpenAPI :: SPI</description>

<dependencies>
<dependency>
Expand All @@ -38,5 +38,5 @@
</dependency>
</dependencies>


</project>

0 comments on commit 8545f2f

Please sign in to comment.