1159363 - Add Location header to resource-creating POST responses

Status: RESOLVED WONTFIX

(developer.mozilla.org Graveyard :: BrowserCompat, enhancement)

Description

[John Whitlock [:jwhitlock]]

What problem would this feature solve?
======================================
An API client creating a resource via POST to the list view has to construct the URL of the created resource from the response data.

Who has this problem?
=====================
API Client writers

How do you know that the users identified above have this problem?
==================================================================
I do not.  The API is being built, and there are currently no client writers.

How are the users identified above solving this problem now?
============================================================
The API response JSON includes the data needed to determine the URL, but requires more code than reading a header.

Do you have any suggestions for solving the problem? Please explain in detail.
==============================================================================
Add the Location header in POST responses, to the URL of the newly created resource.

Is there anything else we should know?
======================================
Django REST Framework has hooks for adding a Location header for other JSON formats: https://github.com/tomchristie/django-rest-framework/blob/master/rest_framework/mixins.py#L27

Comment 1

[Renoir Boulanger [:renoirb]]

I guess you haven't created appropriate HTTP responses. You could send a 204 which expects no response body at all, and send a

Comment 2

[Renoir Boulanger [:renoirb]]

Sorry for previous comment, I didn't expect Bugzilla would send the comment from "save changes" on top. Is this task because the API has no 2xx HTTP response such as Created done yet?

Comment 3

[John Whitlock [:jwhitlock]]

The response is a 201 Created, without a Location header, and the resource JSON as the body:

http://browsercompat.readthedocs.org/en/latest/draft/resources.html#create

The bug is to add a Location header, so that the client doesn't have to construct it from the resource JSON.

Comment 4

[Jeremie Patonnier :Jeremie]

John, is this needed for the C&M GUI work Stephanie is doing? Or is it something more like a nice to have?

Comment 5

[John Whitlock [:jwhitlock]]

It's a nice to have for now, and can be assigned to a late milestone (added it to spaceship). If the C&M GUI requires it, we can reprioritize.

The JSON API v1.0 spec refers to it as a SHOULD:

http://jsonapi.org/format/#crud-creating-responses-201

"The response SHOULD include a Location header identifying the location of the newly created resource."

Comment 6

[John Whitlock [:jwhitlock]]

The BrowserCompat project is canceled.  See https://github.com/mdn/browsercompat for current effort. Bulk status change includes the random word TEMPOTHRONE.