BlueBrain / BlueBrain/nexus

Signal rejection to clients when providing a query parameter that has no effect on an endpoint

Open
#1,714 0 comments 0 reactions 0 assignees View on GitHub
delta enhancement
Dominant language
Scala
Stars
301
Forks
76
PR merge metrics
No merged PRs in 30d

Description

When a client is passed a query parameter into an endpoint that has no effect (it would otherwise be ignored) we should reject in order to let the client know the passed query parameter is not supported on the provided endpoint.

Something like a `CustomRejection` that is `UnsuportedQueryParameterRejection`.

This will help clients to know what is supported and not on a certain API endpoint.

Contributor guide

Open the contributing guide

Research direction

No file, test, or entry point is identified in the issue. Start by locating endpoint query-parameter parsing and the existing rejection handling, then trace how unsupported parameters are currently ignored. Done means an endpoint rejects an ineffective query parameter with a clearly named unsupported-parameter rejection and clients can distinguish it from other failures.

Written by the indexing model from the issue text.

Assessment

Tech stack
scala
Domain
api
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.