kir-dev/collage-schedule-planner

Add Class Validation to Event Entity

Open

#18 opened on May 28, 2024

View on GitHub
 (0 comments) (0 reactions) (1 assignee)TypeScript (1 fork)auto 404
backendgood first issue

Repository metrics

Stars
 (1 star)
PR merge metrics
 (PR metrics pending)

Description

Description: Ensure that the data for the Event entity is validated before it is processed. This involves adding class-validator decorators to the DTOs used for creating and updating events.

Tasks:

  • Create DTOs for creating
  • and updating events.
  • Add appropriate validation decorators to each field in the DTOs. Example: @IsString(), @IsNotEmpty(), @IsDateString(), @IsOptional(), @IsEnum()
  • Update event controller methods to use these DTOs.

Acceptance Criteria:

  • DTOs with validation decorators are created for event creation and update.
  • Event controller methods use these DTOs.
  • Validation errors are properly handled and returned to the client.

Contributor guide

Research direction
Study class validator decorators and NestJS DTO patterns. Create DTOs for event creation and update, apply decorators like @IsString(), @IsNotEmpty(), etc. Update the controller to use these DTOs and handle validation errors.
Tech stack
typescript
Domain
backendapi
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
TypeScriptclass validator
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75