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.

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

[4.x] Allow SE users work with OpenApiFeature instead of SeOpenApiFeature #7103

Merged
merged 4 commits into from Jun 29, 2023

Conversation

tjquinno
Copy link
Member

@tjquinno tjquinno commented Jun 26, 2023

Resolves #7041

Previously, SE developers would directly use SeOpenApiFeature in nima/openapi. We want them to not use "SE" anything.

That class was the only one in nima/openapi. This PR:

  1. Moves SeOpenApiFeature to helidon/openapi and makes it non-public.
  2. Adds OpenApiFeature#builder() which returns an OpenApiFeature.Builder which actually returns a builder for SeOpenApiFeature. Going forward SE developers will use OpenApiFeature.builder() (instead of SeOpenApiFeature.builder()) to prepare the feature so they can add it to their routing.
  3. Moves tests and supporting resource files from nima/openapi to microprofile/openapi. Those tests and resources refer to SmallRye OpenAPI elements. We continue to rely on SmallRye for our MP OpenAPI implementation but we will not for SE. So those tests could not move to helidon/openapi or we'd have to add the SmallRye dependency to that component.
  4. Updates the SE quickstart app to use the new OpenApiFeature#builder method.
  5. Unplugs nima/openapi from the nima module.

This PR does not address doc changes; we have a separate issue to address the OpenAPI doc.

Also, this PR leaves some of the transplanted tests commented out (due to other pressing tasks!); they were originally written to work with SE and need to be adjusted to work with MP now that they are in MP OpenAPI now.

@romain-grecourt I did not see any references to SeOpenApiFeature in the archetypes directory but I've tagged you as a reviewer just so you can double-check.

@tjquinno tjquinno added this to the 4.0.0-M1 milestone Jun 26, 2023
@tjquinno tjquinno self-assigned this Jun 26, 2023
@oracle-contributor-agreement oracle-contributor-agreement bot added the OCA Verified All contributors have signed the Oracle Contributor Agreement. label Jun 26, 2023
@tjquinno tjquinno linked an issue Jun 26, 2023 that may be closed by this pull request
@tjquinno tjquinno force-pushed the se-openapi-naming branch 2 times, most recently from c2e0da4 to a160fe1 Compare June 27, 2023 20:31
@tjquinno tjquinno merged commit 52d3572 into helidon-io:main Jun 29, 2023
12 checks passed
@tjquinno tjquinno deleted the se-openapi-naming branch June 29, 2023 16:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
OCA Verified All contributors have signed the Oracle Contributor Agreement.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

SeOpenApiFeature should be renamed
3 participants