JsonParameter

@tsed/schema

Usage

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

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

Overview

class JsonParameter extends JsonMap<OS3Parameter<JsonSchema>> {
    $kind: string;
    expression: string;
    constructor(obj?: Partial<OS3Parameter<JsonSchema>>);
    getName(): any;
    name(name: string): this;
    examples(examples: OpenSpecHash<OS3Example | OpenSpecRef>): this;
    description(description: string): this;
    in(inType: string, expression?: string | any): this;
    required(required: boolean): this;
    schema(): JsonSchema;
    schema(schema: JsonSchema): this;
    itemSchema(schema?: JsonSchema): JsonSchema<import("json-schema").JSONSchema7Type>;
    toJSON(options?: JsonSchemaOptions): any;
}

Description

Represents an HTTP operation parameter for OpenAPI specifications.

JsonParameter defines a single parameter for an HTTP operation, supporting various parameter locations (path, query, header, body, files) and providing a fluent API for building parameter metadata compatible with OpenAPI 3.

Parameter Types

• path: Parameter in the URL path (e.g., /users/{id})
• query: Query string parameter (e.g., ?page=1)
• header: HTTP header parameter
• body: Request body parameter
• files: File upload parameter

Usage

const param = new JsonParameter()
  .name("userId")
  .in("path")
  .required(true)
  .description("The user identifier")
  .schema(JsonSchema.from(String));

Key Features

• Schema Integration: Associated JSON schema for validation
• Examples: Support for parameter examples
• Expression: Custom parameter expressions for complex bindings
• Validation: Required/optional flags and schema constraints

$kind

$kind: string;

expression

expression: string;

getName

getName(): any;

name

name(name: string): this;

examples

examples(examples: OpenSpecHash<OS3Example | OpenSpecRef>): this;

description

description(description: string): this;

in

in(inType: string, expression?: string | any): this;

required

required(required: boolean): this;

schema

schema(): JsonSchema;

schema

schema(schema: JsonSchema): this;

itemSchema

itemSchema(schema?: JsonSchema): JsonSchema<import("json-schema").JSONSchema7Type>;

toJSON

toJSON(options?: JsonSchemaOptions): any;