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

Request: Modify SmallRye specific MP Config properties to include vendor name #370

Closed
msmiths opened this issue Jun 16, 2020 · 4 comments · Fixed by #371
Closed

Request: Modify SmallRye specific MP Config properties to include vendor name #370

msmiths opened this issue Jun 16, 2020 · 4 comments · Fixed by #371
Labels
enhancement New feature or request
Milestone

Comments

@msmiths
Copy link
Contributor

msmiths commented Jun 16, 2020

Overview

Section 3.1.2, "Vendor extensions", of the MP OpenAPI specification allows vendors to define vendor-specific configuration via MP Config. Any vendor-specific properties must be prefixed with mp.openapi.extensions.

The SmallRye implementation has used this mechanism to define the following SmallRye specific MP Config properties:

  • mp.openapi.extensions.scan-dependencies.disable
  • mp.openapi.extensions.scan-dependencies.jars
  • mp.openapi.extensions.schema-references.enable
  • mp.openapi.extensions.custom-schema-registry.class
  • mp.openapi.extensions.application-path.disable

However, when embedding the SmallRye implementation into other runtimes it is not clear where these MP Config properties originate. This is exacerbated if the consuming runtime defines its own vendor-specific MP Config properties, alongside those inherited from the SmallRye implementation.

It would be useful to rename these properties to include smallrye in the property name to remove this ambiguity. For example:

  • mp.openapi.extensions.smallrye.scan-dependencies.disable
  • mp.openapi.extensions.smallrye.scan-dependencies.jars
  • mp.openapi.extensions.smallrye.schema-references.enable
  • mp.openapi.extensions.smallrye.custom-schema-registry.class
  • mp.openapi.extensions.smallrye.application-path.disable
@phillip-kruger phillip-kruger added this to the 2.0.3 milestone Jun 16, 2020
@phillip-kruger phillip-kruger added the enhancement New feature or request label Jun 16, 2020
@phillip-kruger
Copy link
Member

Thanks @msmiths :)

@radcortez
Copy link
Member

@msmiths
Copy link
Contributor Author

msmiths commented Jun 16, 2020

@radcortez This would place a runtime dependency on smallrye-config and I am looking to embed smallrye-open-api inside OpenLiberty where the MP Config implementation is not guaranteed to be SmallRye.

@radcortez
Copy link
Member

Sure :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
3 participants