@open-sauced/api documentation
  1. Classes
  2. PullRequestHistogramDto

File

src/histogram/dtos/pull_request.dto.ts

Extends

BaseHistogramDto

Index

Properties

Properties

Readonly Optional filter
Type : InsightFilterFieldsEnum
Decorators :
@ApiPropertyOptional({enum: InsightFilterFieldsEnum, enumName: 'InsightFilterFieldsEnum'})
@IsEnum(InsightFilterFieldsEnum)
@IsOptional()
Defined in src/histogram/dtos/pull_request.dto.ts:13
Readonly Optional topic
Type : string
Decorators :
@ApiPropertyOptional({type: 'string', default: ''})
@IsString()
@IsOptional()
Defined in src/histogram/dtos/pull_request.dto.ts:21
Readonly Optional contributor
Type : string
Decorators :
@ApiPropertyOptional({type: 'string', example: 'bdougie'})
@IsString()
@IsOptional()
Inherited from BaseHistogramDto
Defined in BaseHistogramDto:54
Readonly Optional orderDirection
Type : OrderDirectionEnum
Default value : OrderDirectionEnum.DESC
Decorators :
@ApiPropertyOptional({enum: OrderDirectionEnum, enumName: 'OrderDirectionEnum', default: undefined})
@IsEnum(OrderDirectionEnum)
@IsOptional()
Inherited from BaseHistogramDto
Defined in BaseHistogramDto:64
Readonly Optional prev_days_start_date
Type : number
Default value : 0
Decorators :
@ApiPropertyOptional({description: 'Number of days in the past to start range block', default: 0, type: 'integer'})
@Type(undefined)
@IsIn(['0', '7', '30', '90', '180'])
@IsInt()
@IsOptional()
Inherited from BaseHistogramDto
Defined in BaseHistogramDto:26
Readonly range
Type : number
Default value : 30
Decorators :
@ApiProperty({description: 'Range in days', default: 30, type: 'integer'})
@Type(undefined)
@IsIn(['7', '30', '90', '180', '360'])
@IsInt()
Inherited from BaseHistogramDto
Defined in BaseHistogramDto:15
Readonly Optional repo
Type : string
Decorators :
@ApiPropertyOptional({description: 'Repo name', type: 'string', example: 'open-sauced/app'})
@Type(undefined)
@IsString()
@IsOptional()
Inherited from BaseHistogramDto
Defined in BaseHistogramDto:46
Readonly Optional repoIds
Type : string
Decorators :
@ApiPropertyOptional()
@IsString()
@IsOptional()
Inherited from BaseHistogramDto
Defined in BaseHistogramDto:59
Readonly Optional width
Type : number
Default value : 1
Decorators :
@ApiPropertyOptional({description: 'Day width of histogram buckets', default: 1, type: 'integer'})
@Type(undefined)
@IsInt()
@IsOptional()
Inherited from BaseHistogramDto
Defined in BaseHistogramDto:36 
import { ApiPropertyOptional } from "@nestjs/swagger";
import { IsEnum, IsOptional, IsString } from "class-validator";
import { InsightFilterFieldsEnum } from "../../insight/dtos/insight-options.dto";
import { BaseHistogramDto } from "./base.dto";

export class PullRequestHistogramDto extends BaseHistogramDto {
  @ApiPropertyOptional({
    enum: InsightFilterFieldsEnum,
    enumName: "InsightFilterFieldsEnum",
  })
  @IsEnum(InsightFilterFieldsEnum)
  @IsOptional()
  readonly filter?: InsightFilterFieldsEnum;

  @ApiPropertyOptional({
    type: "string",
    default: "",
  })
  @IsString()
  @IsOptional()
  readonly topic?: string;
}

results matching ""

    No results matching ""