Packages

object OverlayModel extends ExtensionLikeModel

An overlay adds or overrides nodes of a RAML API definition while preserving its behavioral, functional aspects. Certain nodes of a RAML API definition specify the behavior of an API: its resources, methods, parameters, bodies, responses, and so on. These nodes cannot be changed by applying an overlay. In contrast, other nodes, such as descriptions or annotations, address concerns beyond the functional interface, such as the human-oriented descriptive documentation in some language, or implementation or verification information for use in automated tools. These nodes can be changed by applying an overlay.

Linear Supertypes
ExtensionLikeModel, DocumentModel, ModuleModel, FragmentModel, BaseUnitModel, ModelDefaultBuilder, Obj, Type, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. OverlayModel
  2. ExtensionLikeModel
  3. DocumentModel
  4. ModuleModel
  5. FragmentModel
  6. BaseUnitModel
  7. ModelDefaultBuilder
  8. Obj
  9. Type
  10. AnyRef
  11. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. lazy val CustomDomainProperties: Field
    Definition Classes
    ModuleModel
  5. val Declares: Field
    Definition Classes
    ModuleModel
  6. val DescribedBy: Field
    Definition Classes
    BaseUnitModel
  7. val Encodes: Field
    Definition Classes
    FragmentModel
  8. val Extends: Field
    Definition Classes
    ExtensionLikeModel
  9. val Location: Field
    Definition Classes
    BaseUnitModel
  10. val ModelVersion: Field
    Definition Classes
    BaseUnitModel
  11. val References: Field
    Definition Classes
    BaseUnitModel
  12. val Root: Field
    Definition Classes
    BaseUnitModel
  13. val Usage: Field
    Definition Classes
    BaseUnitModel
  14. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  15. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  16. val doc: ModelDoc
    Definition Classes
    OverlayModel → Obj
  17. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  19. val fields: List[Field]
    Definition Classes
    ExtensionLikeModel → DocumentModel → Obj
  20. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  21. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  22. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  23. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  24. def modelInstance: Overlay
    Definition Classes
    OverlayModel → ModuleModel → FragmentModel → ModelDefaultBuilder
  25. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  26. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  27. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  28. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  29. def toString(): String
    Definition Classes
    AnyRef → Any
  30. val type: List[ValueType]
    Definition Classes
    OverlayModel → DocumentModel → Type
  31. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  32. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  33. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from ExtensionLikeModel

Inherited from DocumentModel

Inherited from ModuleModel

Inherited from FragmentModel

Inherited from BaseUnitModel

Inherited from ModelDefaultBuilder

Inherited from Obj

Inherited from Type

Inherited from AnyRef

Inherited from Any

Ungrouped