How to use the @tsed/swagger.Description function in @tsed/swagger

To help you get started, we’ve selected a few @tsed/swagger examples, based on popular ways it is used in public projects.

Secure your code as it's written. Use Snyk Code to scan source code in minutes - no build needed - and fix issues immediately.

github TypedProject / ts-express-decorators / test / integration / app / models / Event.ts View on Github external
import {Any, IgnoreProperty, JsonProperty, Property, PropertyType, Required} from "@tsed/common";
import {Description, Example, Title} from "@tsed/swagger";

export class Task {
  @JsonProperty() public name: string = "";

  @JsonProperty() public percent: number;
}

@Title("EventModel Title")
export class EventModel {
  @Title("iD")
  @Description("Description of event model id")
  @Example("1FDCHZKH")
  @JsonProperty()
  public id: string;

  @Required()
  @Example("example1", "2017-10-15T17:05:58.106Z")
  public startDate: Date;

  @JsonProperty()
  @Required()
  // @Format("date")
  public endDate: Date;

  @JsonProperty("Name")
  @Required()
  public name: string;
github TypedProject / ts-express-decorators / integration / typeorm / src / entity / User.ts View on Github external
import {Minimum, Required, Property} from "@tsed/common";
import {Example, Description} from "@tsed/swagger";
import {Column, Entity, PrimaryGeneratedColumn} from "typeorm";

@Entity()
export class User {
  @Description('Database assigned id')
  @PrimaryGeneratedColumn()
  id: number;

  @Description('User firstname')
  @Column()
  @Required()
  firstName: string;

  @Description('User lastname')
  @Column()
  @Required()
  lastName: string;

  @Description('User Age')
  @Column()
  @Minimum(18)
  @Example(18)
  age: number;

  additional: string; // won't be serialized/deserialized by Ts.ED because @PropertyType or other Ts.ED decorator are missing

  @Property()
  additional2: string;
}
github TypedProject / ts-express-decorators / test / integration / app / controllers / calendars / CalendarCtrl.ts View on Github external
import {BaseController} from "../base/BaseController";
import {EventCtrl} from "./EventCtrl";

interface ICalendar {
  id: string;
  name: string;
}

/**
 * Add @ControllerProvider annotation to declare your provide as Router controller. The first param is the global path for your controller.
 * The others params is the children controllers.
 *
 * In this case, EventCtrl is a depedency of CalendarCtrl. All routes of EventCtrl will be mounted on the `/calendars` path.
 */
@Controller("/calendars", EventCtrl)
@Description("Controller description")
export class CalendarCtrl extends BaseController {
  constructor(private tokenService: TokenService) {
    super(tokenService);
  }

  /**
   *
   * @param request
   * @param response
   * @param next
   */
  static middleware(request: any, response: Express.Response, next: Express.NextFunction) {
    request["user"] = 1;
    response.locals.id = "local-10909";
    request.ctx.set("uid", "ctx-10909");
github TypedProject / ts-express-decorators / test / integration / app / models / Calendar.ts View on Github external
import {Property, Required} from "@tsed/common";
import {Description, Example, Title} from "@tsed/swagger";

export class CalendarModel {
  @Title("iD")
  @Description("Description of calendar model id")
  @Example("example1", "Description example")
  @Property()
  public id: string;

  @Property()
  @Required()
  public name: string;
}
github TypedProject / ts-express-decorators / examples / mongoose / src / models / events / CalendarEvent.ts View on Github external
@Property()
  @Description("Last modification date")
  dateUpdate: Date = new Date();

  @Property()
  @Description("Beginning date of the event")
  dateStart: Date = new Date();

  @Property()
  @Required()
  @Description("Ending date of the event")
  dateEnd: Date = new Date();

  @Property()
  @Description("Description the event")
  description: string;
}
github TypedProject / ts-express-decorators / examples / mongoose / src / models / events / CalendarEvent.ts View on Github external
calendarId: Ref;

  @Property("name")
  @Description("The name of the event")
  name: string;

  @Property()
  @Description("Creation's date")
  dateCreate: Date = new Date();

  @Property()
  @Description("Last modification date")
  dateUpdate: Date = new Date();

  @Property()
  @Description("Beginning date of the event")
  dateStart: Date = new Date();

  @Property()
  @Required()
  @Description("Ending date of the event")
  dateEnd: Date = new Date();

  @Property()
  @Description("Description the event")
  description: string;
}
github TypedProject / ts-express-decorators / examples / mongoose / src / models / events / CalendarEvent.ts View on Github external
_id: string;

  @Ref(Calendar)
  @Description("Calendar ID")
  calendarId: Ref;

  @Property("name")
  @Description("The name of the event")
  name: string;

  @Property()
  @Description("Creation's date")
  dateCreate: Date = new Date();

  @Property()
  @Description("Last modification date")
  dateUpdate: Date = new Date();

  @Property()
  @Description("Beginning date of the event")
  dateStart: Date = new Date();

  @Property()
  @Required()
  @Description("Ending date of the event")
  dateEnd: Date = new Date();

  @Property()
  @Description("Description the event")
  description: string;
}
github TypedProject / ts-express-decorators / examples / mongoose / src / models / events / CalendarEvent.ts View on Github external
@Property()
  @Description("Creation's date")
  dateCreate: Date = new Date();

  @Property()
  @Description("Last modification date")
  dateUpdate: Date = new Date();

  @Property()
  @Description("Beginning date of the event")
  dateStart: Date = new Date();

  @Property()
  @Required()
  @Description("Ending date of the event")
  dateEnd: Date = new Date();

  @Property()
  @Description("Description the event")
  description: string;
}
github TypedProject / ts-express-decorators / integration / typeorm / src / entity / User.ts View on Github external
import {Minimum, Required, Property} from "@tsed/common";
import {Example, Description} from "@tsed/swagger";
import {Column, Entity, PrimaryGeneratedColumn} from "typeorm";

@Entity()
export class User {
  @Description('Database assigned id')
  @PrimaryGeneratedColumn()
  id: number;

  @Description('User firstname')
  @Column()
  @Required()
  firstName: string;

  @Description('User lastname')
  @Column()
  @Required()
  lastName: string;

  @Description('User Age')
  @Column()
  @Minimum(18)
github TypedProject / ts-express-decorators / examples / mongoose / src / models / events / CalendarEvent.ts View on Github external
import {Property, PropertyName, Required} from "@tsed/common";
import {Model, Ref} from "@tsed/mongoose";
import {Description} from "@tsed/swagger";
import {Calendar} from "../calendars/Calendar";

@Model()
export class CalendarEvent {
  @PropertyName("id")
  _id: string;

  @Ref(Calendar)
  @Description("Calendar ID")
  calendarId: Ref;

  @Property("name")
  @Description("The name of the event")
  name: string;

  @Property()
  @Description("Creation's date")
  dateCreate: Date = new Date();

  @Property()
  @Description("Last modification date")
  dateUpdate: Date = new Date();

  @Property()
  @Description("Beginning date of the event")
  dateStart: Date = new Date();

  @Property()
  @Required()