Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Revert SPI module deprecation, declare use of OASFactoryResolver in module-info #596

Merged
merged 2 commits into from
Jan 24, 2024
Merged

Revert SPI module deprecation, declare use of OASFactoryResolver in module-info #596

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c9a1661
Revert "Deprecate `spi` module and contents"
MikeEdgar Jan 19, 2024
8545f2f
Declare use of OASFactoryResolver in module-info
MikeEdgar Jan 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions api/src/main/java/module-info.java
View file
Open in desktop
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
10 changes: 3 additions & 7 deletions spi/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,13 +25,7 @@

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

This module is deprecated and will be removed in a future release of MicroProfile
OpenAPI. The functionality offered by this module is available in the microprofile-openapi-api
module which should be used instead.
</description>
<description>MicroProfile OpenAPI :: SPI</description>

<dependencies>
<dependency>
Expand All @@ -43,4 +37,6 @@
<artifactId>microprofile-openapi-api</artifactId>
</dependency>
</dependencies>


</project>
4 changes: 0 additions & 4 deletions spi/src/main/java/org/eclipse/microprofile/openapi/spi/OASFactoryResolver.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,11 +31,7 @@
* Service provider for OASFactoryResolver. The implementation registers itself via the {@link java.util.ServiceLoader}
* mechanism or by manually setting their implementation using the setInstance method.
*
* @deprecated the OASFactoryResolver available in module
* {@code org.eclipse.microprofile.openapi:microprofile-openapi-api} should be used instead of this version
* which will be removed in a future major release.
*/
@Deprecated(forRemoval = true)
public abstract class OASFactoryResolver {

private static volatile OASFactoryResolver instance = null;
Expand Down
8 changes: 2 additions & 6 deletions spi/src/main/java/org/eclipse/microprofile/openapi/spi/package-info.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,7 @@

/**
* Service provider interface which allows vendors to set their implementations of OASFactoryResolver.
* <p>
* The {@code org.eclipse.microprofile.openapi.spi} package available in module
* {@code org.eclipse.microprofile.openapi:microprofile-openapi-api} should be used instead of this version which will
* be removed in a future major release.
*/
@Deprecated(forRemoval = true)

@org.osgi.annotation.versioning.Version("1.0")
package org.eclipse.microprofile.openapi.spi;
package org.eclipse.microprofile.openapi.spi;
Loading