Merge pull request #13705 from taras/fix-url-location

[Catalog] Location url was incorrect in tests

.changeset/plenty-kids-fetch.md

@@ -0,0 +1,5 @@
+---
+'@backstage/catalog-client': patch
+---
+
+Renamed argument in `validateEntity` from `location` to `locationRef`

packages/catalog-client/api-report.md

@@ -68,7 +68,7 @@ export interface CatalogApi {
   ): Promise<void>;
   validateEntity(
     entity: Entity,
-    location: string,
+    locationRef: string,
     options?: CatalogRequestOptions,
   ): Promise<ValidateEntityResponse>;
 }
@@ -130,7 +130,7 @@ export class CatalogClient implements CatalogApi {
   ): Promise<void>;
   validateEntity(
     entity: Entity,
-    location: string,
+    locationRef: string,
     options?: CatalogRequestOptions,
   ): Promise<ValidateEntityResponse>;
 }

packages/catalog-client/src/CatalogClient.test.ts

@@ -322,7 +322,7 @@ describe('CatalogClient', () => {
               name: '',
             },
           },
-          'http://example.com',
+          'url:http://example.com',
         ),
       ).toMatchObject({
         valid: false,
@@ -350,7 +350,7 @@ describe('CatalogClient', () => {
               name: 'good',
             },
           },
-          'http://example.com',
+          'url:http://example.com',
         ),
       ).toMatchObject({
         valid: true,
@@ -373,7 +373,7 @@ describe('CatalogClient', () => {
               name: 'good',
             },
           },
-          'http://example.com',
+          'url:http://example.com',
         ),
       ).rejects.toThrow(/Request failed with 500 Error/);
     });

packages/catalog-client/src/CatalogClient.ts

@@ -359,7 +359,7 @@ export class CatalogClient implements CatalogApi {
    */
   async validateEntity(
     entity: Entity,
-    location: string,
+    locationRef: string,
     options?: CatalogRequestOptions,
   ): Promise<ValidateEntityResponse> {
     const response = await this.fetchApi.fetch(
@@ -370,7 +370,7 @@ export class CatalogClient implements CatalogApi {
           ...(options?.token && { Authorization: `Bearer ${options?.token}` }),
         },
         method: 'POST',
-        body: JSON.stringify({ entity, location }),
+        body: JSON.stringify({ entity, location: locationRef }),
       },
     );
 

packages/catalog-client/src/types/api.ts

@@ -405,11 +405,11 @@ export interface CatalogApi {
    * Validate entity and its location.
    *
    * @param entity - Entity to validate
-   * @param location - URL location of the entity
+   * @param locationRef - Location ref in format `url:http://example.com/file`
    */
   validateEntity(
     entity: Entity,
-    location: string,
+    locationRef: string,
     options?: CatalogRequestOptions,
   ): Promise<ValidateEntityResponse>;
 }