RAML version of the node
Append node as child
node to be appended
Append node as property value
node to be set as property value
name of property to set value for
Most of RAML model elements may have attached annotations decribing additional meta data about this element
object representing class of the node
A description of the request components related to Security that are determined by the scheme: the headers, query parameters or responses. As a best practice, even for standard security schemes, API designers SHOULD describe these properties of security schemes. Including the security scheme description completes an API documentation.
The description MAY be used to describe a securityScheme.
The displayName attribute specifies the security scheme display name. It is a friendly name used only for display or documentation purposes. If displayName is not specified, it defaults to the element's key (the name of the property itself).
YAML string representing the node
Array of errors
Actual name of instance interface
Name of the security scheme
Whether the element is an optional sibling of trait or resource type
For siblings of traits or resource types returns an array of optional properties names.
Direct ancestor in RAML hierarchy
Remove node from children set
node to be removed
for user class instances returns object representing actual user class
Scalar properties annotations accessor
The settings attribute MAY be used to provide security scheme-specific information. The required attributes vary depending on the type of security scheme is being declared. It describes the minimum set of properties which any processing application MUST provide and validate if it chooses to implement the security scheme. Processing applications MAY choose to recognize other properties for things such as token lifetime, preferred cryptographic algorithms, and more.
The securitySchemes property MUST be used to specify an API's security mechanisms, including the required settings and the authentication methods that the API supports. one authentication method is allowed if the API supports them.
Generated using TypeDoc
Declares globally referable security scheme definition