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(), operationTraits: Map[String, Operation] = Map(), messageTraits: Map[String, Message] = 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 findMessageTrait(key: String, scope: Scope): Option[Message]
  36. def findNamedExample(key: String, error: Option[(String) ⇒ Unit] = None): Option[Example]
  37. def findNamedExampleOrError(ast: YPart)(key: String): Example
  38. def findOperationBindings(key: String, scope: Scope): Option[OperationBindings]
  39. def findOperationTrait(key: String, scope: Scope): Option[Operation]
  40. def findParameter(key: String, scope: Scope): Option[Parameter]
  41. def findParameterOrError(ast: YPart)(key: String, scope: Scope): Parameter
  42. def findPayload(key: String, scope: Scope): Option[Payload]
  43. def findRequestBody(key: String, scope: Scope): Option[Request]
  44. def findResourceType(key: String, scope: Scope, error: Option[(String) ⇒ Unit] = None): Option[ResourceType]
  45. def findResourceTypeOrError(ast: YPart)(key: String, scope: Scope): ResourceType
  46. def findResponse(key: String, scope: Scope): Option[Response]
  47. def findResponseOrError(ast: YPart)(key: String, searchScope: Scope): Response
  48. def findSecurityScheme(key: String, scope: Scope, error: Option[(String) ⇒ Unit] = None): Option[SecurityScheme]
  49. def findSecuritySchemeOrError(ast: YPart)(key: String, scope: Scope): SecurityScheme
  50. def findServerBindings(key: String, scope: Scope): Option[ServerBindings]
  51. def findTemplatedLink(key: String, scope: Scope): Option[TemplatedLink]
  52. def findTraitOrError(ast: YPart)(key: String, scope: Scope): Trait
  53. def findType(key: String, scope: Scope, error: Option[(String) ⇒ Unit] = None): Option[AnyShape]
  54. var fragments: Map[String, FragmentRef]
    Definition Classes
    Declarations
  55. var frags: Map[String, FragmentRef]
  56. val futureDeclarations: FutureDeclarations
  57. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  58. def getOrCreateLibrary(alias: String): WebApiDeclarations

    Get or create specified library.

    Get or create specified library.

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

Inherited from Declarations

Inherited from AnyRef

Inherited from Any

Ungrouped