Package io.muserver.openapi

Class OperationObject

java.lang.Object

io.muserver.openapi.OperationObject

public class OperationObject
extends java.lang.Object

See Also:

OperationObjectBuilder

Method Summary

Modifier and Type	Method	Description
java.util.Map<java.lang.String,CallbackObject>	callbacks()
java.lang.Boolean	deprecated()
java.lang.String	description()
ExternalDocumentationObject	externalDocs()
boolean	isDeprecated()
java.lang.String	operationId()
java.util.List<ParameterObject>	parameters()
RequestBodyObject	requestBody()
ResponsesObject	responses()
java.util.List<SecurityRequirementObject>	security()
java.util.List<ServerObject>	servers()
java.lang.String	summary()
java.util.List<java.lang.String>	tags()
void	writeJson(java.io.Writer writer)

Methods inherited from class java.lang.Object

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

Method Detail

writeJson

public void writeJson(java.io.Writer writer)
               throws java.io.IOException

Throws:

java.io.IOException

isDeprecated

public boolean isDeprecated()

Returns:

the value described by OperationObjectBuilder.withDeprecated(Boolean), or false if not specified when building

tags

public java.util.List<java.lang.String> tags()

Returns:

the value described by OperationObjectBuilder.withTags(java.util.List<java.lang.String>)

summary

public java.lang.String summary()

Returns:

the value described by OperationObjectBuilder.withSummary(java.lang.String)

description

public java.lang.String description()

Returns:

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

externalDocs

public ExternalDocumentationObject externalDocs()

Returns:

the value described by OperationObjectBuilder.withExternalDocs(io.muserver.openapi.ExternalDocumentationObject)

operationId

public java.lang.String operationId()

Returns:

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

parameters

public java.util.List<ParameterObject> parameters()

Returns:

the value described by OperationObjectBuilder.withParameters(java.util.List<io.muserver.openapi.ParameterObject>)

requestBody

public RequestBodyObject requestBody()

Returns:

the value described by OperationObjectBuilder.withRequestBody(io.muserver.openapi.RequestBodyObject)

responses

public ResponsesObject responses()

Returns:

the value described by OperationObjectBuilder.withResponses(io.muserver.openapi.ResponsesObject)

callbacks

public java.util.Map<java.lang.String,CallbackObject> callbacks()

Returns:

the value described by OperationObjectBuilder.withCallbacks(java.util.Map<java.lang.String, io.muserver.openapi.CallbackObject>)

deprecated

public java.lang.Boolean deprecated()

Returns:

the value described by OperationObjectBuilder.withDeprecated(java.lang.Boolean)

security

public java.util.List<SecurityRequirementObject> security()

Returns:

the value described by OperationObjectBuilder.withSecurity(java.util.List<io.muserver.openapi.SecurityRequirementObject>)

servers

public java.util.List<ServerObject> servers()

Returns:

the value described by OperationObjectBuilder.withServers(java.util.List<io.muserver.openapi.ServerObject>)