JsonOperation

@tsed/schema

Usage

import { JsonOperation } from "@tsed/schema";

See /packages/specs/schema/src/domain/JsonOperation.ts.

Overview

class JsonOperation extends JsonMap<JsonOperationOptions> {
    $kind: string;
    readonly operationPaths: Map<string, JsonMethodPath>;
    constructor(obj?: Partial<JsonOperationOptions>);
    get response(): JsonResponse | undefined;
    get status(): number;
    tags(tags: OpenSpecTag[]): this;
    addTags(tags: OpenSpecTag[]): this;
    summary(summary: string): this;
    operationId(operationId: string): this;
    responses(responses: JsonMap<any>): this;
    defaultStatus(status: number): this;
    getStatus(): number;
    setRedirection(status?: number): this;
    isRedirection(status?: number): boolean | 0;
    addResponse(statusCode: string | number, response: JsonResponse): this;
    getResponses(): JsonMap<JsonResponse>;
    getResponseOf(status: number | string): JsonResponse;
    ensureResponseOf(status: number | string): JsonResponse;
    getHeadersOf(status: number): Record<string, JsonHeader & {
        example: string;
    }>;
    getContentTypeOf(status: number): any;
    security(security: OpenSpecSecurity): this;
    addSecurityScopes(name: string, scopes: string[]): this;
    description(description: string): this;
    deprecated(deprecated: boolean): this;
    addAllowedGroupsParameter(allowedGroups: string[]): this;
    parameters(parameters: JsonParameter[]): this;
    addParameter(index: number, parameter: JsonParameter): void;
    consumes(consumes: string[]): this;
    produces(produces: string[]): this;
    addProduce(produce: string): void;
    addOperationPath(method: string, path: string | RegExp): JsonMethodPath;
    getAllowedOperationPath(allowedVerbs?: string[]): JsonMethodPath[];
}

Description

Represents an HTTP operation (endpoint) with complete OpenAPI metadata.

JsonOperation is the core class for defining HTTP endpoints in Ts.ED, storing all operation-level information required for OpenAPI specification generation including:

• Request parameters (path, query, header, body)
• Response definitions with status codes
• Security requirements
• Tags and categorization
• Media type handling (consumes/produces)
• Operation metadata (summary, description, operationId)

Usage

const operation = new JsonOperation()
  .summary("Create a user")
  .description("Creates a new user in the system")
  .addTags([{name: "Users"}])
  .addParameter(0, parameterMetadata)
  .addResponse(201, responseMetadata);

Key Features

• Parameters: Manage operation parameters by index or name
• Responses: Define responses for different HTTP status codes
• Security: Configure authentication and authorization
• Media Types: Specify accepted and produced content types
• Routing: Multiple path/method combinations per operation

$kind

$kind: string;

readonly operationPaths

readonly operationPaths: Map<string, JsonMethodPath>;

get response

get response(): JsonResponse | undefined;

get status

get status(): number;

tags

tags(tags: OpenSpecTag[]): this;

addTags

addTags(tags: OpenSpecTag[]): this;

summary

summary(summary: string): this;

operationId

operationId(operationId: string): this;

responses

responses(responses: JsonMap<any>): this;

defaultStatus

defaultStatus(status: number): this;

getStatus

getStatus(): number;

setRedirection

setRedirection(status?: number): this;

isRedirection

isRedirection(status?: number): boolean | 0;

addResponse

addResponse(statusCode: string | number, response: JsonResponse): this;

getResponses

getResponses(): JsonMap<JsonResponse>;

getResponseOf

getResponseOf(status: number | string): JsonResponse;

ensureResponseOf

ensureResponseOf(status: number | string): JsonResponse;

getHeadersOf

getHeadersOf(status: number): Record<string, JsonHeader & {
     example: string;
 }>;

getContentTypeOf

getContentTypeOf(status: number): any;

security

security(security: OpenSpecSecurity): this;

addSecurityScopes

addSecurityScopes(name: string, scopes: string[]): this;

description

description(description: string): this;

deprecated

deprecated(deprecated: boolean): this;

addAllowedGroupsParameter

addAllowedGroupsParameter(allowedGroups: string[]): this;

parameters

parameters(parameters: JsonParameter[]): this;

addParameter

addParameter(index: number, parameter: JsonParameter): void;

consumes

consumes(consumes: string[]): this;

produces

produces(produces: string[]): this;

addProduce

addProduce(produce: string): void;

addOperationPath

addOperationPath(method: string, path: string | RegExp): JsonMethodPath;

getAllowedOperationPath

getAllowedOperationPath(allowedVerbs?: string[]): JsonMethodPath[];