Allow swagger on disabled versions. (#3196)

wireapp · Mar 29, 2023 · b6d2ad8 · b6d2ad8
1 parent d3f488f
commit b6d2ad8
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 2 deletions.
diff --git a/changelog.d/4-docs/unblock-swagger b/changelog.d/4-docs/unblock-swagger
@@ -0,0 +1 @@
+Allow swagger on disabled versions.
diff --git a/libs/wire-api/src/Wire/API/Routes/Version/Wai.hs b/libs/wire-api/src/Wire/API/Routes/Version/Wai.hs
@@ -34,8 +34,8 @@ import Wire.API.Routes.Version
 -- | Strip off version prefix. Return 404 if the version is not supported.
 versionMiddleware :: Set Version -> Middleware
 versionMiddleware disabledAPIVersions app req k = case parseVersion (removeVersionHeader req) of
-  Right (req', v) ->
-    if v `elem` disabledAPIVersions
+  Right (req', v) -> do
+    if v `elem` disabledAPIVersions && requestIsDisableable req'
       then err (toUrlPiece v)
       else app (addVersionHeader v req') k
   Left (BadVersion v) -> err v
@@ -61,6 +61,13 @@ parseVersion req = do
 looksLikeVersion :: Text -> Bool
 looksLikeVersion version = case T.splitAt 1 version of (h, t) -> h == "v" && T.all isDigit t
 
+-- | swagger-delivering end-points are not disableable: they should work for all versions.
+requestIsDisableable :: Request -> Bool
+requestIsDisableable (pathInfo -> path) = case path of
+  ["api", "swagger-ui"] -> False
+  ["api", "swagger.json"] -> False
+  _ -> True
+
 removeVersionHeader :: Request -> Request
 removeVersionHeader req =
   req