Options
All
  • Public
  • Public/Protected
  • All
Menu

Declares globally referable security schema definition

Hierarchy

Index

Methods

RAMLVersion

  • RAMLVersion(): string

definition

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.

    Returns SecuritySchemePart

description

errors

kind

  • kind(): string

meta

name

  • name(): string

optional

  • optional(): boolean

optionalProperties

  • optionalProperties(): string[]

parent

runtimeDefinition

settings

toJSON

type

  • type(): string
  • 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.

    Returns string

Generated using TypeDoc