Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Methods

RAMLVersion

  • RAMLVersion(): string

body

  • Each response MAY contain a body property, which conforms to the same structure as request body properties (see Body). Responses that can return more than one response code MAY therefore have multiple bodies defined. For APIs without a priori knowledge of the response types for their responses, * /* MAY be used to indicate that responses that do not matching other defined data types MUST be accepted. Processing applications MUST match the most descriptive media type first if * /* is used.

    Returns BodyLike[]

code

definition

description

errors

headers

  • An API's methods may support custom header values in responses. The custom, non-standard HTTP headers MUST be specified by the headers property. API's may include the the placeholder token {?} in a header name to indicate that any number of headers that conform to the specified format can be sent in responses. This is particularly useful for APIs that allow HTTP headers that conform to some naming convention to send arbitrary, custom data.

    Returns Parameter[]

isOkRange

  • isOkRange(): boolean

kind

  • kind(): string

meta

optional

  • optional(): boolean

optionalProperties

  • optionalProperties(): string[]

parent

runtimeDefinition

toJSON

Generated using TypeDoc