Switch from id to uuid in document template

Author: vknaisl

registry-public/src/RegistryLib/Api/Resource/DocumentTemplate/DocumentTemplateSimpleDTO.hs

@@ -1,12 +1,13 @@
 module RegistryLib.Api.Resource.DocumentTemplate.DocumentTemplateSimpleDTO where
 
 import Data.Time
+import qualified Data.UUID as U
 import GHC.Generics
 
 import RegistryLib.Model.Organization.OrganizationSimple
 
 data DocumentTemplateSimpleDTO = DocumentTemplateSimpleDTO
-  { tId :: String
+  { uuid :: U.UUID
   , name :: String
   , organizationId :: String
   , templateId :: String

registry-server/src/Registry/Api/Handler/DocumentTemplate/Detail_Bundle_GET.hs

@@ -10,29 +10,31 @@ import Registry.Model.Context.BaseContext
 import Registry.Service.DocumentTemplate.Bundle.DocumentTemplateBundleService
 import Shared.Common.Api.Handler.Common
 import Shared.Common.Model.Context.TransactionState
+import Shared.Coordinate.Api.Resource.Coordinate.CoordinateJM ()
+import Shared.Coordinate.Model.Coordinate.Coordinate
 
 type Detail_Bundle_GET =
   Header "Authorization" String
     :> "document-templates"
-    :> Capture "documentTemplateId" String
+    :> Capture "coordinate" Coordinate
     :> "bundle"
     :> Get '[OctetStream] (Headers '[Header "x-trace-uuid" String, Header "Content-Disposition" String] FileStreamLazy)
 
 type Templates__Detail_Bundle_GET =
   Header "Authorization" String
     :> "templates"
-    :> Capture "documentTemplateId" String
+    :> Capture "coordinate" Coordinate
     :> "bundle"
     :> Get '[OctetStream] (Headers '[Header "x-trace-uuid" String, Header "Content-Disposition" String] FileStreamLazy)
 
 detail_bundle_GET
   :: Maybe String
-  -> String
+  -> Coordinate
   -> BaseContextM (Headers '[Header "x-trace-uuid" String, Header "Content-Disposition" String] FileStreamLazy)
-detail_bundle_GET mTokenHeader tmlId =
+detail_bundle_GET mTokenHeader documentTemplateId =
   getAuthServiceExecutor mTokenHeader $ \runInAuthService ->
     runInAuthService NoTransaction $ do
-      zipFile <- exportBundle tmlId
+      zipFile <- exportBundle documentTemplateId
       let cdHeader = "attachment;filename=\"template.zip\""
       traceUuid <- asks traceUuid
       return . addHeader (U.toString traceUuid) . addHeader cdHeader . FileStreamLazy $ zipFile

registry-server/src/Registry/Api/Handler/DocumentTemplate/Detail_GET.hs

@@ -1,5 +1,6 @@
 module Registry.Api.Handler.DocumentTemplate.Detail_GET where
 
+import qualified Data.UUID as U
 import Servant
 
 import Registry.Api.Handler.Common
@@ -13,8 +14,8 @@ import Shared.Common.Model.Context.TransactionState
 
 type Detail_GET =
   "document-templates"
-    :> Capture "documentTemplateId" String
+    :> Capture "uuid" U.UUID
     :> Get '[SafeJSON] (Headers '[Header "x-trace-uuid" String] DocumentTemplateDetailDTO)
 
-detail_GET :: String -> BaseContextM (Headers '[Header "x-trace-uuid" String] DocumentTemplateDetailDTO)
-detail_GET tmlId = runInUnauthService NoTransaction $ addTraceUuidHeader =<< getDocumentTemplateById tmlId
+detail_GET :: U.UUID -> BaseContextM (Headers '[Header "x-trace-uuid" String] DocumentTemplateDetailDTO)
+detail_GET uuid = runInUnauthService NoTransaction $ addTraceUuidHeader =<< getDocumentTemplateByUuid uuid

registry-server/src/Registry/Api/Handler/DocumentTemplate/List_Bundle_POST.hs

@@ -4,26 +4,26 @@ import Servant
 import Servant.Multipart
 
 import Registry.Api.Handler.Common
-import Registry.Api.Resource.DocumentTemplate.DocumentTemplateDetailDTO
-import Registry.Api.Resource.DocumentTemplate.DocumentTemplateDetailJM ()
 import Registry.Model.Context.BaseContext
 import Registry.Service.DocumentTemplate.Bundle.DocumentTemplateBundleService
 import Shared.Common.Api.Handler.Common
 import Shared.Common.Api.Resource.Common.FileDTO
 import Shared.Common.Api.Resource.Common.FileJM ()
 import Shared.Common.Model.Context.TransactionState
+import Shared.DocumentTemplate.Api.Resource.DocumentTemplate.DocumentTemplateSimpleJM ()
+import Shared.DocumentTemplate.Model.DocumentTemplate.DocumentTemplateSimple
 
 type List_Bundle_POST =
   Header "Authorization" String
     :> MultipartForm Mem FileDTO
     :> "document-templates"
     :> "bundle"
-    :> PostCreated '[SafeJSON] (Headers '[Header "x-trace-uuid" String] DocumentTemplateDetailDTO)
+    :> PostCreated '[SafeJSON] (Headers '[Header "x-trace-uuid" String] DocumentTemplateSimple)
 
 list_bundle_POST
   :: Maybe String
   -> FileDTO
-  -> BaseContextM (Headers '[Header "x-trace-uuid" String] DocumentTemplateDetailDTO)
+  -> BaseContextM (Headers '[Header "x-trace-uuid" String] DocumentTemplateSimple)
 list_bundle_POST mTokenHeader reqDto =
   getAuthServiceExecutor mTokenHeader $ \runInAuthService ->
     runInAuthService Transactional $

registry-server/src/Registry/Api/Handler/Locale/Detail_Bundle_GET.hs

@@ -16,7 +16,7 @@ import Shared.Coordinate.Model.Coordinate.Coordinate
 type Detail_Bundle_GET =
   Header "Authorization" String
     :> "locales"
-    :> Capture "id" Coordinate
+    :> Capture "coordinate" Coordinate
     :> "bundle"
     :> Get '[OctetStream] (Headers '[Header "x-trace-uuid" String, Header "Content-Disposition" String] FileStreamLazy)
 

registry-server/src/Registry/Api/Handler/Locale/Detail_GET.hs

@@ -15,7 +15,7 @@ import Shared.Coordinate.Model.Coordinate.Coordinate
 
 type Detail_GET =
   "locales"
-    :> Capture "id" Coordinate
+    :> Capture "coordinate" Coordinate
     :> Get '[SafeJSON] (Headers '[Header "x-trace-uuid" String] LocaleDetailDTO)
 
 detail_GET :: Coordinate -> BaseContextM (Headers '[Header "x-trace-uuid" String] LocaleDetailDTO)

registry-server/src/Registry/Api/Handler/Swagger/Api.hs

@@ -26,6 +26,7 @@ import Shared.Common.Api.Resource.Info.InfoSM ()
 import Shared.Component.Api.Resource.Component.ComponentSM ()
 import Shared.Coordinate.Api.Resource.Coordinate.CoordinateSM ()
 import Shared.DocumentTemplate.Api.Resource.DocumentTemplate.DocumentTemplateSM ()
+import Shared.DocumentTemplate.Api.Resource.DocumentTemplate.DocumentTemplateSimpleSM ()
 import Shared.DocumentTemplate.Api.Resource.DocumentTemplateBundle.DocumentTemplateBundleSM ()
 import Shared.KnowledgeModel.Api.Resource.KnowledgeModel.Bundle.KnowledgeModelBundlePackageSM ()
 import Shared.KnowledgeModel.Api.Resource.KnowledgeModel.Bundle.KnowledgeModelBundleSM ()

registry-server/src/Registry/Api/Resource/DocumentTemplate/DocumentTemplateDetailDTO.hs

@@ -1,13 +1,14 @@
 module Registry.Api.Resource.DocumentTemplate.DocumentTemplateDetailDTO where
 
 import Data.Time
+import qualified Data.UUID as U
 import GHC.Generics
 
 import RegistryLib.Model.Organization.OrganizationSimple
 import Shared.Common.Model.Common.SemVer2Tuple
 
 data DocumentTemplateDetailDTO = DocumentTemplateDetailDTO
-  { tId :: String
+  { uuid :: U.UUID
   , name :: String
   , organizationId :: String
   , templateId :: String

registry-server/src/Registry/Database/Migration/Development/Audit/AuditSchemaMigration.hs

@@ -31,7 +31,7 @@ createTables = do
         \    document_template_count        int, \
         \    document_count                 int, \
         \    knowledge_model_package_id     varchar, \
-        \    document_template_id           varchar, \
+        \    document_template_uuid           varchar, \
         \    locale_id                      varchar \
         \);"
   let action conn = execute_ conn sql

registry-server/src/Registry/Database/Migration/Development/DocumentTemplate/DocumentTemplateMigration.hs

@@ -30,5 +30,5 @@ runMigration = do
   insertFile fileDefaultHtml
   insertFile fileDefaultCss
   insertAsset assetLogo
-  putAsset wizardDocumentTemplate.tId assetLogo.uuid assetLogo.contentType assetLogoContent
+  putAsset wizardDocumentTemplate.uuid assetLogo.uuid assetLogo.contentType assetLogoContent
   logInfo _CMP_MIGRATION "(Fixtures/DocumentTemplate) ended"