Operation

sttp.apispec.openapi.Operation
See theOperation companion object
final case class Operation(tags: List[String], summary: Option[String], description: Option[String], externalDocs: Option[ExternalDocumentation], operationId: Option[String], parameters: List[ReferenceOr[Parameter]], requestBody: Option[ReferenceOr[RequestBody]], responses: Responses, callbacks: ListMap[String, ReferenceOr[Callback]], deprecated: Option[Boolean], security: List[SecurityRequirement], servers: List[Server], extensions: ListMap[String, ExtensionValue])

Attributes

Companion
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

def addCallback(key: String, callback: Callback): Operation
def addCallbackReference(key: String, referenceKey: String): Operation
def addExtension(key: String, value: ExtensionValue): Operation
def addResponse(status: Int, updated: Response): Operation
def addSecurity(updated: SecurityRequirement): Operation
def addServer(server: Server): Operation
def addTag(updated: String): Operation
def callbacks(updated: ListMap[String, ReferenceOr[Callback]]): Operation
def deprecated(updated: Boolean): Operation
def description(updated: String): Operation
def extensions(updated: ListMap[String, ExtensionValue]): Operation
def externalDocs(updated: ExternalDocumentation): Operation
def operationId(updated: String): Operation
def security(updated: List[SecurityRequirement]): Operation
def servers(updated: List[Server]): Operation
def summary(updated: String): Operation

Inherited methods

def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product