Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Methods

RAMLVersion

  • RAMLVersion(): string

allBaseUriParameters

  • Retrieve an ordered list of all base uri parameters regardless of whether they are described in baseUriParameters or not Consider a fragment of RAML specification:

    version: v1
    baseUri: https://{organization}.example.com/{version}/{service}
    baseUriParameters:
    service:
    

    Here version and organization are base uri parameters which are not described in the baseUriParameters node, but they are among Api.allBaseUriParameters().

    deprecated

    Returns TypeDeclaration[]

allProtocols

  • allProtocols(): string[]

allResourceTypes

allResources

allTraits

annotationTypes

annotations

baseUri

baseUriParameters

  • Retrieve an ordered list of all base uri parameters regardless of whether they are described in baseUriParameters or not Consider a fragment of RAML specification:

    version: v1
    baseUri: https://{organization}.example.com/{version}/{service}
    baseUriParameters:
    service:
    

    Here version and organization are base uri parameters which are not described in the baseUriParameters node, but they are among Api.baseUriParameters().

    Returns TypeDeclaration[]

childResource

  • childResource(relPath: string): Resource

definition

description

documentation

errors

expand

  • expand(expLib?: boolean): Api

extends

  • extends(): string

kind

  • kind(): string

mediaType

meta

optional

  • optional(): boolean

optionalProperties

  • optionalProperties(): string[]

parent

protocols

  • protocols(): string[]

resourceTypes

resources

  • The resources of the API, identified as relative URIs that begin with a slash (/). Every property whose key begins with a slash (/), and is either at the root of the API definition or is the child property of a resource property, is a resource property, e.g.: /users, /{groupId}, etc

    Returns Resource[]

runtimeDefinition

scalarsAnnotations

schemas

  • Alias for the equivalent "types" property, for compatibility with RAML 0.8. Deprecated - API definitions should use the "types" property, as the "schemas" alias for that property name may be removed in a future RAML version. The "types" property allows for XML and JSON schemas.

    Returns TypeDeclaration[]

securedBy

securitySchemes

title

  • title(): string

toJSON

traits

types

usage

  • usage(): string

uses

version

  • version(): string

Generated using TypeDoc