Packages

class PayloadContext extends RamlWebApiContext

Linear Supertypes
RamlWebApiContext, RamlSpecAwareContext, WebApiContext, PlatformSecrets, SpecAwareContext, ParserContext, Serializable, Serializable, Product, Equals, IllegalTypeHandler, ParseErrorHandler, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PayloadContext
  2. RamlWebApiContext
  3. RamlSpecAwareContext
  4. WebApiContext
  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 PayloadContext(loc: String, refs: Seq[ParsedReference], wrapped: ParserContext, ds: Option[RamlWebApiDeclarations] = None, contextType: RamlWebApiContextType = RamlWebApiContextType.DEFAULT, options: ParsingOptions = ParsingOptions())

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

    Definition Classes
    RamlWebApiContext
  5. def addSonRef(ref: BaseUnit): PayloadContext.this.type
    Definition Classes
    ParserContext
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def basePath(path: String): String
    Definition Classes
    WebApiContext
  8. def clone(declarations: RamlWebApiDeclarations): RamlWebApiContext
    Attributes
    protected
    Definition Classes
    PayloadContextRamlWebApiContext
  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

    Definition Classes
    RamlWebApiContext
  11. def closedShape(node: String, ast: YMap, shape: String): Unit

    Validate closed shape.

    Validate closed shape.

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

Inherited from RamlWebApiContext

Inherited from RamlSpecAwareContext

Inherited from WebApiContext

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