onaio/onadata

Endpoints that query the user model should not be case sensitive

Open

#2,803 opened on Apr 23, 2025

View on GitHub
 (5 comments) (0 reactions) (0 assignees)Python (143 forks)auto 404
ErrorGood First Issue

Repository metrics

Stars
 (187 stars)
PR merge metrics
 (PR metrics pending)

Description

Environmental Information

  • Onadata version: 5.0.3

Problem description

Endpoints that query the user model using the username are currently case sensitive. Examples are as follows:

  • /api/v1/profiles
  • /api/v1/projects/10574/share

Expected behavior

We should be able to query for usernames in a case-insensitive manner

Steps to reproduce the behavior

The following commands should yield the same result:

➜  curl 'scheme://api-domain/api/v1/profiles.json?users=fapiyo' \
  -H 'accept: application/json' \
  -H 'authorization: TempToken <Your temp token>'
➜  curl 'scheme://api-domain/api/v1/profiles.json?users=FApiyo' \
  -H 'accept: application/json' \
  -H 'authorization: TempToken <Your temp token>'

➜  curl 'scheme://api-domain/api/v1/projects/<project-id>/share' \
  -X 'PUT' \
  -H 'accept: application/json' \
  -H 'authorization: TempToken <Your temp token>' \
  --data-raw 'username=fapiyo&role=readonly'
➜  curl 'scheme://api-domain/api/v1/projects/<project-id>/share' \
  -X 'PUT' \
  -H 'accept: application/json' \
  -H 'authorization: TempToken <Your temp token>' \
  --data-raw 'username=FApiyo&role=readonly'

Contributor guide

Research direction
Identify the database query methods in the endpoints /api/v1/profiles and /api/v1/projects/<id>/share that filter by username, and modify them to use case insensitive lookups (e.g., using iexact in Django ORM or LOWER() in SQL).
Tech stack
python
Domain
backend
Issue type
Bug
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
PythonGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75