interagent / http-api-design

HTTP API design guide extracted from work on the Heroku Platform API
https://geemus.gitbooks.io/http-api-design/content/en/
Other
13.69k stars 1.07k forks source link

s/Request-Id/X-Request-Id #38

Closed keithamus closed 10 years ago

keithamus commented 10 years ago

Request-Id is not a standard HTTP header. Recommending it may cause the side effect of people using it without verifying if it is standard. Instead, recommending X-Request-Id still serves the purpose, while allowing people to explicitly see it is non standard.

Careful when clicking the Files Changed tab - this one's a biggy :wink:

geemus commented 10 years ago

@keithamus Hey, I can certainly understand your concern and the desire to avoid this confusion, however, the X- prefix has been deprecated and is not to be used in new (even private/non-standard stuff). See: http://tools.ietf.org/html/rfc6648. I'm happy to discuss further, but I think leaving out the prefix is probably the right thing to do given that. Thanks.