Packages

abstract class RamlWebApiContext extends WebApiContext with RamlSpecAwareContext

Linear Supertypes
RamlSpecAwareContext, WebApiContext, JsonSchemaInference, PlatformSecrets, SpecAwareContext, ParserContext, Serializable, Serializable, Product, Equals, IllegalTypeHandler, ParseErrorHandler, AnyRef, Any
Known Subclasses
ExtensionLikeWebApiContext, PayloadContext, Raml08WebApiContext, Raml10WebApiContext, CustomRaml08WebApiContext, CustomRaml10WebApiContext
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RamlWebApiContext
  2. RamlSpecAwareContext
  3. WebApiContext
  4. JsonSchemaInference
  5. PlatformSecrets
  6. SpecAwareContext
  7. ParserContext
  8. Serializable
  9. Serializable
  10. Product
  11. Equals
  12. IllegalTypeHandler
  13. ParseErrorHandler
  14. AnyRef
  15. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new RamlWebApiContext(loc: String, refs: Seq[ParsedReference], options: ParsingOptions, wrapped: ParserContext, ds: Option[RamlWebApiDeclarations] = None, contextType: RamlWebApiContextType = RamlWebApiContextType.DEFAULT)

Abstract Value Members

  1. abstract def clone(declarations: RamlWebApiDeclarations): RamlWebApiContext
    Attributes
    protected
  2. abstract val factory: RamlSpecVersionFactory
    Definition Classes
    RamlWebApiContext → SpecAwareContext
  3. abstract val syntax: SpecSyntax
    Definition Classes
    WebApiContext
  4. abstract val vendor: Vendor
    Definition Classes
    WebApiContext

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def adapt[T](path: String)(k: (RamlWebApiContext) ⇒ T): T

    Adapt this context for a nested library, used when evaluating resource type / traits Using a path to the library whose context is going to be looked up, e.g.

    Adapt this context for a nested library, used when evaluating resource type / traits Using a path to the library whose context is going to be looked up, e.g. lib.TypeA

  5. def addSonRef(ref: BaseUnit): RamlWebApiContext.this.type
    Definition Classes
    ParserContext
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def autoGeneratedAnnotation(s: Shape): Unit
    Definition Classes
    RamlWebApiContext → WebApiContext
  8. def basePath(path: String): String
    Definition Classes
    WebApiContext
  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  10. def closedRamlTypeShape(shape: Shape, ast: YMap, shapeType: String, typeInfo: TypeInfo): Unit

    raml types nodes are different from other shapes because they can have 'custom facets' essentially, client defined constraints expressed as additional properties syntactically in the type definition.

    raml types nodes are different from other shapes because they can have 'custom facets' essentially, client defined constraints expressed as additional properties syntactically in the type definition. The problem is that they cannot be recognised just looking into the AST as we do with annotations, so we need to first, compute them, and then, add them as additional valid properties to the set of properties that can be defined in the AST node

  11. def closedShape(node: String, ast: YMap, shape: String, syntax: SpecSyntax): Unit
    Attributes
    protected
    Definition Classes
    WebApiContext
  12. def closedShape(node: String, ast: YMap, shape: String): Unit

    Validate closed shape.

    Validate closed shape.

    Definition Classes
    WebApiContext
  13. def computeJsonSchemaVersion(ast: YNode): SchemaVersion
    Definition Classes
    WebApiContext
  14. var contextType: RamlWebApiContextType
  15. def copyWithSonsReferences(): ParserContext
    Definition Classes
    ParserContext
  16. val declarations: RamlWebApiDeclarations
    Definition Classes
    RamlWebApiContext → WebApiContext
  17. val defaultSchemaVersion: JSONSchemaVersion
    Definition Classes
    WebApiContext → JsonSchemaInference
  18. val eh: ParserErrorHandler
    Definition Classes
    ParserContext
  19. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  21. def findDeclarations(path: Seq[String], declarations: RamlWebApiDeclarations): RamlWebApiDeclarations
    Attributes
    protected
  22. def findJsonPathIn(index: AstIndex, path: String): Option[YMapEntryLike]
    Definition Classes
    WebApiContext
  23. def findJsonSchema(url: String): Option[AnyShape]
    Definition Classes
    WebApiContext
  24. def findLocalJSONPath(path: String): Option[YMapEntryLike]
    Definition Classes
    WebApiContext
  25. def forLocation(newLocation: String): ParserContext
    Definition Classes
    ParserContext
  26. val futureDeclarations: FutureDeclarations
    Definition Classes
    ParserContext
  27. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  28. def getEntryKey(entry: YMapEntry): String
    Definition Classes
    WebApiContext
  29. var globalMediatype: Boolean
  30. var globalSpace: Map[String, Any]
    Definition Classes
    ParserContext
  31. def handle[T](error: YError, defaultValue: T): T
    Definition Classes
    ParserContext → IllegalTypeHandler
  32. def handle(location: SourceLocation, e: SyamlException): Unit
    Definition Classes
    ParserContext → ParseErrorHandler
  33. def ignore(shape: String, property: String): Boolean
    Definition Classes
    RamlWebApiContext → WebApiContext
  34. var indexCache: Map[String, AstIndex]
    Definition Classes
    WebApiContext
  35. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  36. var jsonSchemaRefGuide: JsonSchemaRefGuide
    Definition Classes
    WebApiContext
  37. def link(node: YNode): Either[String, YNode]
    Definition Classes
    RamlWebApiContext → WebApiContext
  38. val loc: String
    Definition Classes
    RamlWebApiContext → WebApiContext
  39. var localJSONSchemaContext: Option[YNode]
    Definition Classes
    WebApiContext
  40. def mergeAllOperationContexts(): Unit
  41. def mergeContext(subContext: RamlWebApiContext): Unit
  42. def mergeOperationContext(operation: String): Unit
  43. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  44. def nextValidation(node: String, shape: String, ast: YMap): Unit
    Attributes
    protected
    Definition Classes
    WebApiContext
  45. def normalizedJsonPointer(url: String): String
    Attributes
    protected
    Definition Classes
    WebApiContext
  46. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  47. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  48. def obtainRemoteYNode(ref: String, refAnnotations: Annotations = Annotations())(implicit ctx: WebApiContext): Option[YNode]
    Definition Classes
    WebApiContext
  49. val operationContexts: Map[String, RamlWebApiContext]
  50. val options: ParsingOptions
    Definition Classes
    WebApiContext
  51. def parseRemoteOasParameter(fileUrl: String, parentId: String)(implicit ctx: OasWebApiContext): Option[OasParameter]
    Definition Classes
    WebApiContext
  52. def parseSchemaVersion(ast: YNode, errorHandler: ErrorHandler): SchemaVersion
    Definition Classes
    JsonSchemaInference
  53. val parserRun: Int
    Definition Classes
    ParserContext
  54. val platform: Platform
    Definition Classes
    PlatformSecrets
  55. val plugins: PluginContext
    Definition Classes
    ParserContext
  56. val refs: Seq[ParsedReference]
    Definition Classes
    ParserContext
  57. def registerJsonSchema(url: String, shape: AnyShape): Unit
    Definition Classes
    WebApiContext
  58. def resolvedPath(base: String, str: String): String
    Definition Classes
    WebApiContext
  59. val rootContextDocument: String
    Definition Classes
    ParserContext
  60. def setJsonSchemaAST(value: YNode): Unit
    Definition Classes
    WebApiContext
  61. def shouldSkipDot(base: String, path: String): Boolean
    Definition Classes
    WebApiContext
  62. def supportsAnnotations: Boolean
    Attributes
    protected
  63. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  64. def throwClosedShapeError(node: String, message: String, entry: YPart, isWarning: Boolean = false): Unit
    Attributes
    protected
    Definition Classes
    WebApiContext
  65. def validateRefFormatWithError(ref: String): Boolean
    Definition Classes
    WebApiContext
  66. def violation(violationId: ValidationSpecification, node: String, message: String): Unit
    Definition Classes
    ParserContext
  67. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  68. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  69. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  70. val wrapped: ParserContext

Inherited from RamlSpecAwareContext

Inherited from WebApiContext

Inherited from JsonSchemaInference

Inherited from PlatformSecrets

Inherited from SpecAwareContext

Inherited from ParserContext

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from IllegalTypeHandler

Inherited from ParseErrorHandler

Inherited from AnyRef

Inherited from Any

Ungrouped