Package io.quarkus.smallrye.openapi.common.deployment

Interface SmallRyeOpenApiConfig

@ConfigRoot @ConfigMapping(prefix="quarkus.smallrye-openapi") public interface SmallRyeOpenApiConfig

  • Field Details

  • Method Details

    • path

      @Deprecated(since="3.31", forRemoval=true) default String path()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use documents() with key DEFAULT_DOCUMENT_NAME instead
      The path at which to register the OpenAPI Servlet.

    • storeSchemaDirectory

      @Deprecated(since="3.31", forRemoval=true) default Optional<Path> storeSchemaDirectory()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use documents() with key DEFAULT_DOCUMENT_NAME instead
      If set, the generated OpenAPI schema documents will be stored here on build. Both openapi.json and openapi.yaml will be stored here if this is set.

    • storeSchemaFileName

      @Deprecated(since="3.31", forRemoval=true) default String storeSchemaFileName()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use documents() with key DEFAULT_DOCUMENT_NAME instead
      The name of the file in case it is being stored.

    • alwaysRunFilter

      @Deprecated(since="3.31", forRemoval=true) default boolean alwaysRunFilter()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use documents() with key DEFAULT_DOCUMENT_NAME instead
      Do not run the filter only at startup, but every time the document is requested (dynamic).

    • ignoreStaticDocument

      @Deprecated(since="3.31", forRemoval=true) default boolean ignoreStaticDocument()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use documents() with key DEFAULT_DOCUMENT_NAME instead
      Do not include the provided static openapi document (eg. META-INF/openapi.yaml)

    • managementEnabled

      @WithName("management.enabled") @WithDefault("true") boolean managementEnabled()
      If management interface is turned on the openapi schema document will be published under the management interface. This allows you to exclude OpenAPI from management by setting the value to false

    • additionalDocsDirectory

      @Deprecated(since="3.31", forRemoval=true) default Optional<List<Path>> additionalDocsDirectory()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use documents() with key DEFAULT_DOCUMENT_NAME instead
      A list of local directories that should be scanned for yaml and/or json files to be included in the static model. Example: `META-INF/openapi/`

    • securityScheme

      @Deprecated(since="3.31", forRemoval=true) default Optional<SmallRyeOpenApiConfig.SecurityScheme> securityScheme()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use documents() with key DEFAULT_DOCUMENT_NAME instead
      Add a certain SecurityScheme with config

    • securitySchemeName

      @Deprecated(since="3.31", forRemoval=true) default String securitySchemeName()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use documents() with key DEFAULT_DOCUMENT_NAME instead
      Add a Security Scheme name to the generated OpenAPI document

    • securitySchemeDescription

      @Deprecated(since="3.31", forRemoval=true) default String securitySchemeDescription()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use documents() with key DEFAULT_DOCUMENT_NAME instead
      Add a description to the Security Scheme

    • securitySchemeExtensions

      @Deprecated(since="3.31", forRemoval=true) default Map<String,String> securitySchemeExtensions()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use documents() with key DEFAULT_DOCUMENT_NAME instead
      Add one or more extensions to the security scheme

    • autoAddSecurityRequirement

      @Deprecated(since="3.31", forRemoval=true) default boolean autoAddSecurityRequirement()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use documents() with key DEFAULT_DOCUMENT_NAME instead
      This will automatically add the security requirement to all methods/classes that has a `RolesAllowed` annotation.

    • autoAddTags

      @Deprecated(since="3.31", forRemoval=true) default boolean autoAddTags()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use documents() with key DEFAULT_DOCUMENT_NAME instead
      This will automatically add tags to operations based on the Java class name.

    • autoAddBadRequestResponse

      @Deprecated(since="3.31", forRemoval=true) default boolean autoAddBadRequestResponse()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use documents() with key DEFAULT_DOCUMENT_NAME instead
      This will automatically add Bad Request (400 HTTP response) API response to operations with an input.

    • autoAddOperationSummary

      @Deprecated(since="3.31", forRemoval=true) default boolean autoAddOperationSummary()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use documents() with key DEFAULT_DOCUMENT_NAME instead
      This will automatically add a summary to operations based on the Java method name.

    • autoAddServer

      @Deprecated(since="3.31", forRemoval=true) default Optional<Boolean> autoAddServer()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use documents() with key DEFAULT_DOCUMENT_NAME instead
      Setting it to `true` will automatically add a default server to the schema if none is provided, using the current running server host and port.

    • autoAddSecurity

      @Deprecated(since="3.31", forRemoval=true) default boolean autoAddSecurity()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use documents() with key DEFAULT_DOCUMENT_NAME instead
      This will automatically add security based on the security extension included (if any).

    • autoAddOpenApiEndpoint

      @Deprecated(since="3.31", forRemoval=true) default boolean autoAddOpenApiEndpoint()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use documents() with key DEFAULT_DOCUMENT_NAME instead
      This will automatically add the OpenAPI specification document endpoint to the schema. It also adds "openapi" to the list of tags and specify an "operationId"

    • apiKeyParameterIn

      @Deprecated(since="3.31", forRemoval=true) default Optional<String> apiKeyParameterIn()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use documents() with key DEFAULT_DOCUMENT_NAME instead
      Required when using `apiKey` security. The location of the API key. Valid values are "query", "header" or "cookie".

    • apiKeyParameterName

      @Deprecated(since="3.31", forRemoval=true) default Optional<String> apiKeyParameterName()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use documents() with key DEFAULT_DOCUMENT_NAME instead
      Required when using `apiKey` security. The name of the header, query or cookie parameter to be used.

    • basicSecuritySchemeValue

      @Deprecated(since="3.31", forRemoval=true) default String basicSecuritySchemeValue()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use documents() with key DEFAULT_DOCUMENT_NAME instead
      Add a scheme value to the Basic HTTP Security Scheme

    • jwtSecuritySchemeValue

      @Deprecated(since="3.31", forRemoval=true) default String jwtSecuritySchemeValue()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use documents() with key DEFAULT_DOCUMENT_NAME instead
      Add a scheme value to the JWT Security Scheme

    • jwtBearerFormat

      @Deprecated(since="3.31", forRemoval=true) default String jwtBearerFormat()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use documents() with key DEFAULT_DOCUMENT_NAME instead
      Add a bearer format the JWT Security Scheme

    • oauth2SecuritySchemeValue

      @Deprecated(since="3.31", forRemoval=true) default String oauth2SecuritySchemeValue()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use documents() with key DEFAULT_DOCUMENT_NAME instead
      Add a scheme value to the OAuth2 opaque token Security Scheme

    • oauth2BearerFormat

      @Deprecated(since="3.31", forRemoval=true) default String oauth2BearerFormat()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use documents() with key DEFAULT_DOCUMENT_NAME instead
      Add a scheme value to OAuth2 opaque token Security Scheme

    • oidcOpenIdConnectUrl

      @Deprecated(since="3.31", forRemoval=true) default Optional<String> oidcOpenIdConnectUrl()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use documents() with key DEFAULT_DOCUMENT_NAME instead
      Add a openIdConnectUrl value to the OIDC Security Scheme

    • oauth2ImplicitRefreshUrl

      @Deprecated(since="3.31", forRemoval=true) default Optional<String> oauth2ImplicitRefreshUrl()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use documents() with key DEFAULT_DOCUMENT_NAME instead
      Add a implicit flow refreshUrl value to the OAuth2 Security Scheme

    • oauth2ImplicitAuthorizationUrl

      @Deprecated(since="3.31", forRemoval=true) default Optional<String> oauth2ImplicitAuthorizationUrl()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use documents() with key DEFAULT_DOCUMENT_NAME instead
      Add an implicit flow authorizationUrl value to the OAuth2 Security Scheme

    • oauth2ImplicitTokenUrl

      @Deprecated(since="3.31", forRemoval=true) default Optional<String> oauth2ImplicitTokenUrl()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use documents() with key DEFAULT_DOCUMENT_NAME instead
      Add an implicit flow tokenUrl value to the OAuth2 Security Scheme

    • openApiVersion

      @Deprecated(since="3.31", forRemoval=true) default Optional<String> openApiVersion()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use documents() with key DEFAULT_DOCUMENT_NAME instead
      Override the openapi version in the Schema document

    • infoTitle

      @Deprecated(since="3.31", forRemoval=true) default Optional<String> infoTitle()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use documents() with key DEFAULT_DOCUMENT_NAME instead
      Set the title in Info tag in the Schema document

    • infoVersion

      @Deprecated(since="3.31", forRemoval=true) default Optional<String> infoVersion()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use documents() with key DEFAULT_DOCUMENT_NAME instead
      Set the version in Info tag in the Schema document

    • infoDescription

      @Deprecated(since="3.31", forRemoval=true) default Optional<String> infoDescription()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use documents() with key DEFAULT_DOCUMENT_NAME instead
      Set the description in Info tag in the Schema document

    • infoTermsOfService

      @Deprecated(since="3.31", forRemoval=true) default Optional<String> infoTermsOfService()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use documents() with key DEFAULT_DOCUMENT_NAME instead
      Set the terms of the service in Info tag in the Schema document

    • infoContactEmail

      @Deprecated(since="3.31", forRemoval=true) default Optional<String> infoContactEmail()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use documents() with key DEFAULT_DOCUMENT_NAME instead
      Set the contact email in Info tag in the Schema document

    • infoContactName

      @Deprecated(since="3.31", forRemoval=true) default Optional<String> infoContactName()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use documents() with key DEFAULT_DOCUMENT_NAME instead
      Set the contact name in Info tag in the Schema document

    • infoContactUrl

      @Deprecated(since="3.31", forRemoval=true) default Optional<String> infoContactUrl()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use documents() with key DEFAULT_DOCUMENT_NAME instead
      Set the contact url in Info tag in the Schema document

    • infoLicenseName

      @Deprecated(since="3.31", forRemoval=true) default Optional<String> infoLicenseName()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use documents() with key DEFAULT_DOCUMENT_NAME instead
      Set the license name in Info tag in the Schema document

    • infoLicenseUrl

      @Deprecated(since="3.31", forRemoval=true) default Optional<String> infoLicenseUrl()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use documents() with key DEFAULT_DOCUMENT_NAME instead
      Set the license url in Info tag in the Schema document

    • operationIdStrategy

      @Deprecated(since="3.31", forRemoval=true) default Optional<String> operationIdStrategy()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use documents() with key DEFAULT_DOCUMENT_NAME instead
      Set the strategy to automatically create an operation Id. The strategy may be one of the predefined values or the name of a fully-qualified class that implements the io.smallrye.openapi.api.OperationIdGenerator interface.

      Predefined strategies:

      • method: generate an operationId with the resource method's name
      • class-method: generate an operationId with the resource class's simple name and the resource method's name
      • package-class-method: generate an operationId with the resource class's fully-qualified name and the resource method's name

    • mergeSchemaExamples

      @Deprecated(since="3.31", forRemoval=true) default boolean mergeSchemaExamples()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use documents() with key DEFAULT_DOCUMENT_NAME instead
      Set this boolean value to enable or disable the merging of the deprecated `@Schema` `example` property into the `examples` array introduced in OAS 3.1.0. If set to `false`, the deprecated `example` will be kept as a separate annotation on the schema in the OpenAPI model.

    • getValidSecuritySchemeExtensions

      @Deprecated(since="3.31", forRemoval=true) default Map<String,String> getValidSecuritySchemeExtensions()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use OpenApiDocumentConfig.getValidSecuritySchemeExtensions() with key DEFAULT_DOCUMENT_NAME instead
      Get valid security scheme extensions (those starting with "x-")

    • documents

      @ConfigDocMapKey("document-name") @WithParentName @WithUnnamedKey("<default>") @WithDefaults @WithUnnamedKey("<default>") Map<String,OpenApiDocumentConfig> documents()
      OpenAPI documents