change: API: rename Key to AppKey (#844)

Co-authored-by: kjetilhau <[email protected]>
equinor · Oct 31, 2024 · d814023 · d814023
1 parent ba66263
commit d814023
Show file tree

Hide file tree

Showing 7 changed files with 16 additions and 11 deletions.
diff --git a/.changeset/pr-844-2153430938.md b/.changeset/pr-844-2153430938.md
@@ -0,0 +1,5 @@
+
+---
+"fusion-project-portal": minor
+--- 
+Renames Key to AppKey in ApiPortallApp and ApiPortalOnboardedApp models
diff --git a/...nor.ProjectExecutionPortal.WebApi/ViewModels/PortalApp/ApiAddContextAppToPortalRequest.cs b/...nor.ProjectExecutionPortal.WebApi/ViewModels/PortalApp/ApiAddContextAppToPortalRequest.cs
@@ -19,7 +19,7 @@ public ApiAddContextAppToPortalRequestValidator()
                 RuleFor(x => x.AppKey)
                     .NotEmpty()
                     .NotContainScriptTag()
-                    .WithMessage("App Key required");
+                    .WithMessage("AppKey required");
             }
         }
     }

diff --git a/...inor.ProjectExecutionPortal.WebApi/ViewModels/PortalApp/ApiAddGlobalAppToPortalRequest.cs b/...inor.ProjectExecutionPortal.WebApi/ViewModels/PortalApp/ApiAddGlobalAppToPortalRequest.cs
@@ -27,7 +27,7 @@ public ApiAddGlobalAppToPortalRequestValidator()
                 RuleFor(x => x.AppKey)
                     .NotEmpty()
                     .NotContainScriptTag()
-                    .WithMessage("App Key required");
+                    .WithMessage("AppKey required");
             }
         }
     }

diff --git a/backend/src/Equinor.ProjectExecutionPortal.WebApi/ViewModels/PortalApp/ApiPortalApp.cs b/backend/src/Equinor.ProjectExecutionPortal.WebApi/ViewModels/PortalApp/ApiPortalApp.cs
@@ -12,12 +12,12 @@ public ApiPortalApp()
         }
         public ApiPortalApp(PortalAppDto portalAppDto)
         {
-            Key = portalAppDto.OnboardedApp.AppKey;
+            AppKey = portalAppDto.OnboardedApp.AppKey;
             ContextTypes = portalAppDto.OnboardedApp.ContextTypes.Select(x => new ApiContextType(x)).ToList();
             AppManifest = portalAppDto.OnboardedApp.AppInformation != null ? new ApiFusionApp(portalAppDto.OnboardedApp.AppInformation) : null;
         }
 
-        public string Key { get; set; }
+        public string AppKey { get; set; }
         public IList<ApiContextType> ContextTypes { get; set; }
         public ApiFusionApp? AppManifest { get; set; }
     }

diff --git a/...d/src/Equinor.ProjectExecutionPortal.WebApi/ViewModels/PortalApp/ApiPortalOnboardedApp.cs b/...d/src/Equinor.ProjectExecutionPortal.WebApi/ViewModels/PortalApp/ApiPortalOnboardedApp.cs
@@ -10,7 +10,7 @@ public ApiPortalOnboardedApp()
 
         public ApiPortalOnboardedApp(PortalOnboardedAppDto portalOnboardedAppDto)
         {
-            Key = portalOnboardedAppDto.OnboardedApp.AppKey;
+            AppKey = portalOnboardedAppDto.OnboardedApp.AppKey;
             ContextTypes = portalOnboardedAppDto.OnboardedApp.ContextTypes.Select(x => x.ContextTypeKey).ToList();
             ContextIds = portalOnboardedAppDto.ContextIds;
             IsActive = portalOnboardedAppDto.IsActive;
@@ -19,7 +19,7 @@ public ApiPortalOnboardedApp(PortalOnboardedAppDto portalOnboardedAppDto)
             AppManifest = portalOnboardedAppDto.OnboardedApp.AppInformation != null ? new ApiFusionApp(portalOnboardedAppDto.OnboardedApp.AppInformation) : null;
         }
 
-        public string Key { get; set; }
+        public string AppKey { get; set; }
         public IList<string> ContextTypes { get; set; }
         public IList<Guid> ContextIds { get; set; }
         public bool IsActive { get; set; }

diff --git a/...d/src/tests/Equinor.ProjectExecutionPortal.Tests.WebApi/IntegrationTests/AssertHelpers.cs b/...d/src/tests/Equinor.ProjectExecutionPortal.Tests.WebApi/IntegrationTests/AssertHelpers.cs
@@ -47,7 +47,7 @@ public static void AssertPortalAppValues(ApiPortalApp? portalAll)
                 Assert.Fail();
             }
 
-            Assert.IsNotNull(portalAll.Key);
+            Assert.IsNotNull(portalAll.AppKey);
         }
 
         public static void AssertOnboardedAppValues(ApiOnboardedApp? onboardedApp)

diff --git a/...sts/Equinor.ProjectExecutionPortal.Tests.WebApi/IntegrationTests/PortalControllerTests.cs b/...sts/Equinor.ProjectExecutionPortal.Tests.WebApi/IntegrationTests/PortalControllerTests.cs
@@ -500,13 +500,13 @@ public async Task Delete_PortalApp_AsAdministrator_ShouldReturnOk()
             var appToDelete = apps.First();
 
             // Act
-            var response = await DeletePortalApp(portalToTest.Id, appToDelete.Key, UserType.Administrator);
+            var response = await DeletePortalApp(portalToTest.Id, appToDelete.AppKey, UserType.Administrator);
 
             // Assert
             Assert.AreEqual(HttpStatusCode.OK, response.StatusCode);
 
             // Verify the app is actually deleted
-            var deletedApp = await AssertGetPortalApp(portalToTest.Id, appToDelete.Key, UserType.Authenticated, HttpStatusCode.NotFound);
+            var deletedApp = await AssertGetPortalApp(portalToTest.Id, appToDelete.AppKey, UserType.Authenticated, HttpStatusCode.NotFound);
             Assert.IsNull(deletedApp);
         }
 
@@ -526,7 +526,7 @@ public async Task Delete_PortalApp_AsAuthenticatedUser_ShouldReturnForbidden()
             var appToDelete = apps.First();
 
             // Act
-            var response = await DeletePortalApp(portalToTest.Id, appToDelete.Key, UserType.Authenticated);
+            var response = await DeletePortalApp(portalToTest.Id, appToDelete.AppKey, UserType.Authenticated);
 
             // Assert
             Assert.AreEqual(HttpStatusCode.Forbidden, response.StatusCode);
@@ -548,7 +548,7 @@ public async Task Delete_PortalApp_AsAnonymousUser_ShouldReturnUnauthorized()
             var appToDelete = apps.First();
 
             // Act
-            var response = await DeletePortalApp(portalToTest.Id, appToDelete.Key, UserType.Anonymous);
+            var response = await DeletePortalApp(portalToTest.Id, appToDelete.AppKey, UserType.Anonymous);
 
             // Assert
             Assert.AreEqual(HttpStatusCode.Unauthorized, response.StatusCode);