Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Methods

RAMLVersion

  • RAMLVersion(): string

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

definition

description

errors

is

kind

  • kind(): string

meta

methods

optional

  • optional(): boolean

optionalProperties

  • optionalProperties(): string[]

parent

runtimeDefinition

scalarsAnnotations

securedBy

toJSON

type

uriParameters

  • 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.uriParameters().

    Returns TypeDeclaration[]

Generated using TypeDoc