create-measurement-period.dto.ts

import { ApiProperty } from "@nestjs/swagger";
import { IsDateString, IsOptional, IsString } from "class-validator";

export class CreateMeasurementPeriodDto {
  @ApiProperty({
    type: String,
    description:
      "Unique identifier (relative to the proposal) of a MeasurementPeriod",
  })
  @IsString()
  @IsOptional()
  id?: string;

  @ApiProperty({
    type: String,
    required: true,
    description:
      "Instrument or beamline identifier where measurement was pursued, e.g. /PSI/SLS/TOMCAT",
  })
  @IsString()
  readonly instrument: string;

  @ApiProperty({
    type: Date,
    description:
      "Time when measurement period started, format according to chapter 5.6 internet date/time format in RFC 3339. Local times without timezone/offset info are automatically transformed to UTC using the timezone of the API server.",
  })
  @IsDateString()
  readonly start: Date;

  @ApiProperty({
    type: Date,
    description:
      "Time when measurement period ended, format according to chapter 5.6 internet date/time format in RFC 3339. Local times without timezone/offset info are automatically transformed to UTC using the timezone of the API server.",
  })
  @IsDateString()
  readonly end: Date;

  @ApiProperty({
    type: String,
    description:
      "Additional information relevant for this measurement period, e.g. if different accounts were used for data taking.",
  })
  @IsOptional()
  @IsString()
  readonly comment?: string;
}