Class

com.avsystem.commons.rest.openapi.adjusters

description

Related Doc: package adjusters

Permalink

class description extends Annotation with SchemaAdjuster with ParameterAdjuster with OperationAdjuster

Annotation that specifies description that will be included into generated OpenAPI specification. It can be applied on REST methods (OperationAdjuster), path/header/query parameters (ParameterAdjuster), body parameters (SchemaAdjuster), case class fields (SchemaAdjuster) and ADTs for which RestStructure is macro generated (SchemaAdjuster).

Linear Supertypes
OperationAdjuster, ParameterAdjuster, SchemaAdjuster, NotInheritedFromSealedTypes, Adjuster, StaticAnnotation, Annotation, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. description
  2. OperationAdjuster
  3. ParameterAdjuster
  4. SchemaAdjuster
  5. NotInheritedFromSealedTypes
  6. Adjuster
  7. StaticAnnotation
  8. Annotation
  9. AnyRef
  10. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new description(desc: String)

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  4. def adjustOperation(operation: Operation): Operation

    Permalink
    Definition Classes
    description → OperationAdjuster

  5. def adjustParameter(parameter: Parameter): Parameter

    Permalink
    Definition Classes
    description → ParameterAdjuster

  6. def adjustSchema(schema: Schema): Schema

    Permalink
    Definition Classes
    description → SchemaAdjuster

  7. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  8. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  9. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  10. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  11. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  12. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  13. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  14. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  15. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  16. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  17. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

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

    Permalink
    Definition Classes
    AnyRef

  19. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  20. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  22. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from OperationAdjuster

Inherited from ParameterAdjuster

Inherited from SchemaAdjuster

Inherited from NotInheritedFromSealedTypes

Inherited from Adjuster

Inherited from StaticAnnotation

Inherited from Annotation

Inherited from AnyRef

Inherited from Any

Ungrouped