NatLabRockies / NatLabRockies/api-umbrella

Inconsistent "Accept: application/json" header requirement (406 Not Acceptable error)

Open
#145 3 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Ruby
Stars
2.2k
Forks
373
PR merge metrics
No merged PRs in 30d

Description

When testing the Admin API, I get an error on the get api backend endpoint (/v1/apis/{id}):

406 Not Acceptable

This seems to be related to a lack of AcceptHTTP header. When providing the Accept: application/json header, I get a 200 OKas expected.

This behavior is inconsistent with the get API User endpoint (/users/{id}), which does not require the Accept header.

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 406 response for GET /v1/apis/{id} without an Accept header, then compare it with GET /users/{id}, which is reported to return 200 without that header. Trace the two endpoint entry points and identify the source of their different content-negotiation behavior. Done means the affected endpoints handle the header requirement consistently, with tests covering both requests.

Written by the indexing model from the issue text.

Assessment

Domain
api, backend
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.