e4b2e15 · servant · git.iko.soy

git.iko.soy/servant

Merge pull request #19 from haskell-servant/fixed-pr-16

Canonicalize API before generating docs.

commite4b2e154f5a2923977237eccfbacc7d4ee93ddb5 authorJulian Arni <jkarni@gmail.com> dateSun 19 Apr 2015, 17:52 (11 years ago) parentf90348c 47aeb20

4 files changed+7−6

compare with master

unifiedsplit

CHANGELOG.md+1 example/greet.hs+1−1 src/Servant/Docs/Internal.hs+4−4 test/Servant/DocsSpec.hs+1−1

CHANGELOG.md+1

@@ -5,6 +5,7 @@

55* Render endpoints in a canonical order (https://github.com/haskell-servant/servant-docs/pull/15)

66* Remove ToJSON superclass from ToSample

77* Split out Internal module

8+* `Canonicalize` API types before generating the docs for them

9100.3

1011---

example/greet.hs+1−1

@@ -27,7 +27,7 @@ instance ToJSON Greet

2727

2828-- | We can also implement 'MimeRender' for additional formats like 'PlainText'.

2929instance MimeRender PlainText Greet where

30− toByteString Proxy (Greet s) = "\"" <> cs s <> "\""

30+ mimeRender Proxy (Greet s) = "\"" <> cs s <> "\""

3131

3232-- We add some useful annotations to our captures,

3333-- query parameters and request body to make the docs

src/Servant/Docs/Internal.hs+4−4

@@ -273,8 +273,8 @@ makeLenses ''Action

273273

274274-- | Generate the docs for a given API that implements 'HasDocs'. This is the

275275-- default way to create documentation.

276−docs :: HasDocs layout => Proxy layout -> API

277−docs p = docsFor p (defEndpoint, defAction)

276+docs :: HasDocs (Canonicalize layout) => Proxy layout -> API

277+docs p = docsFor (canonicalize p) (defEndpoint, defAction)

278278

279279-- | Closed type family, check if endpoint is exactly within API.

280280

@@ -318,7 +318,7 @@ extraInfo p action =

318318-- 'extraInfo'.

319319--

320320-- If you only want to add an introduction, use 'docsWithIntros'.

321−docsWith :: HasDocs layout

321+docsWith :: HasDocs (Canonicalize layout)

322322 => [DocIntro]

323323 -> ExtraInfo layout

324324 -> Proxy layout

@@ -330,7 +330,7 @@ docsWith intros (ExtraInfo endpoints) p =

330330

331331-- | Generate the docs for a given API that implements 'HasDocs' with with any

332332-- number of introduction(s)

333−docsWithIntros :: HasDocs layout => [DocIntro] -> Proxy layout -> API

333+docsWithIntros :: HasDocs (Canonicalize layout) => [DocIntro] -> Proxy layout -> API

334334docsWithIntros intros = docsWith intros mempty

335335

336336-- | The class that abstracts away the impact of API combinators

test/Servant/DocsSpec.hs+1−1

@@ -56,7 +56,7 @@ instance ToSample Int where

5656 toSample = Just 17

5757

5858instance MimeRender PlainText Int where

59− toByteString _ = cs . show

59+ mimeRender _ = cs . show

6060

6161

6262type TestApi1 = Get '[JSON, PlainText] Int