class Angus::SDoc::Definitions::Message

Constants

ERROR_LEVEL
INFO_LEVEL
WARNING_LEVEL

Attributes

description[RW]

@!attribute [rw] description

@return [String] the description of the message.
fields[RW]

@!attribute [rw] fields

@return [Array<Field>] the fields for the message.
key[RW]

@!attribute [rw] key

@return [String] the key of the message. It is a human readable unique identifier.
  It has to start with Mayus and it has to be camelcase.
level[RW]

@!attribute [rw] level

@return [String] the level of the message. Possible values are the *_LEVEL constants.
status_code[RW]

@!attribute [rw] status_code

@return [String] the HTTP status code of the message.
text[RW]

@!attribute [rw] text

@return [String] when set this text overrides all others and is set as the message description.