Skip to content

OS3SecurityApiKey

@tsed/openspec

Usage

typescript
import { OS3SecurityApiKey } from "@tsed/openspec";

See /packages/specs/openspec/src/types/openspec3/OS3Security.ts.

Overview

ts
interface OS3SecurityApiKey extends OS3SecurityBase {
    type: "apiKey";
    name: string;
    in: "query" | "header" | "cookie";
}

type

ts
type: "apiKey";

The type of the security scheme

name

ts
name: string;

The name of the header, query or cookie parameter to be used.

in

ts
in: "query" | "header" | "cookie";

The location of the API key. Valid values are query, header or cookie.

Released under the MIT License.