Packages

class WebApiDeclarations extends Declarations

Declarations object.

Linear Supertypes
Declarations, AnyRef, Any
Known Subclasses
AsyncWebApiDeclarations, ExtensionWebApiDeclarations, OasLikeWebApiDeclarations, 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(), examples: Map[String, Example] = Map(), requests: Map[String, Request] = Map(), headers: Map[String, Parameter] = Map(), links: Map[String, TemplatedLink] = Map(), correlationIds: Map[String, CorrelationId] = Map(), callbacks: Map[String, List[Callback]] = Map(), messages: Map[String, Message] = Map(), messageBindings: Map[String, MessageBindings] = Map(), operationBindings: Map[String, OperationBindings] = Map(), channelBindings: Map[String, ChannelBindings] = Map(), serverBindings: Map[String, ServerBindings] = Map(), errorHandler: ErrorHandler, futureDeclarations: FutureDeclarations, others: Map[String, BaseUnit] = Map())

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. var callbacks: Map[String, List[Callback]]
  13. var channelBindings: Map[String, ChannelBindings]
  14. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  15. var correlationIds: Map[String, CorrelationId]
  16. def declarables(): Seq[DomainElement]
    Definition Classes
    WebApiDeclarations → Declarations
  17. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  19. def error(message: String, ast: YPart): Unit
    Attributes
    protected
    Definition Classes
    Declarations
  20. val errorHandler: ErrorHandler
  21. var examples: Map[String, Example]
  22. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  23. def findAnnotation(key: String, scope: Scope): Option[CustomDomainProperty]
    Definition Classes
    Declarations
  24. def findAnnotationOrError(ast: YPart)(key: String, scope: Scope): CustomDomainProperty
    Definition Classes
    Declarations
  25. def findCallbackInDeclarations(key: String): Option[List[Callback]]
  26. def findChannelBindings(key: String, scope: Scope): Option[ChannelBindings]
  27. def findCorrelationId(key: String, scope: Scope): Option[CorrelationId]
  28. def findDocumentations(key: String, scope: Scope, error: Option[(String) ⇒ Unit] = None): Option[CreativeWork]
  29. def findEquivalent(element: DomainElement): Option[DomainElement]

    Find domain element with the same name.

    Find domain element with the same name.

    Definition Classes
    WebApiDeclarations → Declarations
  30. def findExample(key: String, scope: Scope): Option[Example]
  31. def findForType(key: String, map: (Declarations) ⇒ Map[String, DomainElement], scope: Scope): Option[DomainElement]
    Definition Classes
    Declarations
  32. def findHeader(key: String, scope: Scope): Option[Parameter]
  33. def findMessage(key: String, scope: Scope): Option[Message]
  34. def findMessageBindings(key: String, scope: Scope): Option[MessageBindings]
  35. def findNamedExample(key: String, error: Option[(String) ⇒ Unit] = None): Option[Example]
  36. def findNamedExampleOrError(ast: YPart)(key: String): Example
  37. def findOperationBindings(key: String, scope: Scope): Option[OperationBindings]
  38. def findParameter(key: String, scope: Scope): Option[Parameter]
  39. def findParameterOrError(ast: YPart)(key: String, scope: Scope): Parameter
  40. def findPayload(key: String, scope: Scope): Option[Payload]
  41. def findRequestBody(key: String, scope: Scope): Option[Request]
  42. def findResourceType(key: String, scope: Scope, error: Option[(String) ⇒ Unit] = None): Option[ResourceType]
  43. def findResourceTypeOrError(ast: YPart)(key: String, scope: Scope): ResourceType
  44. def findResponse(key: String, scope: Scope): Option[Response]
  45. def findResponseOrError(ast: YPart)(key: String, searchScope: Scope): Response
  46. def findSecurityScheme(key: String, scope: Scope, error: Option[(String) ⇒ Unit] = None): Option[SecurityScheme]
  47. def findSecuritySchemeOrError(ast: YPart)(key: String, scope: Scope): SecurityScheme
  48. def findServerBindings(key: String, scope: Scope): Option[ServerBindings]
  49. def findTemplatedLink(key: String, scope: Scope): Option[TemplatedLink]
  50. def findTraitOrError(ast: YPart)(key: String, scope: Scope): Trait
  51. def findType(key: String, scope: Scope, error: Option[(String) ⇒ Unit] = None): Option[AnyShape]
  52. var fragments: Map[String, FragmentRef]
    Definition Classes
    Declarations
  53. var frags: Map[String, FragmentRef]
  54. val futureDeclarations: FutureDeclarations
  55. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  56. def getOrCreateLibrary(alias: String): WebApiDeclarations

    Get or create specified library.

    Get or create specified library.

    Definition Classes
    WebApiDeclarations → Declarations
  57. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  58. var headers: Map[String, Parameter]
  59. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  60. var libraries: Map[String, Declarations]
    Definition Classes
    Declarations
  61. var libs: Map[String, WebApiDeclarations]
  62. var links: Map[String, TemplatedLink]
  63. def merge(other: WebApiDeclarations): WebApiDeclarations
  64. def mergeParts(other: WebApiDeclarations, merged: WebApiDeclarations): Unit
    Attributes
    protected
  65. var messageBindings: Map[String, MessageBindings]
  66. var messages: Map[String, Message]
  67. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  68. def nonEmpty: Boolean
  69. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  70. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  71. var operationBindings: Map[String, OperationBindings]
  72. var others: Map[String, BaseUnit]
  73. def parameterPayload(parameter: Parameter): Payload
  74. var parameters: Map[String, Parameter]
  75. var payloads: Map[String, Payload]
  76. def promoteExternaltoDataTypeFragment(text: String, fullRef: String, shape: Shape): Shape
  77. var promotedFragments: Seq[Fragment]
    Definition Classes
    Declarations
  78. def registerHeader(header: Parameter): Unit
  79. def registerOasParameter(oasParameter: OasParameter): Unit
  80. var requests: Map[String, Request]
  81. var resourceTypes: Map[String, ResourceType]
  82. var responses: Map[String, Response]
  83. var securitySchemes: Map[String, SecurityScheme]
  84. var serverBindings: Map[String, ServerBindings]
  85. var shapes: Map[String, Shape]
  86. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  87. def toString(): String
    Definition Classes
    AnyRef → Any
  88. var traits: Map[String, Trait]
  89. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  90. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  91. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from Declarations

Inherited from AnyRef

Inherited from Any

Ungrouped