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

    Find domain element with the same name.

    Find domain element with the same name.

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

    Get or create specified library.

    Get or create specified library.

    Definition Classes
    WebApiDeclarations → Declarations
  49. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  50. var headers: Map[String, Parameter]
  51. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  52. var libraries: Map[String, Declarations]
    Definition Classes
    Declarations
  53. var libs: Map[String, WebApiDeclarations]
  54. var links: Map[String, TemplatedLink]
  55. def merge(other: WebApiDeclarations): WebApiDeclarations
  56. def mergeParts(other: WebApiDeclarations, merged: WebApiDeclarations): Unit
    Attributes
    protected
  57. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  58. def nonEmpty: Boolean
  59. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  60. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  61. var others: Map[String, BaseUnit]
  62. def parameterPayload(parameter: Parameter): Payload
  63. var parameters: Map[String, Parameter]
  64. var payloads: Map[String, Payload]
  65. def promoteExternaltoDataTypeFragment(text: String, fullRef: String, shape: Shape): Shape
  66. var promotedFragments: Seq[Fragment]
    Definition Classes
    Declarations
  67. def registerHeader(header: Parameter): Unit
  68. def registerOasParameter(oasParameter: OasParameter): Unit
  69. var requests: Map[String, Request]
  70. var resourceTypes: Map[String, ResourceType]
  71. var responses: Map[String, Response]
  72. var securitySchemes: Map[String, SecurityScheme]
  73. var shapes: Map[String, Shape]
  74. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  75. def toString(): String
    Definition Classes
    AnyRef → Any
  76. var traits: Map[String, Trait]
  77. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  78. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  79. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from Declarations

Inherited from AnyRef

Inherited from Any

Ungrouped