scotty-web / scotty

Haskell web framework inspired by Ruby's Sinatra, using WAI and Warp (Official Repository)
http://hackage.haskell.org/package/scotty
BSD 3-Clause "New" or "Revised" License
1.71k stars 132 forks source link

Establish API deprecation and cleanup policy #361

Open ocramz opened 6 months ago

ocramz commented 6 months ago

We are currently in a consolidation phase of the library, changing some type signatures and deprecating a bunch of redundant functions and instances. We should be following a consistent policy for cleaning up the namespace after a symbol has been deprecated.

E.g. :

Examples

Changing implementation

It happens that we might have to change the implementation of a user-facing function for security concerns (e.g sanitize header setting to avoid a potential attack on the client #92 ). In this case we introduce new names, deprecate the old ones and at the end of the deprecation cycle we might want to re-introduce the old names for the new implementation.