JsonMethodPath

@tsed/schema

Usage

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

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

Overview

class JsonMethodPath extends JsonMap<any> {
    method: string;
    path: string | RegExp;
    constructor(method: string, path: string | RegExp);
    summary(summary: string): this;
    description(description: string): this;
}

Description

Represents an HTTP operation path with metadata for OpenAPI specifications.

This class associates an HTTP method and path with operation-level metadata such as summary and description. It's used internally to manage routing information for API endpoints.

method

method: string;

path

path: string | RegExp;

summary

summary(summary: string): this;

description

description(description: string): this;