Expose swagger docs for brig's internal (servantified) endpoints

Start the ToSchema party with brig and cannon

Remove unnecessary module qualifier

Fix type error

Fix

Create instance `ToSchema List1`

Add swagger tags (resulting in sections)

Replace over with %~

Introduce SwaggerTag combinator

Use lens

Add some documentation text

Test RawJson FromJSON/ToJSON

Cleanup

Delete unused endpoint

Align title with cannon's swagger title

Delete Won't-do ToDos

Add changelog

Remove superfluous comment

Add docs about Swagger

Describe the swagger URL pattern better

Use versions in swagger endpoint

Update docs

Move example section

Fix typo

Update swagger.md

Old Swagger is now gone.

Update services/brig/src/Brig/API/Public.hs

Co-authored-by: fisx <mf@zerobuzz.net>

Update services/brig/docs/swagger-internal-endpoints.md

Co-authored-by: fisx <mf@zerobuzz.net>

Update changelog.d/2-features/internal-endpoints-swagger

Co-authored-by: fisx <mf@zerobuzz.net>

Update libs/wire-api/src/Wire/API/SwaggerServant.hs

Co-authored-by: fisx <mf@zerobuzz.net>

Update libs/wire-api/test/unit/Test/Wire/API/Roundtrip/Aeson.hs

Co-authored-by: fisx <mf@zerobuzz.net>

Remove redundant constraint

Simplify operations tagging with allOperations Traversal

Use LText as data store of RawJson

Replace ToSchema instance with function

Increase lazy-ness of ToSchema RawJson instance

Remove ToSchema for internal data structures

Swagger docs for internal endpoints of Legalhold and Cargohold

Move galley's internal endpoint to wire-api

Swagger for internal Galley endpoints

Add spar's internal endpoints

libs/galley-types/galley-types.cabal

@@ -15,12 +15,10 @@ library
     Galley.Types
     Galley.Types.Bot
     Galley.Types.Bot.Service
-    Galley.Types.Conversations.Intra
     Galley.Types.Conversations.Members
     Galley.Types.Conversations.One2One
     Galley.Types.Conversations.Roles
     Galley.Types.Teams
-    Galley.Types.Teams.Intra
 
   other-modules:      Paths_galley_types
   hs-source-dirs:     src

libs/galley-types/test/unit/Test/Galley/Types.hs

@@ -24,7 +24,6 @@ import Control.Lens
 import Data.Set hiding (drop)
 import qualified Data.Set as Set
 import Galley.Types.Teams
-import Galley.Types.Teams.Intra (GuardLegalholdPolicyConflicts)
 import Imports
 import Test.Galley.Roundtrip (testRoundTrip)
 import qualified Test.QuickCheck as QC
@@ -49,7 +48,6 @@ tests =
             assertBool "owner.self" ((rolePermissions r2 ^. self) `isSubsetOf` (rolePermissions r1 ^. self))
             assertBool "owner.copy" ((rolePermissions r2 ^. copy) `isSubsetOf` (rolePermissions r1 ^. copy)),
       testRoundTrip @FeatureFlags,
-      testRoundTrip @GuardLegalholdPolicyConflicts,
       testGroup
         "permissionsRole, rolePermissions"
         [ testCase "'Role' maps to expected permissions" $ do

libs/types-common/src/Data/Json/Util.hs

@@ -61,6 +61,7 @@ import qualified Data.ByteString.Base64.URL as B64U
 import qualified Data.ByteString.Builder as BB
 import qualified Data.ByteString.Conversion as BS
 import qualified Data.ByteString.Lazy as L
+import qualified Data.Currency as Currency
 import Data.Fixed
 import Data.Schema
 import Data.String.Conversions (cs)
@@ -269,3 +270,12 @@ fromBase64Text = B64.decode . Text.encodeUtf8
 
 toBase64Text :: ByteString -> Text
 toBase64Text = Text.decodeUtf8 . B64.encode
+
+-- TODO: Find a better module for this
+instance ToSchema Currency.Alpha where
+  schema = mkSchema docs parseJSON (pure . toJSON)
+    where
+      docs =
+        swaggerDoc @Text
+          & S.schema . S.description ?~ "ISO 4217 alphabetic codes"
+          & S.schema . S.example ?~ "EUR"

libs/wire-api/src/Wire/API/Routes/Internal/Cargohold.hs

@@ -17,8 +17,21 @@
 
 module Wire.API.Routes.Internal.Cargohold where
 
+import Control.Lens
+import Data.Swagger
+import Imports
 import Servant
+import Servant.Swagger
 import Wire.API.Routes.MultiVerb
+import Wire.API.SwaggerServant
 
 type InternalAPI =
-  "i" :> "status" :> MultiVerb 'GET '() '[RespondEmpty 200 "OK"] ()
+  SwaggerTag "cargohold"
+    :> "i"
+    :> "status"
+    :> MultiVerb 'GET '() '[RespondEmpty 200 "OK"] ()
+
+swaggerDoc :: Swagger
+swaggerDoc =
+  toSwagger (Proxy @InternalAPI)
+    & info . title .~ "Wire-Server internal cargohold API"