| Copyright | (c) 2024 GYELD GMBH |
|---|---|
| License | Apache 2.0 |
| Maintainer | [email protected] |
| Stability | develop |
| Safe Haskell | None |
| Language | GHC2021 |
GeniusYield.Swagger.Utils
Description
Synopsis
- addSwaggerExample :: (Functor f1, Functor f2, HasSchema b1 a, HasExample a (Maybe b2)) => b2 -> f1 (f2 b1) -> f1 (f2 b1)
- addSwaggerDescription :: (Functor f1, Functor f2, HasSchema b1 a, HasDescription a (Maybe b2)) => b2 -> f1 (f2 b1) -> f1 (f2 b1)
- dropSymbolAndCamelToSnake :: forall (a :: Symbol). KnownSymbol a => String -> String
Documentation
addSwaggerExample :: (Functor f1, Functor f2, HasSchema b1 a, HasExample a (Maybe b2)) => b2 -> f1 (f2 b1) -> f1 (f2 b1) #
Utility function to add swagger example to a schema.
addSwaggerDescription :: (Functor f1, Functor f2, HasSchema b1 a, HasDescription a (Maybe b2)) => b2 -> f1 (f2 b1) -> f1 (f2 b1) #
Utility function to add swagger description to a schema.
dropSymbolAndCamelToSnake :: forall (a :: Symbol). KnownSymbol a => String -> String #
Drop the applied type symbol and convert camel case to snake case.