rewire the api to be clean and consistent (#92)

fix route documentation

fix sorting scheme to be more clear for release notes

src/Handler/Marketplace.hs

@@ -87,8 +87,7 @@ import           Lib.PkgRepository              ( PkgRepo
                                                 , getIcon
                                                 , getManifest
                                                 )
-import           Lib.Types.AppIndex             ( PkgId(PkgId) )
-import           Lib.Types.AppIndex             ( )
+import           Lib.Types.AppIndex             ( PkgId )
 import           Lib.Types.Category             ( CategoryTitle(..) )
 import           Lib.Types.Emver                ( Version
                                                 , VersionRange
@@ -167,19 +166,19 @@ getEosVersionR = do
                   , eosResReleaseNotes = mappedVersions
                   }
 
-getReleaseNotesR :: Handler ReleaseNotes
-getReleaseNotesR = do
-    getParameters <- reqGetParams <$> getRequest
-    case lookup "id" getParameters of
-        Nothing      -> sendResponseStatus status400 (InvalidParamsE "get:id" "<MISSING>")
-        Just package -> do
-            appConnPool    <- appConnPool <$> getYesod
-            versionRecords <- runDB $ fetchAllAppVersions appConnPool (PkgId package)
-            pure $ constructReleaseNotesApiRes versionRecords
+getReleaseNotesR :: PkgId -> Handler ReleaseNotes
+getReleaseNotesR pkg = do
+    appConnPool    <- appConnPool <$> getYesod
+    versionRecords <- runDB $ fetchAllAppVersions appConnPool pkg
+    pure $ constructReleaseNotesApiRes versionRecords
     where
         constructReleaseNotesApiRes :: [VersionRecord] -> ReleaseNotes
         constructReleaseNotesApiRes vers = do
-            ReleaseNotes $ HM.fromList $ sortOn Down $ (versionRecordNumber &&& versionRecordReleaseNotes) <$> vers
+            ReleaseNotes
+                $   HM.fromList
+                $   sortOn (Down . fst)
+                $   (versionRecordNumber &&& versionRecordReleaseNotes)
+                <$> vers
 
 getEosR :: Handler TypedContent
 getEosR = do

src/Handler/Types/Marketplace.hs

@@ -68,7 +68,7 @@ instance FromJSON PackageRes where
         packageResDependencies <- o .: "dependency-metadata"
         pure PackageRes { .. }
 data DependencyRes = DependencyRes
-    { dependencyResTitle :: Text -- TODO switch to `Text` to display actual title in Marketplace. Confirm with FE that this will not break loading. Perhaps return title and id?
+    { dependencyResTitle :: Text
     , dependencyResIcon  :: Text
     }
     deriving (Eq, Show)