MetOffice / MetOffice/CDDS

Improve cv validator error messages

Open Beginner friendly
#863 2 comments 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
Python
Stars
8
Forks
7
Avg merge
1d 15h
Merged PRs (30d)
23

Description

When incorrect information within a request file is flagged by cdds/common/request/validations/cv_validators.py, it might be valuable to give more information about the expected valid input.

e.g. Upon giving an incorrect parent_experiment_id, the following error is returned: "Parent experiment id does not match with id in CV config". However, it may be more valuable and user friendly to update this to something of the form "Parent experiment id '' does not match with id in CV config, expected one of the following: .

Contributor guide

No contributing guide indexed for this repository

Research direction

Start in cdds/common/request/validations/cv_validators.py and inspect how validation errors such as the parent_experiment_id mismatch are assembled. Update the relevant messages to include the received value and valid expected values, then verify that incorrect request-file inputs report this context consistently.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
backend
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.