Packages

class WebApiDeclarations extends ShapeDeclarations

Declarations object.

Linear Supertypes
ShapeDeclarations, Declarations, AnyRef, Any
Known Subclasses
AsyncWebApiDeclarations, AwsOasWebApiDeclarations, ExtensionWebApiDeclarations, JsonSchemaDeclarations, OasLikeWebApiDeclarations, OasWebApiDeclarations, RamlWebApiDeclarations
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. WebApiDeclarations
  2. ShapeDeclarations
  3. Declarations
  4. AnyRef
  5. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new WebApiDeclarations(alias: Option[String], errorHandler: AMFErrorHandler, futureDeclarations: FutureDeclarations, extractor: QualifiedNameExtractor)

Type Members

  1. trait ErrorDeclaration extends AnyRef
    Definition Classes
    Declarations
  2. type Identity[T] = T
    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 +(other: String): String
    Implicit
    This member is added by an implicit conversion from WebApiDeclarations to any2stringadd[WebApiDeclarations] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def +=(indexKey: String, element: DomainElement): WebApiDeclarations.this.type
    Definition Classes
    WebApiDeclarations → ShapeDeclarations → Declarations
  5. def +=(doc: (String, (Shape, Map[String, Shape]))): WebApiDeclarations.this.type
    Definition Classes
    ShapeDeclarations
  6. def +=(extension: Map[String, Dialect]): ShapeDeclarations
    Definition Classes
    ShapeDeclarations
  7. def +=(element: DomainElement): WebApiDeclarations.this.type
    Definition Classes
    Declarations
  8. def +=(indexKey: String, fragment: Fragment): Declarations
    Definition Classes
    Declarations
  9. def ->[B](y: B): (WebApiDeclarations, B)
    Implicit
    This member is added by an implicit conversion from WebApiDeclarations to ArrowAssoc[WebApiDeclarations] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  10. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  11. def addLibrary(alias: String, declarations: Declarations): Unit
    Definition Classes
    WebApiDeclarations → Declarations
  12. def addSchema(indexKey: String, s: Shape): Unit
    Attributes
    protected
    Definition Classes
    ShapeDeclarations
  13. val alias: Option[String]
    Definition Classes
    ShapeDeclarations
  14. def aliased(name: String): String
    Definition Classes
    ShapeDeclarations
  15. var annotations: Map[String, CustomDomainProperty]
    Definition Classes
    Declarations
  16. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  17. var callbacks: Map[String, List[Callback]]
  18. var channelBindings: Map[String, ChannelBindings]
  19. var channels: Map[String, EndPoint]
  20. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @IntrinsicCandidate()
  21. def copy(): WebApiDeclarations
    Definition Classes
    WebApiDeclarations → ShapeDeclarations
  22. def copy[T <: ShapeDeclarations](next: T): T
    Definition Classes
    ShapeDeclarations
  23. var correlationIds: Map[String, CorrelationId]
  24. def declarables(): Seq[DomainElement]
    Definition Classes
    WebApiDeclarations → Declarations
  25. var documentFragments: Map[String, (Shape, Map[String, Shape])]
    Definition Classes
    ShapeDeclarations
  26. def ensuring(cond: (WebApiDeclarations) ⇒ Boolean, msg: ⇒ Any): WebApiDeclarations
    Implicit
    This member is added by an implicit conversion from WebApiDeclarations to Ensuring[WebApiDeclarations] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  27. def ensuring(cond: (WebApiDeclarations) ⇒ Boolean): WebApiDeclarations
    Implicit
    This member is added by an implicit conversion from WebApiDeclarations to Ensuring[WebApiDeclarations] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  28. def ensuring(cond: Boolean, msg: ⇒ Any): WebApiDeclarations
    Implicit
    This member is added by an implicit conversion from WebApiDeclarations to Ensuring[WebApiDeclarations] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  29. def ensuring(cond: Boolean): WebApiDeclarations
    Implicit
    This member is added by an implicit conversion from WebApiDeclarations to Ensuring[WebApiDeclarations] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  30. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  31. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  32. def error(message: String, pos: SourceLocation): Unit
    Attributes
    protected
    Definition Classes
    Declarations
  33. val errorHandler: AMFErrorHandler
  34. var examples: Map[String, Example]
    Definition Classes
    ShapeDeclarations
  35. var extensions: Map[String, Dialect]
    Definition Classes
    ShapeDeclarations
  36. var externalLibs: Map[String, Map[String, AnyShape]]
    Definition Classes
    ShapeDeclarations
  37. var externalShapes: Map[String, AnyShape]
    Definition Classes
    ShapeDeclarations
  38. val extractor: QualifiedNameExtractor
  39. def findAnnotation(key: String, scope: Scope): Option[CustomDomainProperty]
    Definition Classes
    Declarations
  40. def findAnnotationOrError(pos: SourceLocation)(key: String, scope: Scope): CustomDomainProperty
    Definition Classes
    Declarations
  41. def findCallbackInDeclarations(key: String, scope: Scope = Named): Option[List[Callback]]
  42. def findChannel(key: String, scope: Scope): Option[EndPoint]
  43. def findChannelBindings(key: String, scope: Scope): Option[ChannelBindings]
  44. def findCorrelationId(key: String, scope: Scope): Option[CorrelationId]
  45. def findDeclaredTypeInDocFragment(doc: String, name: String): Option[Shape]
    Definition Classes
    ShapeDeclarations
  46. def findDialect(key: String): Option[Dialect]
  47. def findDocumentations(key: String, scope: Scope, error: Option[(String) ⇒ Unit]): Option[CreativeWork]
    Definition Classes
    ShapeDeclarations
  48. def findEncodedTypeInDocFragment(doc: String): Option[Shape]
    Definition Classes
    ShapeDeclarations
  49. def findEquivalent(element: DomainElement): Option[DomainElement]

    Find domain element with the same name.

    Find domain element with the same name.

    Definition Classes
    WebApiDeclarations → Declarations
  50. def findExample(key: String, scope: Scope): Option[Example]
    Definition Classes
    ShapeDeclarations
  51. def findForType(key: String, map: (Declarations) ⇒ Map[String, DomainElement], scope: Scope): Option[DomainElement]
    Definition Classes
    Declarations
  52. def findHeader(key: String, scope: Scope): Option[Parameter]
  53. def findInExternals(url: String): Option[AnyShape]
    Definition Classes
    ShapeDeclarations
  54. def findInExternalsLibs(lib: String, name: String): Option[AnyShape]
    Definition Classes
    ShapeDeclarations
  55. def findManyForType(key: String, map: (Declarations) ⇒ Map[String, List[DomainElement]], scope: Scope): Option[List[DomainElement]]
    Definition Classes
    Declarations
  56. def findMessage(key: String, scope: Scope): Option[Message]
  57. def findMessageBindings(key: String, scope: Scope): Option[MessageBindings]
  58. def findMessageTrait(key: String, scope: Scope): Option[Message]
  59. def findNamedExample(key: String, error: Option[(String) ⇒ Unit]): Option[Example]
    Definition Classes
    ShapeDeclarations
  60. def findNamedExampleOrError(ast: YPart)(key: String): Example
    Definition Classes
    ShapeDeclarations
  61. def findOperationBindings(key: String, scope: Scope): Option[OperationBindings]
  62. def findOperationTrait(key: String, scope: Scope): Option[Operation]
  63. def findParameter(key: String, scope: Scope): Option[Parameter]
  64. def findParameterOrError(ast: YPart)(key: String, scope: Scope): Parameter
  65. def findPayload(key: String, scope: Scope): Option[Payload]
  66. def findRequestBody(key: String, scope: Scope): Option[Request]
  67. def findResourceType(key: String, scope: Scope, error: Option[(String) ⇒ Unit] = None): Option[ResourceType]
  68. def findResourceTypeOrError(ast: YPart)(key: String, scope: Scope): ResourceType
  69. def findResponse(key: String, scope: Scope): Option[Response]
  70. def findResponseOrError(ast: YPart)(key: String, searchScope: Scope): Response
  71. def findSecurityScheme(key: String, scope: Scope, error: Option[(String) ⇒ Unit] = None): Option[SecurityScheme]
  72. def findSecuritySchemeOrError(ast: YPart)(key: String, scope: Scope): SecurityScheme
  73. def findServer(key: String, scope: Scope): Option[Server]
  74. def findServerBindings(key: String, scope: Scope): Option[ServerBindings]
  75. def findServerVariable(key: String, scope: Scope): Option[Parameter]
  76. def findTemplatedLink(key: String, scope: Scope): Option[TemplatedLink]
  77. def findTraitOrError(ast: YPart)(key: String, scope: Scope): Trait
  78. def findType(key: String, scope: Scope, error: Option[(String) ⇒ Unit]): Option[AnyShape]
    Definition Classes
    ShapeDeclarations
  79. var fragments: Map[String, FragmentRef]
    Definition Classes
    Declarations
  80. val futureDeclarations: FutureDeclarations
  81. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  82. def getOrCreateLibrary(alias: String): WebApiDeclarations

    Get or create specified library.

    Get or create specified library.

    Definition Classes
    WebApiDeclarations → Declarations
  83. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  84. var headers: Map[String, Parameter]
  85. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  86. var libraries: Map[String, Declarations]
    Definition Classes
    Declarations
  87. var links: Map[String, TemplatedLink]
  88. def merge(other: WebApiDeclarations): WebApiDeclarations
  89. def mergeParts(other: WebApiDeclarations, merged: WebApiDeclarations): Unit
    Attributes
    protected
  90. var messageBindings: Map[String, MessageBindings]
  91. var messageTraits: Map[String, Message]
  92. var messages: Map[String, Message]
  93. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  94. def nonEmpty: Boolean
  95. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  96. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  97. var operationBindings: Map[String, OperationBindings]
  98. var operationTraits: Map[String, Operation]
  99. var others: Map[String, BaseUnit]
  100. def parameterPayload(parameter: Parameter): Payload
  101. var parameters: Map[String, Parameter]
  102. var payloads: Map[String, Payload]
  103. def promoteExternalToDataTypeFragment(text: String, fullRef: String, shape: Shape): Unit
    Definition Classes
    ShapeDeclarations
  104. var promotedFragments: Seq[Fragment]
    Definition Classes
    Declarations
  105. def registerExternalLib(url: String, content: Map[String, AnyShape]): ShapeDeclarations
    Definition Classes
    ShapeDeclarations
  106. def registerExternalRef(external: (String, AnyShape)): ShapeDeclarations
    Definition Classes
    ShapeDeclarations
  107. def registerHeader(header: Parameter): Unit
  108. def registerOasParameter(oasParameter: OasParameter): Unit
  109. var requests: Map[String, Request]
  110. var resourceTypes: Map[String, ResourceType]
  111. var responses: Map[String, Response]
  112. var securitySchemes: Map[String, SecurityScheme]
  113. var serverBindings: Map[String, ServerBindings]
  114. var serverVariables: Map[String, Parameter]
  115. var servers: Map[String, Server]
  116. def setLibraries(libraries: Map[String, Declarations]): Unit
  117. var shapes: Map[String, Shape]
    Definition Classes
    ShapeDeclarations
  118. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  119. def toString(): String
    Definition Classes
    AnyRef → Any
  120. var traits: Map[String, Trait]
  121. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  122. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  123. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  124. def withExtensions(extensions: Map[String, Dialect]): ShapeDeclarations
    Definition Classes
    ShapeDeclarations
  125. def →[B](y: B): (WebApiDeclarations, B)
    Implicit
    This member is added by an implicit conversion from WebApiDeclarations to ArrowAssoc[WebApiDeclarations] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated
  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from WebApiDeclarations to StringFormat[WebApiDeclarations] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

Inherited from ShapeDeclarations

Inherited from Declarations

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from WebApiDeclarations to any2stringadd[WebApiDeclarations]

Inherited by implicit conversion StringFormat from WebApiDeclarations to StringFormat[WebApiDeclarations]

Inherited by implicit conversion Ensuring from WebApiDeclarations to Ensuring[WebApiDeclarations]

Inherited by implicit conversion ArrowAssoc from WebApiDeclarations to ArrowAssoc[WebApiDeclarations]

Ungrouped