RestSchema

Abstract Value Members

abstract def createSchema(resolver: SchemaResolver): RefOr[Schema]

Creates a Schema object or external schema reference.
Creates a Schema object or external schema reference. May use SchemaResolver to resolve any dependent RestSchema instances. This method should be called directly only by SchemaResolver.
abstract def name: com.avsystem.commons.Opt[String]

Optional name of the schema.
Optional name of the schema. When RestSchema is named, schema created by createSchema will be registered under that name in SchemaRegistry and ultimately included into Components of the OpenApi document. All direct usages of the schema in OpenAPI document will be replaced by a reference to the registered schema, i.e. {"$$ref": "#/components/schemas/<schema-name>"}.
If schema is unnamed, it will be always inlined instead of being replaced by a reference.

Concrete Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def map[S](fun: (RefOr[Schema]) ⇒ Schema, newName: com.avsystem.commons.OptArg[String] = OptArg.Empty): RestSchema[S]
def named(name: String): RestSchema[T]
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
def unnamed: RestSchema[T]
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Docs: object RestSchema | package openapi

trait RestSchema[T] extends AnyRef

Abstract Value Members

abstract def createSchema(resolver: SchemaResolver): RefOr[Schema]

abstract def name: com.avsystem.commons.Opt[String]

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

def map[S](fun: (RefOr[Schema]) ⇒ Schema, newName: com.avsystem.commons.OptArg[String] = OptArg.Empty): RestSchema[S]

def named(name: String): RestSchema[T]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

def unnamed: RestSchema[T]

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from AnyRef

Inherited from Any

Ungrouped