Skip to content

[I] OpenAPI3ApiKeySecurityScheme

defines an ApiKey security scheme that can be used by the operations

Extends

Indexable

[key: `x-${string}`]: any

Properties

PropertyTypeDescriptionInherited from
description?stringA short description for security scheme. CommonMark syntax MAY be used for rich text representation.OpenAPI3SecuritySchemeBase.description
in"header" | "query" | "cookie"The location of the API key.-
namestringThe name of the header, query or cookie parameter to be used.-
type"apiKey"ApiKey-