Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion changelog.d/4-docs/update-fed-error-docs
Original file line number Diff line number Diff line change
@@ -1 +1 @@
Update federation error documentation after changes to the federation API (#1956, #1978)
Update federation error documentation after changes to the federation API (#1956, #1975, #1978)
15 changes: 11 additions & 4 deletions services/brig/Setup.hs
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ import Data.Maybe
import Distribution.Simple
import Distribution.Simple.BuildPaths
import Distribution.Simple.LocalBuildInfo
import Distribution.Types.PackageDescription
import System.Directory
import System.FilePath

Expand All @@ -30,12 +31,18 @@ main =
defaultMainWithHooks
simpleUserHooks
{ buildHook = \desc info hooks flags -> do
withLibLBI desc info $ \_ lib -> do
let base = autogenComponentModulesDir info lib </> "Brig" </> "Docs"
generateDocs base "swagger.md"
buildHook simpleUserHooks desc info hooks flags
generate desc info
buildHook simpleUserHooks desc info hooks flags,
replHook = \desc info hooks flags args -> do
generate desc info
replHook simpleUserHooks desc info hooks flags args
}

generate :: PackageDescription -> LocalBuildInfo -> IO ()
generate desc info = withLibLBI desc info $ \_ lib -> do
let base = autogenComponentModulesDir info lib </> "Brig" </> "Docs"
generateDocs base "swagger.md"

generateDocs :: FilePath -> FilePath -> IO ()
generateDocs base src = do
contents <- readFile ("docs" </> src)
Expand Down
10 changes: 7 additions & 3 deletions services/brig/brig.cabal
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
cabal-version: 1.24
cabal-version: 2.0

-- This file has been generated from package.yaml by hpack version 0.33.0.
--
-- see: https://github.com/sol/hpack
--
-- hash: c37f84d005641650921717e1f340e18d82edd30045196f89649cefd53e549dfb
-- hash: 513c0f5104342fb14b0246f7c44733a84ec36fae97633fc55cb209e0e0bcd087

name: brig
version: 1.35.0
version: 2.0
synopsis: User Service
category: Network
author: Wire Swiss GmbH
Expand All @@ -16,6 +16,8 @@ copyright: (c) 2017 Wire Swiss GmbH
license: AGPL-3
license-file: LICENSE
build-type: Custom
extra-source-files:
docs/swagger.md

custom-setup
setup-depends:
Expand Down Expand Up @@ -120,6 +122,8 @@ library
other-modules:
Paths_brig
Brig.Docs.Swagger
autogen-modules:
Brig.Docs.Swagger
hs-source-dirs:
src
default-extensions: AllowAmbiguousTypes BangPatterns ConstraintKinds DataKinds DefaultSignatures DerivingStrategies DerivingVia DeriveFunctor DeriveGeneric DeriveLift DeriveTraversable EmptyCase FlexibleContexts FlexibleInstances FunctionalDependencies GADTs InstanceSigs KindSignatures LambdaCase MultiParamTypeClasses MultiWayIf NamedFieldPuns NoImplicitPrelude OverloadedStrings PackageImports PatternSynonyms PolyKinds QuasiQuotes RankNTypes ScopedTypeVariables StandaloneDeriving TemplateHaskell TupleSections TypeApplications TypeFamilies TypeFamilyDependencies TypeOperators UndecidableInstances ViewPatterns
Expand Down
7 changes: 4 additions & 3 deletions services/brig/package.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
defaults:
local: ../../package-defaults.yaml
name: brig
version: '1.35.0'
version: '2.0'
synopsis: User Service
category: Network
author: Wire Swiss GmbH
Expand All @@ -17,10 +17,11 @@ custom-setup:
- containers
- directory
- filepath
extra-source-files:
- docs/*
library:
source-dirs: src
other-modules:
- Paths_brig
generated-other-modules:
- Brig.Docs.Swagger
dependencies:
- aeson >=0.11
Expand Down