Packages

class WebApiDeclarations extends Declarations

Declarations object.

Linear Supertypes
Declarations, AnyRef, Any
Known Subclasses
ExtensionWebApiDeclarations, OasWebApiDeclarations, RamlWebApiDeclarations
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. WebApiDeclarations
  2. Declarations
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new WebApiDeclarations(alias: Option[String], libs: Map[String, WebApiDeclarations] = Map(), frags: Map[String, FragmentRef] = Map(), shapes: Map[String, Shape] = Map(), anns: Map[String, CustomDomainProperty] = Map(), resourceTypes: Map[String, ResourceType] = Map(), parameters: Map[String, Parameter] = Map(), payloads: Map[String, Payload] = Map(), traits: Map[String, Trait] = Map(), securitySchemes: Map[String, SecurityScheme] = Map(), responses: Map[String, Response] = Map(), errorHandler: Option[ErrorHandler], futureDeclarations: FutureDeclarations)

Type Members

  1. trait ErrorDeclaration extends AnyRef
    Definition Classes
    Declarations

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def +=(element: DomainElement): WebApiDeclarations
    Definition Classes
    WebApiDeclarations → Declarations
  4. def +=(fragment: (String, Fragment)): Declarations
    Definition Classes
    Declarations
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. def addSchema(s: Shape): Unit
    Attributes
    protected
  7. val alias: Option[String]
  8. def aliased(name: String): String
  9. var annotations: Map[String, CustomDomainProperty]
    Definition Classes
    Declarations
  10. var anns: Map[String, CustomDomainProperty]
  11. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  12. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  13. def declarables(): Seq[DomainElement]
    Definition Classes
    WebApiDeclarations → Declarations
  14. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  16. def error(message: String, ast: YPart): Unit
    Attributes
    protected
    Definition Classes
    Declarations
  17. val errorHandler: Option[ErrorHandler]
  18. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  19. def findAnnotation(key: String, scope: Scope): Option[CustomDomainProperty]
    Definition Classes
    Declarations
  20. def findAnnotationOrError(ast: YPart)(key: String, scope: Scope): CustomDomainProperty
    Definition Classes
    Declarations
  21. def findDocumentations(key: String, scope: Scope, error: Option[(String) ⇒ Unit] = None): Option[CreativeWork]
  22. def findEquivalent(element: DomainElement): Option[DomainElement]

    Find domain element with the same name.

    Find domain element with the same name.

    Definition Classes
    WebApiDeclarations → Declarations
  23. def findForType(key: String, map: (Declarations) ⇒ Map[String, DomainElement], scope: Scope): Option[DomainElement]
    Definition Classes
    Declarations
  24. def findNamedExample(key: String, error: Option[(String) ⇒ Unit] = None): Option[Example]
  25. def findNamedExampleOrError(ast: YPart)(key: String): Example
  26. def findParameter(key: String, scope: Scope): Option[Parameter]
  27. def findParameterOrError(ast: YPart)(key: String, scope: Scope): Parameter
  28. def findPayload(key: String, scope: Scope): Option[Payload]
  29. def findResourceType(key: String, scope: Scope, error: Option[(String) ⇒ Unit] = None): Option[ResourceType]
  30. def findResourceTypeOrError(ast: YPart)(key: String, scope: Scope): ResourceType
  31. def findResponse(key: String, scope: Scope): Option[Response]
  32. def findResponseOrError(ast: YPart)(key: String, searchScope: Scope): Response
  33. def findSecurityScheme(key: String, scope: Scope, error: Option[(String) ⇒ Unit] = None): Option[SecurityScheme]
  34. def findSecuritySchemeOrError(ast: YPart)(key: String, scope: Scope): SecurityScheme
  35. def findTraitOrError(ast: YPart)(key: String, scope: Scope): Trait
  36. def findType(key: String, scope: Scope, error: Option[(String) ⇒ Unit] = None): Option[AnyShape]
  37. var fragments: Map[String, FragmentRef]
    Definition Classes
    Declarations
  38. var frags: Map[String, FragmentRef]
  39. val futureDeclarations: FutureDeclarations
  40. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  41. def getOrCreateLibrary(alias: String): WebApiDeclarations

    Get or create specified library.

    Get or create specified library.

    Definition Classes
    WebApiDeclarations → Declarations
  42. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  43. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  44. var libraries: Map[String, Declarations]
    Definition Classes
    Declarations
  45. var libs: Map[String, WebApiDeclarations]
  46. def merge(other: WebApiDeclarations): WebApiDeclarations
  47. def mergeParts(other: WebApiDeclarations, merged: WebApiDeclarations): Unit
    Attributes
    protected
  48. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  49. def nonEmpty: Boolean
  50. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  51. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  52. def parameterPayload(parameter: Parameter): Payload
  53. var parameters: Map[String, Parameter]
  54. var payloads: Map[String, Payload]
  55. def promoteExternaltoDataTypeFragment(text: String, fullRef: String, shape: Shape): Shape
  56. var promotedFragments: Seq[Fragment]
    Definition Classes
    Declarations
  57. def registerOasParameter(oasParameter: OasParameter): Unit
  58. var resourceTypes: Map[String, ResourceType]
  59. var responses: Map[String, Response]
  60. var securitySchemes: Map[String, SecurityScheme]
  61. var shapes: Map[String, Shape]
  62. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  63. def toString(): String
    Definition Classes
    AnyRef → Any
  64. var traits: Map[String, Trait]
  65. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  66. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  67. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from Declarations

Inherited from AnyRef

Inherited from Any

Ungrouped