io.muserver.openapi

Class ExternalDocumentationObjectBuilder

java.lang.Object

io.muserver.openapi.ExternalDocumentationObjectBuilder

public class ExternalDocumentationObjectBuilder
extends Object

Allows referencing an external resource for extended documentation.

Constructor Summary

Constructors

Constructor and Description
ExternalDocumentationObjectBuilder()

Method Summary

Modifier and Type	Method and Description
ExternalDocumentationObject	build()
static ExternalDocumentationObjectBuilder	externalDocumentationObject() Creates a builder for an ExternalDocumentationObject
ExternalDocumentationObjectBuilder	withDescription(String description)
ExternalDocumentationObjectBuilder	withUrl(URI url)

Methods inherited from class java.lang.Object

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

Constructor Detail

ExternalDocumentationObjectBuilder

public ExternalDocumentationObjectBuilder()

Method Detail

withDescription

public ExternalDocumentationObjectBuilder withDescription(String description)

Parameters:

description - A short description of the target documentation. CommonMark syntax MAY be used for rich text representation.

Returns:

The current builder

withUrl

public ExternalDocumentationObjectBuilder withUrl(URI url)

Parameters:

url - REQUIRED. The URL for the target documentation.

Returns:

The current builder

build

public ExternalDocumentationObject build()

externalDocumentationObject

public static ExternalDocumentationObjectBuilder externalDocumentationObject()

Creates a builder for an ExternalDocumentationObject

Returns:

A new builder