copy modelcatalog.api.annotations to component annotations (#1486)

Author: gabemontero

workspaces/ai-integrations/plugins/catalog-backend-module-model-catalog/src/clients/ModelCatalogGenerator.test.ts

@@ -432,4 +432,88 @@ describe('Model Catalog Generator', () => {
     expectedEntities.push(expectedModelServerAPIEntity);
     expect(modelCatalogEntities).toEqual(expectedModelEntities);
   });
+
+  it('should copy API annotations to model server component metadata when present', () => {
+    const modelCatalog: ModelCatalog = {
+      modelServer: {
+        name: 'annotated-model-service',
+        owner: 'example-user',
+        description: 'Model service with API annotations',
+        API: {
+          url: 'https://api.example.com',
+          type: Type.Openapi,
+          spec: 'https://example.com/openapi.json',
+          annotations: {
+            'custom.io/annotation1': 'value1',
+            'custom.io/annotation2': 'value2',
+            'backstage.io/custom-tag': 'custom-value',
+          },
+        },
+        lifecycle: 'production',
+      },
+      models: [
+        {
+          name: 'test-model',
+          description: 'Test model',
+          lifecycle: 'production',
+          owner: 'example-user',
+        },
+      ],
+    };
+
+    const modelCatalogEntities = GenerateCatalogEntities(modelCatalog);
+
+    // Find the model server component entity
+    const modelServerComponent = modelCatalogEntities.find(
+      entity =>
+        entity.kind === 'Component' &&
+        entity.metadata.name === 'annotated-model-service',
+    ) as ComponentEntity;
+
+    expect(modelServerComponent).toBeDefined();
+    expect(modelServerComponent.metadata.annotations).toBeDefined();
+    expect(modelServerComponent.metadata.annotations).toEqual({
+      'custom.io/annotation1': 'value1',
+      'custom.io/annotation2': 'value2',
+      'backstage.io/custom-tag': 'custom-value',
+    });
+  });
+
+  it('should handle model server with API but no annotations gracefully', () => {
+    const modelCatalog: ModelCatalog = {
+      modelServer: {
+        name: 'no-annotations-service',
+        owner: 'example-user',
+        description: 'Model service without API annotations',
+        API: {
+          url: 'https://api.example.com',
+          type: Type.Openapi,
+          spec: 'https://example.com/openapi.json',
+          // No annotations property
+        },
+        lifecycle: 'production',
+      },
+      models: [
+        {
+          name: 'test-model',
+          description: 'Test model',
+          lifecycle: 'production',
+          owner: 'example-user',
+        },
+      ],
+    };
+
+    const modelCatalogEntities = GenerateCatalogEntities(modelCatalog);
+
+    // Find the model server component entity
+    const modelServerComponent = modelCatalogEntities.find(
+      entity =>
+        entity.kind === 'Component' &&
+        entity.metadata.name === 'no-annotations-service',
+    ) as ComponentEntity;
+
+    expect(modelServerComponent).toBeDefined();
+    // Should not have annotations if none were provided in API
+    expect(modelServerComponent.metadata.annotations).toBeUndefined();
+  });
 });

workspaces/ai-integrations/plugins/catalog-backend-module-model-catalog/src/clients/ModelCatalogGenerator.ts

@@ -194,6 +194,18 @@ export function GenerateModelServerComponentEntity(
       url: `${modelServer.API.url}`,
     });
     modelServerComponent.spec.providesApis = [modelServer.name];
+
+    // Copy annotations from API to component metadata if they exist
+    if (modelServer.API.annotations !== undefined) {
+      if (modelServerComponent.metadata.annotations === undefined) {
+        modelServerComponent.metadata.annotations = {};
+      }
+      // Copy all key-value pairs from API annotations to component annotations
+      Object.keys(modelServer.API.annotations).forEach(key => {
+        modelServerComponent.metadata.annotations![key] =
+          modelServer.API!.annotations![key];
+      });
+    }
   }
   if (modelServer.homepageURL !== undefined) {
     modelServerComponent.metadata.links.push({