APS-4600 Update to use ApiEntity for openapi APIs instead of custom type

Author: Paul Howells

plugins/catalog-backend-module-bc-data-catalogue/src/BcDataCatalogueEntityFactory.ts

@@ -12,7 +12,6 @@ import {
 import {
   parseOpenApiDocument,
   type DatasetEntity,
-  type OpenApiEntity,
 } from '@bcgov/plugin-catalog-common-bc-data-catalogue';
 import type {
   BcDataCataloguePackage,
@@ -173,7 +172,7 @@ export class BcDataCatalogueEntityFactory {
 
     const allDatasets = new Map<string, DatasetEntity>();
     const allApis = new Map<string, ApiEntity>();
-    const allOpenApis = new Map<string, OpenApiEntity>();
+    const allOpenApis = new Map<string, ApiEntity>();
     const openApiDefinitionToId = new Map<string, string>();
 
     for (const pkg of allPackages) {
@@ -280,7 +279,7 @@ export class BcDataCatalogueEntityFactory {
             definitionHost,
             allOpenApis,
           );
-          const openApiId = this.naming.getOpenApiId(openApiSafeName);
+          const openApiId = this.naming.getApiId(openApiSafeName);
 
           const openApiEntity = await this.openApiEntityBuilder.build({
             pkg,
@@ -373,7 +372,7 @@ export class BcDataCatalogueEntityFactory {
     const systemEntities: SystemEntity[] = Array.from(allSystems.values());
     const datasetEntities: DatasetEntity[] = Array.from(allDatasets.values());
     const apiEntities: ApiEntity[] = Array.from(allApis.values());
-    const openApiEntities: OpenApiEntity[] = Array.from(allOpenApis.values());
+    const openApiEntities: ApiEntity[] = Array.from(allOpenApis.values());
 
     allEntities.push(...userEntities);
     allEntities.push(...groupEntities);
@@ -391,14 +390,14 @@ export class BcDataCatalogueEntityFactory {
   private buildOpenApiSafeName(
     resourceName: string,
     host: string | undefined,
-    allOpenApis: Map<string, OpenApiEntity>,
+    allOpenApis: Map<string, ApiEntity>,
   ): string {
     const baseName = host
       ? this.naming.toSafeName(`${resourceName}-${host}`)
       : this.naming.toSafeName(resourceName);
 
     let candidateName = baseName;
-    let candidateOpenApiId = this.naming.getOpenApiId(candidateName);
+    let candidateOpenApiId = this.naming.getApiId(candidateName);
 
     if (!allOpenApis.has(candidateOpenApiId)) {
       return candidateName;
@@ -420,7 +419,7 @@ export class BcDataCatalogueEntityFactory {
     candidateName = this.naming.toSafeName(
       `${truncatedBase}${suffixWithSeparator}`,
     );
-    candidateOpenApiId = this.naming.getOpenApiId(candidateName);
+    candidateOpenApiId = this.naming.getApiId(candidateName);
 
     let counter = 1;
     while (allOpenApis.has(candidateOpenApiId)) {
@@ -438,7 +437,7 @@ export class BcDataCatalogueEntityFactory {
       candidateName = this.naming.toSafeName(
         `${truncatedBaseForCounter}${suffixWithSeparator}${counterSuffix}`,
       );
-      candidateOpenApiId = this.naming.getOpenApiId(candidateName);
+      candidateOpenApiId = this.naming.getApiId(candidateName);
       counter++;
     }
 
@@ -558,4 +557,4 @@ export class BcDataCatalogueEntityFactory {
     const match = email.trim().toLowerCase().match(/@([\w.-]+)/);
     return match ? match[1] : undefined;
   }
-}
+}

plugins/catalog-backend-module-bc-data-catalogue/src/BcDataCatalogueNaming.ts

@@ -32,10 +32,6 @@ export class BcDataCatalogueNaming {
     return `api:default/${name.toLowerCase()}`;
   }
 
-  getOpenApiId(name: string): string {
-    return `openapi:default/${name.toLowerCase()}`;
-  }
-
   extractDistinguishingSuffix(resourceName: string): string {
     const safeName = this.toSafeName(resourceName);
 
@@ -81,4 +77,4 @@ export class BcDataCatalogueNaming {
 
     return safeName.split('-').slice(-1)[0].slice(0, 10);
   }
-}
+}