io.muserver.openapi

Class LinkObject

java.lang.Object

io.muserver.openapi.LinkObject

public class LinkObject
extends Object

See Also:

LinkObjectBuilder

Field Summary

Fields

Modifier and Type	Field and Description
String	description Deprecated. use description() instead
String	operationId Deprecated. use operationId() instead
Map<String,Object>	parameters Deprecated. use parameters() instead
Object	requestBody Deprecated. use requestBody() instead
ServerObject	server Deprecated. use server() instead

Method Summary

Modifier and Type	Method and Description
String	description()
String	operationId()
Map<String,Object>	parameters()
Object	requestBody()
ServerObject	server()
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

operationId

@Deprecated
public final String operationId

Deprecated. use operationId() instead

parameters

@Deprecated
public final Map<String,Object> parameters

Deprecated. use parameters() instead

requestBody

@Deprecated
public final Object requestBody

Deprecated. use requestBody() instead

description

@Deprecated
public final String description

Deprecated. use description() instead

server

@Deprecated
public final ServerObject server

Deprecated. use server() 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

operationId

public String operationId()

Returns:

the value described by LinkObjectBuilder.withOperationId(java.lang.String)

parameters

public Map<String,Object> parameters()

Returns:

the value described by LinkObjectBuilder.withParameters(java.util.Map<java.lang.String, java.lang.Object>)

requestBody

public Object requestBody()

Returns:

the value described by LinkObjectBuilder.withRequestBody(java.lang.Object)

description

public String description()

Returns:

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

server

public ServerObject server()

Returns:

the value described by LinkObjectBuilder.withServer(io.muserver.openapi.ServerObject)