openapi-utils: rename export

Signed-off-by: Vincenzo Scamporlino <[email protected]>
RoadieHQ · Jan 23, 2025 · 25350e9 · 25350e9
1 parent df43519
commit 25350e9
Show file tree

Hide file tree

Showing 6 changed files with 8 additions and 8 deletions.
diff --git a/.changeset/thirty-dancers-cheat.md b/.changeset/thirty-dancers-cheat.md
@@ -2,16 +2,16 @@
 '@backstage/backend-openapi-utils': minor
 ---
 
-_BREAKING_: The `wrapInOpenApiTestServer` and `wrapServer` functions are now exported via `/tests` subpath. If you were importing these functions directly from the root of the package, you will need to update your imports to use the `/tests` subpath:
+**BREAKING**: The `wrapInOpenApiTestServer` and `wrapServer` functions are now exported via `/testUtils` subpath. If you were importing these functions directly from the root of the package, you will need to update your imports to use the `/testUtils` subpath:
 
 ```diff
 - import { wrapInOpenApiTestServer } from '@backstage/backend-openapi-utils';
-+ import { wrapInOpenApiTestServer } from '@backstage/backend-openapi-utils/tests';
++ import { wrapInOpenApiTestServer } from '@backstage/backend-openapi-utils/testUtils';
 ```
 
 or
 
 ```diff
 - import { wrapServer } from '@backstage/backend-openapi-utils';
-+ import { wrapServer } from '@backstage/backend-openapi-utils/tests';
++ import { wrapServer } from '@backstage/backend-openapi-utils/testUtils';
 ```
diff --git a/docs/openapi/01-getting-started.md b/docs/openapi/01-getting-started.md
@@ -97,7 +97,7 @@ For more information, see [the docs](./generate-client.md).
 Add the following lines to your `createRouter.test.ts` or `router.test.ts` file,
 
 ```diff
-+ import { wrapInOpenApiTestServer } from '@backstage/backend-openapi-utils/tests';
++ import { wrapInOpenApiTestServer } from '@backstage/backend-openapi-utils/testUtils';
 + import { Server } from 'http';
 
 ...

diff --git a/packages/backend-openapi-utils/package.json b/packages/backend-openapi-utils/package.json
@@ -17,14 +17,14 @@
   "license": "Apache-2.0",
   "exports": {
     ".": "./src/index.ts",
-    "./tests": "./src/testUtils.ts",
+    "./testUtils": "./src/testUtils.ts",
     "./package.json": "./package.json"
   },
   "main": "src/index.ts",
   "types": "src/index.ts",
   "typesVersions": {
     "*": {
-      "tests": [
+      "testUtils": [
         "src/testUtils.ts"
       ],
       "package.json": [

diff --git a/...backend-openapi-utils/report-tests.api.md → ...end-openapi-utils/report-testUtils.api.md b/...backend-openapi-utils/report-tests.api.md → ...end-openapi-utils/report-testUtils.api.md
diff --git a/plugins/catalog-backend/src/service/createRouter.test.ts b/plugins/catalog-backend/src/service/createRouter.test.ts
@@ -15,7 +15,7 @@
  */
 
 import { MiddlewareFactory } from '@backstage/backend-defaults/rootHttpRouter';
-import { wrapServer } from '@backstage/backend-openapi-utils/tests';
+import { wrapServer } from '@backstage/backend-openapi-utils/testUtils';
 import { mockCredentials, mockServices } from '@backstage/backend-test-utils';
 import type { Location } from '@backstage/catalog-client';
 import {

diff --git a/plugins/search-backend/src/service/router.test.ts b/plugins/search-backend/src/service/router.test.ts
@@ -23,7 +23,7 @@ import {
 import express from 'express';
 import request from 'supertest';
 import { createRouter } from './router';
-import { wrapServer } from '@backstage/backend-openapi-utils/tests';
+import { wrapServer } from '@backstage/backend-openapi-utils/testUtils';
 import { Server } from 'http';
 import {
   mockCredentials,