biocore / biocore/microsetta-private-api

Get Departure decision on whether to put language_tag in returned Location headers

Open
#72 2 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
6
Forks
18
PR merge metrics
No merged PRs in 30d

Description

We occasionally return an object AND a location header specifying the object's location. Is that kosher?

Our location headers don't specify a language_tag, and thus aren't usable directly as URLs because the language_tag has to be appended. It's true that the language_tag isn't part of the object, but it's unclear how location headers are supposed to be used. Let's look up best practices on this.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by locating the API handlers that return both an object and a Location header, then review how those headers currently represent language_tag. Compare the available URL forms and record the project's decision on whether language_tag belongs in returned Location headers; done means the behavior is decided and the affected API responses are consistent.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
api, backend-api-design
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.