Class JsonParameter

Class

Module	import { JsonParameter } from "@tsed/schema"
Source	/packages/specs/schema/src/types/domain/JsonParameter.ts

Overview

class JsonParameter extends JsonMap<OS3Parameter<JsonSchema>> implements NestedGenerics {
    $kind: string;
    nestedGenerics: Type<any>[][];
    groups: string[];
    groupsName: string;
    $schema: JsonSchema;
    expression: string;
    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(schema: JsonSchema): this;
    toJSON(options?: JsonSchemaOptions): any;
}

Members

$kind: string;

---

nestedGenerics: Type<any>[][];

---

groups: string[];

---

groupsName: string;

---

$schema: JsonSchema;

---

expression: string;

---

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(schema: JsonSchema): this;

---

toJSON(options?: JsonSchemaOptions): any;