tapir-openapi-model/sttp.tapir.openapi/Components

Components

final case class Components(schemas: ListMap[String, ReferenceOr[Schema]], responses: ListMap[String, ReferenceOr[Response]], parameters: ListMap[String, ReferenceOr[Parameter]], examples: ListMap[String, ReferenceOr[Example]], requestBodies: ListMap[String, ReferenceOr[RequestBody]], headers: ListMap[String, ReferenceOr[Header]], securitySchemes: ListMap[String, ReferenceOr[SecurityScheme]], links: ListMap[String, ReferenceOr[Link]], callbacks: ListMap[String, ReferenceOr[Callback]], extensions: ListMap[String, ExtensionValue])
Companion:
object
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any

Value members

Concrete methods

def addCallback(key: String, callback: Callback): Components
def addExample(key: String, example: Example): Components
def addExtension(key: String, value: ExtensionValue): Components
def addHeader(key: String, header: Header): Components
def addParameter(key: String, parameter: Parameter): Components
def addRequestBody(key: String, requestBody: RequestBody): Components
def addResponse(key: String, response: Response): Components
def addSchema(key: String, schema: Schema): Components
def addSecurityScheme(key: String, scheme: SecurityScheme): Components
def callbacks(updated: ListMap[String, ReferenceOr[Callback]]): Components
def examples(updated: ListMap[String, ReferenceOr[Example]]): Components
def extensions(updated: ListMap[String, ExtensionValue]): Components
def getLocalCallback(key: String): Option[Callback]
def getLocalExample(key: String): Option[Example]
def getLocalHeader(key: String): Option[Header]
def getLocalParameter(key: String): Option[Parameter]
def getLocalRequestBody(key: String): Option[RequestBody]
def getLocalResponse(key: String): Option[Response]
def getLocalSchema(key: String): Option[Schema]
def getLocalSecurityScheme(key: String): Option[SecurityScheme]
def getReferenceToCallback(key: String): Option[Reference]
def getReferenceToExample(key: String): Option[Reference]
def getReferenceToHeader(key: String): Option[Reference]
def getReferenceToParameter(key: String): Option[Reference]
def getReferenceToRequestBody(key: String): Option[Reference]
def getReferenceToResponse(key: String): Option[Reference]
def getReferenceToSchema(key: String): Option[Reference]
def getReferenceToSecurityScheme(key: String): Option[Reference]
def headers(updated: ListMap[String, ReferenceOr[Header]]): Components
def parameters(updated: ListMap[String, ReferenceOr[Parameter]]): Components
def requestBodies(updated: ListMap[String, ReferenceOr[RequestBody]]): Components
def responses(updated: ListMap[String, ReferenceOr[Response]]): Components
def schemas(updated: ListMap[String, ReferenceOr[Schema]]): Components
def securitySchemes(updated: ListMap[String, ReferenceOr[SecurityScheme]]): Components

Inherited methods

def productElementNames: Iterator[String]
Inherited from:
Product
def productIterator: Iterator[Any]
Inherited from:
Product