org.raml.v2.api.model.v10.security

Interface AbstractSecurityScheme

All Superinterfaces:

Annotable

public interface AbstractSecurityScheme
extends Annotable

Method Summary

Methods

Modifier and Type	Method and Description
SecuritySchemePart	describedBy() A description of the request components related to Security that are determined by the scheme: the headers, query parameters or responses.
MarkdownString	description() The description MAY be used to describe a securityScheme.
String	displayName() The displayName attribute specifies the security scheme display name.
String	name() Name of the security scheme
SecuritySchemeSettings	settings() The settings attribute MAY be used to provide security scheme-specific information.
String	type() 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.

Methods inherited from interface org.raml.v2.api.model.v10.common.Annotable

annotations

Method Detail

name

String name()

Name of the security scheme

type

String type()

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.

description

MarkdownString description()

The description MAY be used to describe a securityScheme.

describedBy

SecuritySchemePart describedBy()

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.

displayName

String displayName()

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).

settings

SecuritySchemeSettings settings()

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.