Uses of Class
io.smallrye.openapi.api.SmallRyeOpenAPI.Builder
Packages that use SmallRyeOpenAPI.Builder
-
Uses of SmallRyeOpenAPI.Builder in io.smallrye.openapi.api
Methods in io.smallrye.openapi.api that return SmallRyeOpenAPI.BuilderModifier and TypeMethodDescriptionSmallRyeOpenAPI.Builder.addFilter(String filterName, ClassLoader classLoader, org.jboss.jandex.IndexView index) Add an OASFilter implementation class name to apply to the final OpenAPI model.SmallRyeOpenAPI.Builder.addFilter(org.eclipse.microprofile.openapi.OASFilter filter) Add an OASFilter instances to apply to the final OpenAPI model.SmallRyeOpenAPI.Builder.addFilterName(String filterName) Add an OASFilter implementation class name to apply to the final OpenAPI model.static SmallRyeOpenAPI.BuilderSmallRyeOpenAPI.builder()Create a newSmallRyeOpenAPI.Builderinstance;SmallRyeOpenAPI.Builder.defaultRequiredProperties(boolean defaultRequiredProperties) Enable (true) or disable (false) setting default values for the OpenAPI properties listed below.SmallRyeOpenAPI.Builder.enableAnnotationScan(boolean enableAnnotationScan) Enable (true) or disable (false) annotation scanning.SmallRyeOpenAPI.Builder.enableModelReader(boolean enableModelReader) Enable (true) or disable (false) the lookup and use of an OASModelReader.SmallRyeOpenAPI.Builder.enableStandardFilter(boolean enableStandardFilter) Enable (true) or disable (false) the lookup and use of the standard OASFilter.SmallRyeOpenAPI.Builder.enableStandardStaticFiles(boolean enableStandardStaticFiles) Enable (true) or disable (false) the lookup and use of the standard static OpenAPI files (e.g.SmallRyeOpenAPI.Builder.enableUnannotatedPathParameters(boolean enableUnannotatedPathParameters) Enable (true) or disable (false) path parameters to be optionally annotated.SmallRyeOpenAPI.Builder.withApplicationClassLoader(ClassLoader classLoader) Set the application ClassLoader to be used when building the OpenAPI model.SmallRyeOpenAPI.Builder.withConfig(org.eclipse.microprofile.config.Config config) Set the MicroProfile Config to be used when building the OpenAPI model.SmallRyeOpenAPI.Builder.withContextRootResolver(Function<Collection<org.jboss.jandex.ClassInfo>, String> contextRootResolver) Provide function that when given the collection of all known Jakarta REST Application ClassInfo instances, resolves the context root (path prefix) to be applied to all paths in the OpenAPI document.SmallRyeOpenAPI.Builder.withCustomStaticFile(Supplier<InputStream> customStaticFile) Provide a supplier of a custom static file that is not one of those in the standard locations or with a standard name.SmallRyeOpenAPI.Builder.withFilterNames(Collection<String> filterNames) Provide a collection of OASFilter implementation class names to apply to the final OpenAPI model.SmallRyeOpenAPI.Builder.withFilterNames(Collection<String> filterNames, ClassLoader classLoader, org.jboss.jandex.IndexView index) AProvide a collection of OASFilter implementation class names to apply to the final OpenAPI model.SmallRyeOpenAPI.Builder.withFilters(Collection<org.eclipse.microprofile.openapi.OASFilter> filters) Provide a collection of OASFilter instances to apply to the final OpenAPI model.SmallRyeOpenAPI.Builder.withIndex(org.jboss.jandex.IndexView index) Provide an IndexView for use in annotation scanning.SmallRyeOpenAPI.Builder.withInitialModel(org.eclipse.microprofile.openapi.models.OpenAPI initialModel) Set an initial model used when building the OpenAPI model.SmallRyeOpenAPI.Builder.withJsonParser(Function<String, Object> jsonParser) Provide a function that when given a JSON-formatted string, returns a parsed Java object equivalent.SmallRyeOpenAPI.Builder.withOperationHandler(OperationHandler handler) Provide anOperationHandlerto be called for each operation discovered during annotation scanning.SmallRyeOpenAPI.Builder.withResourceLocator(Function<String, URL> resourceLocator) Provide a resource locator function that when given a String path for a static file will return a URL that may be used to load the resource.SmallRyeOpenAPI.Builder.withScannerClassLoader(ClassLoader scannerClassLoader) Provide a class loader used to load AnnotationScanner instances via theServiceLoader.SmallRyeOpenAPI.Builder.withScannerFilter(Predicate<String> scannerFilter) Provide a filter predicate used to include/exclude AnnotationScaner instances found via theServiceLoader.SmallRyeOpenAPI.Builder.withSchemaParser(Function<String, org.eclipse.microprofile.openapi.models.media.Schema> schemaParser) Provide a function that when given a JSON-formatted schema, returns a MicroProfile OpenAPISchemainstance.SmallRyeOpenAPI.Builder.withTypeConverter(UnaryOperator<org.jboss.jandex.Type> typeConverter) Provide a function that when given a Jandex Type, returns an alternate type if necessary.