Merge pull request #21964 from backstage/freben/unregister

Fix a bug in `getLocationByRef` that led to invalid backend calls

.changeset/large-poets-buy.md

@@ -0,0 +1,5 @@
+---
+'@backstage/catalog-client': patch
+---
+
+Fix a bug in `getLocationByRef` that led to invalid backend calls

.changeset/lazy-teachers-walk.md

@@ -0,0 +1,5 @@
+---
+'@backstage/repo-tools': patch
+---
+
+Updated the OpenAPI template to export the `TypedResponse` interface so that client code can leverage it

docs/frontend-system/utility-apis/05-migrating.md

@@ -42,7 +42,7 @@ import { createApiRef } from '@backstage/frontend-plugin-api';
 
 /**
  * Performs some work.
- * @oublic
+ * @public
  */
 export interface WorkApi {
   doWork(): Promise<void>;

packages/catalog-client/src/CatalogClient.ts

@@ -43,7 +43,7 @@ import {
   QueryEntitiesResponse,
 } from './types/api';
 import { isQueryEntitiesInitialRequest } from './utils';
-import { DefaultApiClient } from './generated';
+import { DefaultApiClient, TypedResponse } from './generated';
 
 /**
  * A frontend and backend compatible client for communicating with the Backstage
@@ -112,7 +112,7 @@ export class CatalogClient implements CatalogApi {
       }
     }
 
-    const entities: Entity[] = await this.requestRequired(
+    const entities = await this.requestRequired(
       await this.apiClient.getEntities(
         {
           query: {
@@ -345,8 +345,8 @@ export class CatalogClient implements CatalogApi {
     locationRef: string,
     options?: CatalogRequestOptions,
   ): Promise<Location | undefined> {
-    const all: { data: Location }[] = await this.requestRequired(
-      await this.apiClient.getLocation({ path: { id: locationRef } }, options),
+    const all = await this.requestRequired(
+      await this.apiClient.getLocations({}, options),
     );
     return all
       .map(r => r.data)
@@ -418,7 +418,7 @@ export class CatalogClient implements CatalogApi {
     }
   }
 
-  private async requestRequired<T = any>(response: Response): Promise<T> {
+  private async requestRequired<T>(response: TypedResponse<T>): Promise<T> {
     if (!response.ok) {
       throw await ResponseError.fromResponse(response);
     }

packages/catalog-client/src/generated/apis/DefaultApi.client.ts

@@ -35,7 +35,12 @@ import { Location } from '../models/Location.model';
 import { RefreshEntityRequest } from '../models/RefreshEntityRequest.model';
 import { ValidateEntityRequest } from '../models/ValidateEntityRequest.model';
 
-type TypedResponse<T> = Omit<Response, 'json'> & {
+/**
+ * Wraps the Response type to convey a type on the json call.
+ *
+ * @public
+ */
+export type TypedResponse<T> = Omit<Response, 'json'> & {
   json: () => Promise<T>;
 };
 

packages/repo-tools/templates/typescript-backstage/api.mustache

@@ -9,7 +9,12 @@ import * as parser from 'uri-template';
 import { {{classname}} } from '{{filename}}.model{{importFileExtension}}';
 {{/imports}}
 
-type TypedResponse<T> = Omit<Response, 'json'> & {
+/**
+ * Wraps the Response type to convey a type on the json call.
+ *
+ * @public
+ */
+export type TypedResponse<T> = Omit<Response, 'json'> & {
   json: () => Promise<T>;
 };
 
@@ -84,9 +89,9 @@ export class {{classname}}Client {
         options?: RequestOptions
     ): Promise<TypedResponse<{{{returnType}}} {{^returnType}}void{{/returnType}}>> {
         const baseUrl = await this.discoveryApi.getBaseUrl(pluginId);
-        
+
         const uriTemplate = `{{{path}}}{{#hasQueryParams}}{?{{#queryParams}}{{baseName}}{{#isArray}}{{#isExplode}}*{{/isExplode}}{{/isArray}}{{^-last}},{{/-last}}{{/queryParams}}}{{/hasQueryParams}}`;
-        
+
         const uri = parser.parse(uriTemplate).expand({
         {{#pathParams}}
             {{baseName}}: request.path.{{paramName}},