search

collective / sphinxcontrib-httpexample

Adds example directive for sphinx-contrib httpdomain
23 stars 20 forks source link

Force order of headers in req/resp files. #4

Closed tisto closed 7 years ago

tisto commented 7 years ago

When working with plone.restapi I see a lot of git conflicts that look like this:

 GET /plone/non-existing-resource HTTP/1.1
-Accept: application/json
 Authorization: Basic YWRtaW46c2VjcmV0
+Accept: application/json

It seems we are not forcing a particular order on the headers. Maybe we can just sort them alphabetically? cc @datakurre @csenger

datakurre commented 7 years ago

AFAIK plone.restapi test_documentation generates the http examples, which are then just consumed by httpexample. So, the sorting should be done there. httpexample already sorts headers in generated example commands.

On 13. maaliskuuta 2017 klo 12.00 +0200, Timo Stollenwerk notifications@github.com, wrote:

When working with plone.restapi I see a lot of git conflicts that look like this:

GET /plone/non-existing-resource HTTP/1.1 -Accept: application/json Authorization: Basic YWRtaW46c2VjcmV0 +Accept: application/json

It seems we are not forcing a particular order on the headers. Maybe we can just sort them alphabetically? cc @datakurre (https://github.com/datakurre) @csenger (https://github.com/csenger)

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub (https://github.com/collective/sphinxcontrib-httpexample/issues/4), or mute the thread (https://github.com/notifications/unsubscribe-auth/AAJyvxCM148qpjLTD8LhgOizVIQ9YIxxks5rlRM6gaJpZM4MbC6y).

tisto commented 7 years ago

@datakurre yeah. I just saw that in our code. Sorry for reporting the bug in the wrong project. :) https://github.com/plone/plone.restapi/issues/263