HumanBrainProject / HumanBrainProject/hbp-validation-framework

Better error message if Author, Owner not in proper format

Open
#259 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

REST API v2
Dominant language
Python
Stars
5
Forks
12
PR merge metrics
No merged PRs in 30d

Description

If string input for author/owner, e.g.
author="Shailesh Appukuttan"
we get an error message of the form:

Exception Type: TypeError at /models/
Exception Value: string indices must be integers

This should be updated to provide a more informative response, such as:
author and owner fields should have values of the form:
{"family_name": "Appukuttan", "given_name": "Shailesh"}

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reproducing the error at /models/ with a string value for author or owner, then trace the validation path that handles these fields. Done means invalid string input produces an informative message describing the expected family_name and given_name object format instead of a TypeError.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.