SchemaAdjuster

Base trait for annotations which may adjust Schema derived for various symbols in REST API traits. Schema adjusters may be applied on:

- Types for which RestStructure is macro materialized and RestSchema derived from it. This includes all types with companion extending RestDataCompanion.

- Fields of case classes for which RestStructure is macro materialized.

- Body parameters of REST methods.

Schema adjusters DO NOT WORK on REST methods themselves and their path/header/query/cookie parameters. Instead, use OperationAdjuster and ParameterAdjuster.

Also, be aware that schema adjusters may also be applied on schema references. In such cases, the schema reference is wrapped into a Schema object with allOf property containing the original reference. This effectively allows you to extend the referenced schema but you cannot inspect it in the process.

Linear Supertypes

NotInheritedFromSealedTypes, Adjuster, StaticAnnotation, Annotation, AnyRef, Any

Known Subclasses

adjustSchema, description, example, nullable, schemaDescription, title

Abstract Value Members

abstract def adjustSchema(schema: Schema): Schema

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
@HotSpotIntrinsicCandidate() @throws( ... )
final def eq(arg0: AnyRef): Boolean

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

Definition Classes
AnyRef → Any
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
Annotations
@HotSpotIntrinsicCandidate()
def hashCode(): Int

Definition Classes
AnyRef → Any
Annotations
@HotSpotIntrinsicCandidate()
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
Annotations
@HotSpotIntrinsicCandidate()
final def notifyAll(): Unit

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

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(arg0: Long, arg1: Int): Unit

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )

Deprecated Value Members

def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
Deprecated
(Since version ) see corresponding Javadoc for more information.

Related Docs: object SchemaAdjuster | package adjusters

trait SchemaAdjuster extends Annotation with Adjuster with NotInheritedFromSealedTypes

Abstract Value Members

abstract def adjustSchema(schema: Schema): Schema

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

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

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

def toString(): String

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

final def wait(arg0: Long): Unit

final def wait(): Unit

Deprecated Value Members

def finalize(): Unit

Inherited from NotInheritedFromSealedTypes

Inherited from Adjuster

Inherited from StaticAnnotation

Inherited from Annotation

Inherited from AnyRef

Inherited from Any

Ungrouped