Package io.smallrye.openapi.runtime.io.externaldocs

Class ExternalDocsReader

java.lang.Object

io.smallrye.openapi.runtime.io.externaldocs.ExternalDocsReader

public class ExternalDocsReader
extends Object

This reads annotations and json for External Documentation

Author:

Phillip Kruger (phillip.kruger@redhat.com), Eric Wittmann (eric.wittmann@gmail.com)

See Also:

• externalDocumentationObject

Method Summary

Modifier and Type	Method	Description
static org.eclipse.microprofile.openapi.models.ExternalDocumentation	readExternalDocs(com.fasterxml.jackson.databind.JsonNode node)	Reads an ExternalDocumentation OpenAPI node.
static org.eclipse.microprofile.openapi.models.ExternalDocumentation	readExternalDocs(AnnotationScannerContext context, org.jboss.jandex.AnnotationInstance annotationInstance)	Reads an ExternalDocumentation annotation.
static org.eclipse.microprofile.openapi.models.ExternalDocumentation	readExternalDocs(AnnotationScannerContext context, org.jboss.jandex.AnnotationValue annotationValue)	Reads an ExternalDocumentation annotation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

readExternalDocs

public static org.eclipse.microprofile.openapi.models.ExternalDocumentation readExternalDocs(AnnotationScannerContext context,
 org.jboss.jandex.AnnotationValue annotationValue)

Reads an ExternalDocumentation annotation.

Parameters:

context - scanning context

annotationValue - the @ExternalDocumentation annotation

Returns:

ExternalDocumentation model

readExternalDocs

public static org.eclipse.microprofile.openapi.models.ExternalDocumentation readExternalDocs(AnnotationScannerContext context,
 org.jboss.jandex.AnnotationInstance annotationInstance)

Reads an ExternalDocumentation annotation.

Parameters:

context - scanning context

annotationInstance - the @ExternalDocumentation annotation

Returns:

ExternalDocumentation model

readExternalDocs

public static org.eclipse.microprofile.openapi.models.ExternalDocumentation readExternalDocs(com.fasterxml.jackson.databind.JsonNode node)

Reads an ExternalDocumentation OpenAPI node.

Parameters:

node - the json node

Returns:

ExternalDocumentation model