abstract class RamlWebApiContext extends WebApiContext with RamlSpecAwareContext
Linear Supertypes
Known Subclasses
Ordering
- Alphabetic
- By Inheritance
Inherited
- RamlWebApiContext
- RamlSpecAwareContext
- WebApiContext
- JsonSchemaInference
- PlatformSecrets
- SpecAwareContext
- DeclarationContext
- ExtensionsContext
- DataNodeParserContext
- ParserContext
- Serializable
- Serializable
- Product
- Equals
- UnresolvedComponents
- ErrorHandlingContext
- IllegalTypeHandler
- ParseErrorHandler
- AnyRef
- Any
Implicitly
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
Visibility
- Public
- All
Instance Constructors
- new RamlWebApiContext(loc: String, refs: Seq[ParsedReference], options: ParsingOptions, wrapped: ParserContext, ds: Option[RamlWebApiDeclarations] = None, contextType: RamlWebApiContextType = RamlWebApiContextType.DEFAULT)
Abstract Value Members
-
abstract
def
clone(declarations: RamlWebApiDeclarations): RamlWebApiContext
- Attributes
- protected
-
abstract
val
factory: RamlSpecVersionFactory
- Definition Classes
- RamlWebApiContext → SpecAwareContext
-
abstract
val
syntax: SpecSyntax
- Definition Classes
- WebApiContext
-
abstract
val
vendor: Vendor
- Definition Classes
- WebApiContext
Concrete Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
def
+(other: String): String
- Implicit
- This member is added by an implicit conversion from RamlWebApiContext to any2stringadd[RamlWebApiContext] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
-
def
->[B](y: B): (RamlWebApiContext, B)
- Implicit
- This member is added by an implicit conversion from RamlWebApiContext to ArrowAssoc[RamlWebApiContext] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
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
-
def
addSonRef(ref: BaseUnit): RamlWebApiContext.this.type
- Definition Classes
- ParserContext
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
autoGeneratedAnnotation(s: Shape): Unit
- Definition Classes
- RamlWebApiContext → WebApiContext
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
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
-
def
closedShape(node: String, ast: YMap, shape: String, syntax: SpecSyntax): Unit
- Attributes
- protected
- Definition Classes
- WebApiContext
-
def
closedShape(node: String, ast: YMap, shape: String): Unit
Validate closed shape.
Validate closed shape.
- Definition Classes
- WebApiContext
-
def
computeJsonSchemaVersion(ast: YNode): SchemaVersion
- Definition Classes
- WebApiContext
-
val
config: ParseConfiguration
- Definition Classes
- ParserContext
- var contextType: RamlWebApiContextType
-
def
copyWithSonsReferences(): ParserContext
- Definition Classes
- ParserContext
-
val
declarations: RamlWebApiDeclarations
- Definition Classes
- RamlWebApiContext → DeclarationContext → ExtensionsContext
-
val
declarationsOption: Option[WebApiDeclarations]
- Definition Classes
- ExtensionsContext
-
val
defaultSchemaVersion: JSONSchemaVersion
- Definition Classes
- WebApiContext → JsonSchemaInference
-
implicit
val
eh: AMFErrorHandler
- Definition Classes
- ErrorHandlingContext
-
def
ensuring(cond: (RamlWebApiContext) ⇒ Boolean, msg: ⇒ Any): RamlWebApiContext
- Implicit
- This member is added by an implicit conversion from RamlWebApiContext to Ensuring[RamlWebApiContext] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: (RamlWebApiContext) ⇒ Boolean): RamlWebApiContext
- Implicit
- This member is added by an implicit conversion from RamlWebApiContext to Ensuring[RamlWebApiContext] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean, msg: ⇒ Any): RamlWebApiContext
- Implicit
- This member is added by an implicit conversion from RamlWebApiContext to Ensuring[RamlWebApiContext] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean): RamlWebApiContext
- Implicit
- This member is added by an implicit conversion from RamlWebApiContext to Ensuring[RamlWebApiContext] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
def
findAnnotation(key: String, scope: Scope): Option[CustomDomainProperty]
- Definition Classes
- ExtensionsContext → DataNodeParserContext
-
def
findDeclarations(path: Seq[String], declarations: RamlWebApiDeclarations): RamlWebApiDeclarations
- Attributes
- protected
-
def
findJsonPathIn(index: AstIndex, path: String): Option[YMapEntryLike]
- Definition Classes
- WebApiContext
-
def
findJsonSchema(url: String): Option[AnyShape]
- Definition Classes
- WebApiContext
-
def
findLocalJSONPath(path: String): Option[YMapEntryLike]
- Definition Classes
- WebApiContext
-
def
forLocation(newLocation: String): ParserContext
- Definition Classes
- ParserContext
-
def
formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from RamlWebApiContext to StringFormat[RamlWebApiContext] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @inline()
-
def
fragments: Map[String, FragmentRef]
- Definition Classes
- ExtensionsContext → DataNodeParserContext
-
val
futureDeclarations: FutureDeclarations
- Definition Classes
- ParserContext → UnresolvedComponents
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
getEntryKey(entry: YMapEntry): String
- Definition Classes
- WebApiContext
-
def
getMaxYamlReferences: Option[Int]
- Definition Classes
- ExtensionsContext → DataNodeParserContext
- var globalMediatype: Boolean
-
var
globalSpace: Map[String, Any]
- Definition Classes
- ParserContext
-
def
handle[T](error: YError, defaultValue: T): T
- Definition Classes
- ParserContext → ErrorHandlingContext → IllegalTypeHandler
-
def
handle(location: SourceLocation, e: SyamlException): Unit
- Definition Classes
- ParserContext → ErrorHandlingContext → ParseErrorHandler
-
def
ignore(shape: String, property: String): Boolean
- Definition Classes
- RamlWebApiContext → WebApiContext
-
var
indexCache: Map[String, AstIndex]
- Definition Classes
- WebApiContext
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
var
jsonSchemaRefGuide: JsonSchemaRefGuide
- Definition Classes
- WebApiContext
-
def
link(node: YNode): Either[String, YNode]
- Definition Classes
- RamlWebApiContext → WebApiContext
-
val
loc: String
- Definition Classes
- RamlWebApiContext → ExtensionsContext
-
var
localJSONSchemaContext: Option[YNode]
- Definition Classes
- WebApiContext
- def mergeAllOperationContexts(): Unit
- def mergeContext(subContext: RamlWebApiContext): Unit
- def mergeOperationContext(operation: String): Unit
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
nextValidation(node: String, shape: String, ast: YMap): Unit
- Attributes
- protected
- Definition Classes
- WebApiContext
-
val
nodeRefIds: Map[YNode, String]
- Definition Classes
- ExtensionsContext
-
def
normalizedJsonPointer(url: String): String
- Attributes
- protected
- Definition Classes
- WebApiContext
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
def
obtainRemoteYNode(ref: String, refAnnotations: Annotations = Annotations())(implicit ctx: WebApiContext): Option[YNode]
- Definition Classes
- WebApiContext
- val operationContexts: Map[String, RamlWebApiContext]
-
val
options: ParsingOptions
- Definition Classes
- ExtensionsContext
-
def
parseRemoteOasParameter(fileUrl: String, parentId: String)(implicit ctx: OasWebApiContext): Option[OasParameter]
- Definition Classes
- WebApiContext
-
def
parseSchemaVersion(ast: YNode, errorHandler: AMFErrorHandler): SchemaVersion
- Definition Classes
- JsonSchemaInference
-
def
parsingOptions: ParsingOptions
- Definition Classes
- ParserContext
-
val
platform: Platform
- Definition Classes
- PlatformSecrets
-
val
refs: Seq[ParsedReference]
- Definition Classes
- ParserContext
-
def
registerJsonSchema(url: String, shape: AnyShape): Unit
- Definition Classes
- WebApiContext
-
val
rootContextDocument: String
- Definition Classes
- ParserContext
-
def
setJsonSchemaAST(value: YNode): Unit
- Definition Classes
- WebApiContext
-
def
supportsAnnotations: Boolean
- Attributes
- protected
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
throwClosedShapeError(node: String, message: String, entry: YPart, isWarning: Boolean = false): Unit
- Attributes
- protected
- Definition Classes
- WebApiContext
-
def
validateRefFormatWithError(ref: String): Boolean
- Definition Classes
- WebApiContext
-
def
violation(violationId: ValidationSpecification, node: String, message: String): Unit
- Definition Classes
- ParserContext → ErrorHandlingContext
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
- val wrapped: ParserContext
-
def
→[B](y: B): (RamlWebApiContext, B)
- Implicit
- This member is added by an implicit conversion from RamlWebApiContext to ArrowAssoc[RamlWebApiContext] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc