io.muserver.openapi

Class ExternalDocumentationObject

java.lang.Object

io.muserver.openapi.ExternalDocumentationObject

public class ExternalDocumentationObject
extends Object

See Also:

ExternalDocumentationObjectBuilder

Field Summary

Fields

Modifier and Type	Field and Description
String	description Deprecated. use description() instead
URI	url Deprecated. use url() instead

Method Summary

Modifier and Type	Method and Description
String	description()
URI	url()
void	writeJson(Writer writer) Writes this object as a JSON Object

Methods inherited from class java.lang.Object

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

Field Detail

description

@Deprecated
public final String description

Deprecated. use description() instead

url

@Deprecated
public final URI url

Deprecated. use url() instead

Method Detail

writeJson

public void writeJson(Writer writer)
               throws IOException

Writes this object as a JSON Object

Parameters:

writer - The writer to write to

Throws:

IOException - Thrown if the writer throws this while writing

description

public String description()

Returns:

the value described by ExternalDocumentationObjectBuilder.withDescription(java.lang.String)

url

public URI url()

Returns:

the value described by ExternalDocumentationObjectBuilder.withUrl(java.net.URI)