elm / http

Make HTTP requests in Elm
https://package.elm-lang.org/packages/elm/http/latest
BSD 3-Clause "New" or "Revised" License
155 stars 46 forks source link

Add Upgrade guide from 1.0.0 to 2.0.0 #49

Open deiga opened 5 years ago

deiga commented 5 years ago

Upgrading is quite difficult as the API has changed a fair bit. Would it be possible to add an upgrade guide?

evancz commented 5 years ago

What are you running into? What sort of things do you think it'd be best to document?

deiga commented 5 years ago

@evancz The changed type signature for all requests was the biggest hurdle I encountered when I tried to do the upgrade. As well as small things like parameters changing in the custom requests.

I didn't put much effort into it yet, but these felt so big that I just couldn't handle the upgrade right now :P

bryce13950 commented 5 years ago

A quick guide on how the types have changed would be great. A simple document that shows 1.0.0 implementation, and then the same implementation in 2.0.0 would probably suffice.

christelnagels commented 5 years ago

My friend @Hermanverschooten made a post on elm-discourse describing how he upgraded my code to 2.0,

michaelglass commented 5 years ago

We just made a shim between 1.0 and 2.0 to help people upgrade from 1.0 to 2.0: https://github.com/NoRedInk/http-upgrade-shim

It provides an, albeit awkward, step-by-step approach to upgrading elm/http.