Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Implements

Index

Constructors

constructor

Properties

_meta

Protected _node

Protected nodeOrKey

nodeOrKey: IHighLevelNode | string

Protected setAsTopLevel

setAsTopLevel: boolean

Methods

RAMLVersion

  • RAMLVersion(): string

add

addToProp

allSecuredBy

allUriParameters

  • Retrieve an ordered list of all uri parameters including those which are not described in the uriParameters node. Consider a fragment of RAML specification:

    /resource/{objectId}/{propertyId}:
    uriParameters:
    objectId:
    

    Here propertyId uri parameter is not described in the uriParameters node, but it is among Resource.allUriParameters().

    deprecated

    Returns TypeDeclaration[]

annotations

attributeDefaults

  • attributeDefaults(): boolean

definition

description

dump

  • dump(): string

errors

is

kind

  • kind(): string

meta

methods

optional

  • optional(): boolean

optionalProperties

  • optionalProperties(): string[]

parent

remove

runtimeDefinition

scalarsAnnotations

securedBy

toAny

  • toAny(arg: any): any

toBoolean

  • toBoolean(arg: any): boolean

toJSON

toNumber

  • toNumber(arg: any): any

toString

  • toString(arg: any): string

type

uriParameters

Generated using TypeDoc