| Modifier and Type | Method and Description |
|---|---|
static org.eclipse.microprofile.openapi.models.callbacks.Callback |
CallbackReader.readCallback(AnnotationScannerContext context,
org.jboss.jandex.AnnotationInstance annotation)
Reads a Callback annotation into a model.
|
static Map<String,org.eclipse.microprofile.openapi.models.callbacks.Callback> |
CallbackReader.readCallbacks(AnnotationScannerContext context,
org.jboss.jandex.AnnotationValue annotationValue)
Reads a map of Callback annotations.
|
| Modifier and Type | Method and Description |
|---|---|
static org.eclipse.microprofile.openapi.models.Components |
ComponentsReader.readComponents(AnnotationScannerContext context,
org.jboss.jandex.AnnotationValue annotationValue)
Reads any Components annotations.
|
| Modifier and Type | Method and Description |
|---|---|
static org.eclipse.microprofile.openapi.models.media.Content |
ContentReader.readContent(AnnotationScannerContext context,
org.jboss.jandex.AnnotationValue annotationValue,
ContentDirection direction)
Reads a single Content annotation into a model.
|
| Modifier and Type | Method and Description |
|---|---|
static void |
DefinitionReader.processDefinition(AnnotationScannerContext context,
org.eclipse.microprofile.openapi.models.OpenAPI openApi,
org.jboss.jandex.AnnotationInstance annotationInstance)
Reads a OpenAPIDefinition annotation.
|
| Modifier and Type | Method and Description |
|---|---|
static Map<String,org.eclipse.microprofile.openapi.models.media.Encoding> |
EncodingReader.readEncodings(AnnotationScannerContext context,
org.jboss.jandex.AnnotationValue annotationValue)
Reads an array of Encoding annotations as a Map.
|
| Modifier and Type | Method and Description |
|---|---|
static Map<String,Object> |
ExtensionReader.readExtensions(AnnotationScannerContext context,
org.jboss.jandex.AnnotationValue annotationValue)
Reads an array of Extension annotations.
|
static Map<String,Object> |
ExtensionReader.readExtensions(AnnotationScannerContext context,
List<org.jboss.jandex.AnnotationInstance> extensions)
Reads a List of Extension annotations.
|
static Object |
ExtensionReader.readExtensionValue(AnnotationScannerContext context,
String name,
org.jboss.jandex.AnnotationInstance annotationInstance)
Reads a single Extension annotation.
|
| Modifier and Type | Method and Description |
|---|---|
static Map<String,org.eclipse.microprofile.openapi.models.headers.Header> |
HeaderReader.readHeaders(AnnotationScannerContext context,
org.jboss.jandex.AnnotationValue annotationValue)
Reads a map of Header annotations.
|
| Modifier and Type | Method and Description |
|---|---|
static org.eclipse.microprofile.openapi.models.media.MediaType |
MediaTypeReader.readMediaType(AnnotationScannerContext context,
org.jboss.jandex.AnnotationInstance annotationInstance)
Reads a single Content annotation into a
MediaType model. |
| Modifier and Type | Method and Description |
|---|---|
static org.eclipse.microprofile.openapi.models.Operation |
OperationReader.readOperation(AnnotationScannerContext context,
org.jboss.jandex.AnnotationInstance annotationInstance)
Reads a single Operation annotation.
|
| Modifier and Type | Method and Description |
|---|---|
static org.eclipse.microprofile.openapi.models.parameters.Parameter |
ParameterReader.readParameter(AnnotationScannerContext context,
org.jboss.jandex.AnnotationInstance annotationInstance)
Reads a Parameter annotation into a model.
|
static Map<String,org.eclipse.microprofile.openapi.models.parameters.Parameter> |
ParameterReader.readParameters(AnnotationScannerContext context,
org.jboss.jandex.AnnotationValue annotationValue)
Reads a map of Parameter annotations.
|
static Optional<List<org.eclipse.microprofile.openapi.models.parameters.Parameter>> |
ParameterReader.readParametersList(AnnotationScannerContext context,
org.jboss.jandex.AnnotationValue annotationValue)
Reads a map of Parameter annotations.
|
| Modifier and Type | Method and Description |
|---|---|
static org.eclipse.microprofile.openapi.models.PathItem |
PathsReader.readPathItem(AnnotationScannerContext context,
org.jboss.jandex.AnnotationValue annotationValue)
Reads the PathItem.
|
| Modifier and Type | Method and Description |
|---|---|
static Map<String,org.eclipse.microprofile.openapi.models.parameters.RequestBody> |
RequestBodyReader.readRequestBodies(AnnotationScannerContext context,
org.jboss.jandex.AnnotationValue annotationValue)
Reads a map of RequestBody annotations.
|
static org.eclipse.microprofile.openapi.models.parameters.RequestBody |
RequestBodyReader.readRequestBody(AnnotationScannerContext context,
org.jboss.jandex.AnnotationInstance annotationInstance)
Reads a RequestBody annotation into a model.
|
static org.eclipse.microprofile.openapi.models.parameters.RequestBody |
RequestBodyReader.readRequestBody(AnnotationScannerContext context,
org.jboss.jandex.AnnotationValue annotationValue)
Reads a RequestBody annotation into a model.
|
static org.eclipse.microprofile.openapi.models.parameters.RequestBody |
RequestBodyReader.readRequestBodySchema(AnnotationScannerContext context,
org.jboss.jandex.AnnotationInstance annotation)
Reads a RequestBodySchema annotation into a model.
|
| Modifier and Type | Method and Description |
|---|---|
static org.eclipse.microprofile.openapi.models.responses.APIResponse |
ResponseReader.readResponse(AnnotationScannerContext context,
org.jboss.jandex.AnnotationInstance annotationInstance)
Reads a APIResponse annotation into a model.
|
static org.eclipse.microprofile.openapi.models.responses.APIResponses |
ResponseReader.readResponses(AnnotationScannerContext context,
org.jboss.jandex.AnnotationValue annotationValue)
Reads an array of APIResponse annotations into an
APIResponses model. |
static org.eclipse.microprofile.openapi.models.responses.APIResponse |
ResponseReader.readResponseSchema(AnnotationScannerContext context,
org.jboss.jandex.AnnotationInstance annotation)
Reads a APIResponseSchema annotation into a model.
|
static Map<String,org.eclipse.microprofile.openapi.models.responses.APIResponse> |
ResponseReader.readResponsesMap(AnnotationScannerContext context,
org.jboss.jandex.AnnotationValue annotationValue)
Reads a map of APIResponse annotations.
|
| Modifier and Type | Method and Description |
|---|---|
static Map<String,org.eclipse.microprofile.openapi.models.media.Schema> |
SchemaReader.readSchemas(AnnotationScannerContext context,
org.jboss.jandex.AnnotationValue annotationValue)
Reads a map of Schema annotations.
|
| Modifier and Type | Method and Description |
|---|---|
default void |
AnnotationScanner.addApiReponseFromAnnotation(AnnotationScannerContext context,
org.jboss.jandex.AnnotationInstance apiResponseAnnotation,
org.eclipse.microprofile.openapi.models.Operation operation)
Add api response to api responses using the annotation information
|
default void |
AnnotationScanner.addApiReponseSchemaFromAnnotation(AnnotationScannerContext context,
org.jboss.jandex.AnnotationInstance annotation,
org.jboss.jandex.MethodInfo method,
org.eclipse.microprofile.openapi.models.Operation operation)
Add api response to api responses using the annotation information
|
default void |
AnnotationScanner.createResponseFromRestMethod(AnnotationScannerContext context,
org.jboss.jandex.MethodInfo method,
org.eclipse.microprofile.openapi.models.Operation operation)
Called when a scanner (jax-rs, spring) method's APIResponse annotations have all been processed but
no response was actually created for the operation.This method will create a response
from the method information and add it to the given operation.
|
default List<org.jboss.jandex.MethodInfo> |
AnnotationScanner.getResourceMethods(AnnotationScannerContext context,
org.jboss.jandex.ClassInfo resource)
Extracts all methods from the provided class and its ancestors that are known to the instance's index
|
default void |
AnnotationScanner.processCallback(AnnotationScannerContext context,
org.jboss.jandex.MethodInfo method,
org.eclipse.microprofile.openapi.models.Operation operation)
Process a callback annotation
|
default void |
AnnotationScanner.processDefinitionAnnotation(AnnotationScannerContext context,
org.jboss.jandex.ClassInfo targetClass,
org.eclipse.microprofile.openapi.models.OpenAPI openApi)
Process a certain class for OpenApiDefinition annotations.
|
default void |
AnnotationScanner.processExtensions(AnnotationScannerContext context,
org.jboss.jandex.MethodInfo method,
org.eclipse.microprofile.openapi.models.Operation operation)
Process the Extensions annotations
|
default Optional<org.eclipse.microprofile.openapi.models.Operation> |
AnnotationScanner.processOperation(AnnotationScannerContext context,
org.jboss.jandex.MethodInfo method)
While scanning JAX-RS/Spring method, find the operations
|
default org.eclipse.microprofile.openapi.models.parameters.RequestBody |
AnnotationScanner.processRequestBody(AnnotationScannerContext context,
org.jboss.jandex.MethodInfo method,
ResourceParameters params)
Process the request body
|
default void |
AnnotationScanner.processResponse(AnnotationScannerContext context,
org.jboss.jandex.MethodInfo method,
org.eclipse.microprofile.openapi.models.Operation operation,
Map<org.jboss.jandex.DotName,org.jboss.jandex.AnnotationInstance> exceptionAnnotationMap) |
default void |
AnnotationScanner.processScannerExtensions(AnnotationScannerContext context,
Collection<org.jboss.jandex.ClassInfo> applications)
Scan for scanner extensions
|
org.eclipse.microprofile.openapi.models.OpenAPI |
AnnotationScanner.scan(AnnotationScannerContext annotationScannerContext,
org.eclipse.microprofile.openapi.models.OpenAPI oai) |
Copyright © 2018–2020. All rights reserved.