fix: fix WSDL preview on component tab

dweber019 · Aug 30, 2024 · 0a9b433 · 0a9b433
1 parent b1de400
commit 0a9b433
Show file tree

Hide file tree

Showing 11 changed files with 33 additions and 836 deletions.
diff --git a/.changeset/strong-dryers-heal.md b/.changeset/strong-dryers-heal.md
@@ -0,0 +1,7 @@
+---
+'@dweber019/backstage-plugin-api-docs-module-wsdl': patch
+---
+
+Fix WSDL preview on component tab.
+
+**BREAKING**: Because of this change the API setup has changed, see README.
diff --git a/packages/app/src/apis.ts b/packages/app/src/apis.ts
@@ -46,13 +46,12 @@ export const apis: AnyApiFactory[] = [
     api: apiDocsConfigRef,
     deps: {},
     factory: () => {
-      // load the default widgets
       const definitionWidgets = defaultDefinitionWidgets();
-      // add the wsdl-docs api widget to the definition widgets
-      definitionWidgets.push(wsdlApiWidget);
       return {
         getApiDefinitionWidget: (apiEntity: ApiEntity) => {
-          // find the widget for the type of api entity
+          if (apiEntity.spec.type.toLowerCase() === 'wsdl') {
+            return wsdlApiWidget(apiEntity);
+          }
           return definitionWidgets.find(d => d.type === apiEntity.spec.type);
         },
       };

diff --git a/packages/entities/wsdl-api-example.yaml b/packages/entities/wsdl-api-example.yaml
@@ -9,3 +9,14 @@ spec:
   owner: foo
   definition:
     $text: http://www.dneonline.com/calculator.asmx?wsdl
+---
+apiVersion: backstage.io/v1alpha1
+kind: Component
+metadata:
+  name: wsdl-hello-world
+spec:
+  type: service
+  lifecycle: production
+  owner: user:development/guest
+  providesApis:
+    - wsdl-hello-world
diff --git a/plugins/api-docs-module-wsdl/README.md b/plugins/api-docs-module-wsdl/README.md
@@ -36,13 +36,12 @@ export const apis: AnyApiFactory[] = [
     api: apiDocsConfigRef,
     deps: {},
     factory: () => {
-      // load the default widgets
       const definitionWidgets = defaultDefinitionWidgets();
-      // add the wsdl-docs api widget to the definition widgets
-      definitionWidgets.push(wsdlApiWidget);
       return {
         getApiDefinitionWidget: (apiEntity: ApiEntity) => {
-          // find the widget for the type of api entity
+          if (apiEntity.spec.type.toLowerCase() === 'wsdl') {
+            return wsdlApiWidget(apiEntity);
+          }
           return definitionWidgets.find(d => d.type === apiEntity.spec.type);
         },
       };

diff --git a/plugins/api-docs-module-wsdl/dev/index.tsx b/plugins/api-docs-module-wsdl/dev/index.tsx
diff --git a/plugins/api-docs-module-wsdl/dev/wsdl-api.yaml b/plugins/api-docs-module-wsdl/dev/wsdl-api.yaml