From 25350e9e5dc8607fc8566c0a2eb6f2ecf2a9078e Mon Sep 17 00:00:00 2001 From: Vincenzo Scamporlino Date: Thu, 23 Jan 2025 13:39:34 +0100 Subject: [PATCH] openapi-utils: rename export Signed-off-by: Vincenzo Scamporlino --- .changeset/thirty-dancers-cheat.md | 6 +++--- docs/openapi/01-getting-started.md | 2 +- packages/backend-openapi-utils/package.json | 4 ++-- .../{report-tests.api.md => report-testUtils.api.md} | 0 plugins/catalog-backend/src/service/createRouter.test.ts | 2 +- plugins/search-backend/src/service/router.test.ts | 2 +- 6 files changed, 8 insertions(+), 8 deletions(-) rename packages/backend-openapi-utils/{report-tests.api.md => report-testUtils.api.md} (100%) diff --git a/.changeset/thirty-dancers-cheat.md b/.changeset/thirty-dancers-cheat.md index 4dc4a97aad..083b3febbb 100644 --- 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 index 729472da71..875a369dbf 100644 --- 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 index 58c3932c1e..eff12e46f6 100644 --- 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/packages/backend-openapi-utils/report-tests.api.md b/packages/backend-openapi-utils/report-testUtils.api.md similarity index 100% rename from packages/backend-openapi-utils/report-tests.api.md rename to packages/backend-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 index 06a6e86bce..b0dddbdef0 100644 --- 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 index a596017767..c348302045 100644 --- 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,