[CO-322] Fix the issue by replacing < with - and [] with __

[CO-322] Changelog entry

[CO-322] pkgs/generate.sh

Author: parsonsmatt

CHANGELOG.md

@@ -30,6 +30,9 @@
 
 - Improve type safety (and as a consequence, API documentation) of account indexes (CBR-306)
 
+- The Swagger specification had names with illegal characters. These names
+  where changed to be URL friendly. [PR #3595](https://github.com/input-output-hk/cardano-sl/pull/3595)
+
 ### Improvements
 
 - Friendly error mistakes from deserializing invalid addresses instead of brutal 500 (CBR-283)

pkgs/default.nix

@@ -17704,6 +17704,7 @@ license = stdenv.lib.licenses.mit;
 , http-client
 , http-client-tls
 , http-types
+, insert-ordered-containers
 , ixset-typed
 , lens
 , memory
@@ -17924,6 +17925,7 @@ formatting
 hedgehog
 hspec
 hspec-core
+insert-ordered-containers
 lens
 mtl
 normaldistribution

wallet-new/cardano-sl-wallet-new.cabal

@@ -601,6 +601,7 @@ test-suite wallet-new-specs
                     , cardano-sl-core-test
                     , cardano-sl-crypto
                     , cardano-sl-chain
+                    , cardano-sl-util
                     , cardano-sl-util-test
                     , cardano-sl-wallet
                     , cardano-sl-wallet-new

wallet-new/src/Cardano/Wallet/API/Response.hs

@@ -114,11 +114,14 @@ instance ToJSON a => MimeRender OctetStream (WalletResponse a) where
 instance (ToSchema a, Typeable a) => ToSchema (WalletResponse a) where
     declareNamedSchema _ = do
         let a = Proxy @a
-            tyName = toText . show $ typeRep a
+            tyName = toText . map sanitize . show $ typeRep a
+            sanitize c
+                | c `elem` (":/?#[]@!$&'()*+,;=" :: String) = '_'
+                | otherwise = c
         aRef <- declareSchemaRef a
         respRef <- declareSchemaRef (Proxy @ResponseStatus)
         metaRef <- declareSchemaRef (Proxy @Metadata)
-        pure $ NamedSchema (Just $ "WalletResponse<" <> tyName <> ">") $ mempty
+        pure $ NamedSchema (Just $ "WalletResponse-" <> tyName) $ mempty
             & type_ .~ SwaggerObject
             & required .~ ["data", "status", "meta"]
             & properties .~