@nestjs/swagger#ApiModelProperty TypeScript Examples

@ApiModelProperty({
        type:String,
        description: 'The type of grant you are requesting, must be "client_credentials"',
        required: true
    })
    @IsNotEmpty()
    @Expose({ name: "grant_type" })
    grantType: string;

@ApiModelProperty({
        type:String,
        description: 'The API Key given by the application',
        required: true
    })
    @IsNotEmpty()
    @Expose({ name: "client_id" })
    clientId: string;

@ApiModelProperty({
        type:String,
        description: 'The API Token given by the application',
        required: true
    })
    @Expose({ name: "client_secret" })
    clientSecret: string;

@ApiModelProperty({
        type: Number,
        description: 'The expiration time of the assertion, specified as seconds since 00:00:00 UTC, January 1, 1970. This value has a maximum of 1 hour after the issued time.',
    })
    @Expose({ name: "exp" })
    exp?: number;

@ApiModelProperty({
        type: Number,
        description: 'The time the assertion was issued, specified as seconds since 00:00:00 UTC, January 1, 1970.',
    })
    @Expose({ name: "iat" })
    iat?: number;

@ApiModelProperty({
        type: String,
        description: 'The list of the permissions (tpApps) that the application requests.',
        isArray: true
    })
    @Expose({ name: "scopes"})
    scopes?: string | string[];

@ApiModelProperty({
        type: String,
        description: 'The refresh token only when grant_type is set to "refresh_token"',
    })
    @Expose({ name: "refresh_token"})
    refreshToken?: string;

@ApiModelProperty({
        type: String,
        description: 'The username only when grant_type is set to "refresh_token"',
    })
    @Expose({ name: "username"})
    username?: string;

@ApiModelProperty({
        type: String,
        description: 'The password when grant_type is set to "password_grant"',
    })
    @Expose({ name: "password"})
    password?: string;

@ApiModelProperty({
        type:String,
        description: 'The generated access token',
        required: true
    })
    @Expose({name: 'access_token'})
    accessToken: string;

@ApiModelProperty({
        type:String,
        description: 'The type of token, in our case should always be "bearer"',
        required: true
    })
    @Expose({name: 'token_type'})
    tokenType: string = 'bearer';

@ApiModelProperty({
        type: String,
        description: 'The generated refresh token',
        required: true
    })
    @Expose({name: 'refresh_token'})
    refreshToken: string;

@ApiModelProperty({
        type: Number,
        description: 'Number of seconds until the acess token expires',
        required: true
    })
    @Expose({name: 'expires_in'})
    accessTokenExp: number;

@ApiModelProperty({
        type: Number,
        description: 'The list of the permissions (tpApps) that the application requests.',
        required: true
    })
    @Exclude()
    refreshTokenExp: number;

@ApiModelProperty({
        type: String,
        description: 'Scopes you are allowed to use if any requested',
        required: true
    })
    @Expose({name: 'scope'})
    scope?: string;