paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity
Files
d95cf37ce30d88946c94de25a5a31025d47521bf
backstage/packages/backend-openapi-utils/CHANGELOG.md
T
github-actions[bot] e6df5d52ce Version Packages
2026-02-17 16:06:18 +00:00

21 KiB
Raw Blame History

@backstage/backend-openapi-utils

0.6.6

Patch Changes

  • 7455dae: Use node prefix on native imports
  • Updated dependencies
    • @backstage/backend-plugin-api@1.7.0

0.6.6-next.0

Patch Changes

  • 7455dae: Use node prefix on native imports
  • Updated dependencies
    • @backstage/backend-plugin-api@1.7.0-next.0
    • @backstage/errors@1.2.7
    • @backstage/types@1.2.2

0.6.5

Patch Changes

  • 6678b78: Internal update to use native feature from our request validation library for handling base path determination.
  • Updated dependencies
    • @backstage/backend-plugin-api@1.6.1

0.6.5-next.0

Patch Changes

  • 6678b78: Internal update to use native feature from our request validation library for handling base path determination.
  • Updated dependencies
    • @backstage/backend-plugin-api@1.6.0
    • @backstage/errors@1.2.7
    • @backstage/types@1.2.2

0.6.4

Patch Changes

  • de96a60: chore(deps): bump express from 4.21.2 to 4.22.0
  • Updated dependencies
    • @backstage/backend-plugin-api@1.6.0

0.6.4-next.1

Patch Changes

  • de96a60: chore(deps): bump express from 4.21.2 to 4.22.0
  • Updated dependencies
    • @backstage/backend-plugin-api@1.6.0-next.1
    • @backstage/errors@1.2.7
    • @backstage/types@1.2.2

0.6.4-next.0

Patch Changes

  • Updated dependencies
    • @backstage/backend-plugin-api@1.5.1-next.0
    • @backstage/errors@1.2.7
    • @backstage/types@1.2.2

0.6.3

Patch Changes

  • Updated dependencies
    • @backstage/backend-plugin-api@1.5.0

0.6.3-next.1

Patch Changes

  • Updated dependencies
    • @backstage/backend-plugin-api@1.5.0-next.1

0.6.3-next.0

Patch Changes

  • Updated dependencies
    • @backstage/backend-plugin-api@1.4.5-next.0
    • @backstage/errors@1.2.7
    • @backstage/types@1.2.2

0.6.2

Patch Changes

  • Updated dependencies
    • @backstage/backend-plugin-api@1.4.4

0.6.2-next.0

Patch Changes

  • Updated dependencies
    • @backstage/backend-plugin-api@1.4.4-next.0

0.6.1

Patch Changes

  • Updated dependencies
    • @backstage/types@1.2.2
    • @backstage/backend-plugin-api@1.4.3

0.6.1-next.0

Patch Changes

  • Updated dependencies
    • @backstage/backend-plugin-api@1.4.3-next.0

0.6.0

Minor Changes

  • c08cbc4: Move Scaffolder API to OpenAPI

Patch Changes

  • 3760352: Update express-openapi-validator to 5.5.8 to fix security vulnerability in transitive dependency multer
  • Updated dependencies
    • @backstage/backend-plugin-api@1.4.2

0.6.0-next.1

Patch Changes

  • 3760352: Update express-openapi-validator to 5.5.8 to fix security vulnerability in transitive dependency multer

0.6.0-next.0

Minor Changes

  • c08cbc4: Move Scaffolder API to OpenAPI

Patch Changes

  • Updated dependencies
    • @backstage/backend-plugin-api@1.4.2-next.0
    • @backstage/errors@1.2.7
    • @backstage/types@1.2.1

0.5.5

Patch Changes

  • Updated dependencies
    • @backstage/backend-plugin-api@1.4.1

0.5.5-next.0

Patch Changes

  • Updated dependencies
    • @backstage/backend-plugin-api@1.4.1-next.0

0.5.4

Patch Changes

  • Updated dependencies
    • @backstage/backend-plugin-api@1.4.0
    • @backstage/errors@1.2.7
    • @backstage/types@1.2.1

0.5.4-next.1

Patch Changes

  • Updated dependencies
    • @backstage/backend-plugin-api@1.4.0-next.1
    • @backstage/errors@1.2.7
    • @backstage/types@1.2.1

0.5.4-next.0

Patch Changes

  • Updated dependencies
    • @backstage/backend-plugin-api@1.4.0-next.0

0.5.3

Patch Changes

  • Updated dependencies
    • @backstage/backend-plugin-api@1.3.1
    • @backstage/errors@1.2.7
    • @backstage/types@1.2.1

0.5.3-next.2

Patch Changes

  • Updated dependencies
    • @backstage/backend-plugin-api@1.3.1-next.2
    • @backstage/errors@1.2.7
    • @backstage/types@1.2.1

0.5.3-next.1

Patch Changes

  • Updated dependencies
    • @backstage/backend-plugin-api@1.3.1-next.1
    • @backstage/errors@1.2.7
    • @backstage/types@1.2.1

0.5.3-next.0

Patch Changes

  • Updated dependencies
    • @backstage/backend-plugin-api@1.3.1-next.0
    • @backstage/errors@1.2.7
    • @backstage/types@1.2.1

0.5.2

Patch Changes

  • Updated dependencies
    • @backstage/backend-plugin-api@1.3.0
    • @backstage/errors@1.2.7
    • @backstage/types@1.2.1

0.5.1

Patch Changes

  • Updated dependencies
    • @backstage/backend-plugin-api@1.2.1
    • @backstage/errors@1.2.7
    • @backstage/types@1.2.1

0.5.1-next.1

Patch Changes

  • Updated dependencies
    • @backstage/backend-plugin-api@1.2.1-next.1
    • @backstage/errors@1.2.7
    • @backstage/types@1.2.1

0.5.1-next.0

Patch Changes

  • Updated dependencies
    • @backstage/backend-plugin-api@1.2.1-next.0

0.5.0

Minor Changes

  • 700d32b: 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:

    - import { wrapInOpenApiTestServer } from '@backstage/backend-openapi-utils';
+ import { wrapInOpenApiTestServer } from '@backstage/backend-openapi-utils/testUtils';

    or

    - import { wrapServer } from '@backstage/backend-openapi-utils';
+ import { wrapServer } from '@backstage/backend-openapi-utils/testUtils';

Patch Changes

  • Updated dependencies
    • @backstage/backend-plugin-api@1.2.0
    • @backstage/errors@1.2.7
    • @backstage/types@1.2.1

0.5.0-next.3

Patch Changes

  • Updated dependencies
    • @backstage/backend-plugin-api@1.2.0-next.2
    • @backstage/errors@1.2.7
    • @backstage/types@1.2.1

0.5.0-next.2

Patch Changes

  • Updated dependencies
    • @backstage/backend-plugin-api@1.2.0-next.1
    • @backstage/errors@1.2.7
    • @backstage/types@1.2.1

0.5.0-next.1

Minor Changes

  • 700d32b: 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:

    - import { wrapInOpenApiTestServer } from '@backstage/backend-openapi-utils';
+ import { wrapInOpenApiTestServer } from '@backstage/backend-openapi-utils/testUtils';

    or

    - import { wrapServer } from '@backstage/backend-openapi-utils';
+ import { wrapServer } from '@backstage/backend-openapi-utils/testUtils';

Patch Changes

  • Updated dependencies
    • @backstage/backend-plugin-api@1.2.0-next.0
    • @backstage/errors@1.2.7
    • @backstage/types@1.2.1

0.4.2-next.0

Patch Changes

  • Updated dependencies
    • @backstage/backend-plugin-api@1.2.0-next.0
    • @backstage/errors@1.2.7
    • @backstage/types@1.2.1

0.4.1

Patch Changes

  • Updated dependencies
    • @backstage/types@1.2.1
    • @backstage/backend-plugin-api@1.1.1
    • @backstage/errors@1.2.7

0.4.1-next.1

Patch Changes

  • Updated dependencies
    • @backstage/types@1.2.1-next.0
    • @backstage/backend-plugin-api@1.1.1-next.1
    • @backstage/errors@1.2.7-next.0

0.4.1-next.0

Patch Changes

  • Updated dependencies
    • @backstage/backend-plugin-api@1.1.1-next.0
    • @backstage/errors@1.2.6
    • @backstage/types@1.2.0

0.4.0

Minor Changes

  • afcebea: Fixed a Typescript error when trying to use the new OpenAPI server-side generated code.

Patch Changes

  • Updated dependencies
    • @backstage/backend-plugin-api@1.1.0
    • @backstage/errors@1.2.6
    • @backstage/types@1.2.0

0.4.0-next.2

Minor Changes

  • afcebea: Fixed a Typescript error when trying to use the new OpenAPI server-side generated code.

Patch Changes

  • Updated dependencies
    • @backstage/backend-plugin-api@1.1.0-next.2
    • @backstage/errors@1.2.6-next.0
    • @backstage/types@1.2.0

0.3.1-next.1

Patch Changes

  • Updated dependencies
    • @backstage/backend-plugin-api@1.1.0-next.1
    • @backstage/errors@1.2.5
    • @backstage/types@1.2.0

0.3.1-next.0

Patch Changes

  • Updated dependencies
    • @backstage/backend-plugin-api@1.0.3-next.0
    • @backstage/errors@1.2.5
    • @backstage/types@1.2.0

0.3.0

Minor Changes

  • 1440232: Adds a new createValidatedOpenApiRouterFromGeneratedEndpointMap function that uses the new static server generation in backstage-cli package schema openapi generate --server to create a typed express router.

Patch Changes

  • f01787a: Moves msw from dependencies to devDependencies
  • Updated dependencies
    • @backstage/types@1.2.0
    • @backstage/backend-plugin-api@1.0.2
    • @backstage/errors@1.2.5

0.3.0-next.2

Minor Changes

  • 1440232: Adds a new createValidatedOpenApiRouterFromGeneratedEndpointMap function that uses the new static server generation in backstage-cli package schema openapi generate --server to create a typed express router.

Patch Changes

  • Updated dependencies
    • @backstage/backend-plugin-api@1.0.2-next.2
    • @backstage/errors@1.2.4
    • @backstage/types@1.1.1

0.2.1-next.1

Patch Changes

  • Updated dependencies
    • @backstage/backend-plugin-api@1.0.2-next.1
    • @backstage/errors@1.2.4
    • @backstage/types@1.1.1

0.2.1-next.0

Patch Changes

  • f01787a: Moves msw from dependencies to devDependencies
  • Updated dependencies
    • @backstage/backend-plugin-api@1.0.2-next.0
    • @backstage/errors@1.2.4
    • @backstage/types@1.1.1

0.2.0

Minor Changes

  • 66af016: Improved support for OpenAPI validation during Jest tests. Now, OpenAPI validation can happen as you are writing your Jest tests - you no longer have to run repo schema openapi test.

Patch Changes

  • Updated dependencies
    • @backstage/backend-plugin-api@1.0.1
    • @backstage/errors@1.2.4
    • @backstage/types@1.1.1

0.2.0-next.1

Minor Changes

  • 66af016: Improved support for OpenAPI validation during Jest tests. Now, OpenAPI validation can happen as you are writing your Jest tests - you no longer have to run repo schema openapi test.

Patch Changes

  • Updated dependencies
    • @backstage/backend-plugin-api@1.0.1-next.1
    • @backstage/errors@1.2.4
    • @backstage/types@1.1.1

0.1.19-next.0

Patch Changes

  • Updated dependencies
    • @backstage/backend-plugin-api@1.0.1-next.0
    • @backstage/errors@1.2.4

0.1.18

Patch Changes

  • c2b63ab: Updated dependency supertest to ^7.0.0.
  • Updated dependencies
    • @backstage/backend-plugin-api@1.0.0
    • @backstage/errors@1.2.4

0.1.18-next.2

Patch Changes

  • c2b63ab: Updated dependency supertest to ^7.0.0.
  • Updated dependencies
    • @backstage/backend-plugin-api@1.0.0-next.2
    • @backstage/errors@1.2.4

0.1.18-next.1

Patch Changes

  • Updated dependencies
    • @backstage/backend-plugin-api@0.9.0-next.1
    • @backstage/errors@1.2.4

0.1.18-next.0

Patch Changes

  • Updated dependencies
    • @backstage/backend-plugin-api@0.9.0-next.0
    • @backstage/errors@1.2.4

0.1.16

Patch Changes

  • Updated dependencies
    • @backstage/backend-plugin-api@0.8.0
    • @backstage/errors@1.2.4

0.1.16-next.3

Patch Changes

  • Updated dependencies
    • @backstage/backend-plugin-api@0.8.0-next.3
    • @backstage/errors@1.2.4

0.1.16-next.2

Patch Changes

  • Updated dependencies
    • @backstage/backend-plugin-api@0.8.0-next.2
    • @backstage/errors@1.2.4

0.1.16-next.1

Patch Changes

  • Updated dependencies
    • @backstage/backend-plugin-api@0.7.1-next.1
    • @backstage/errors@1.2.4

0.1.16-next.0

Patch Changes

  • Updated dependencies
    • @backstage/backend-plugin-api@0.7.1-next.0
    • @backstage/errors@1.2.4

0.1.15

Patch Changes

  • Updated dependencies
    • @backstage/backend-plugin-api@0.7.0
    • @backstage/errors@1.2.4

0.1.15-next.1

Patch Changes

  • Updated dependencies
    • @backstage/backend-plugin-api@0.6.22-next.1
    • @backstage/errors@1.2.4

0.1.14-next.0

Patch Changes

  • Updated dependencies
    • @backstage/backend-plugin-api@0.6.21-next.0
    • @backstage/errors@1.2.4

0.1.12

Patch Changes

  • Updated dependencies
    • @backstage/backend-plugin-api@0.6.19
    • @backstage/errors@1.2.4

0.1.12-next.2

Patch Changes

  • Updated dependencies
    • @backstage/backend-plugin-api@0.6.19-next.3
    • @backstage/errors@1.2.4

0.1.12-next.1

Patch Changes

  • Updated dependencies
    • @backstage/backend-plugin-api@0.6.19-next.2
    • @backstage/errors@1.2.4

0.1.12-next.0

Patch Changes

  • Updated dependencies
    • @backstage/backend-plugin-api@0.6.19-next.0
    • @backstage/errors@1.2.4

0.1.11

Patch Changes

  • Updated dependencies
    • @backstage/backend-plugin-api@0.6.18

0.1.11-next.1

Patch Changes

  • Updated dependencies
    • @backstage/backend-plugin-api@0.6.18-next.1

0.1.11-next.0

Patch Changes

  • Updated dependencies
    • @backstage/backend-plugin-api@0.6.18-next.0
    • @backstage/errors@1.2.4

0.1.10

Patch Changes

  • Updated dependencies
    • @backstage/backend-plugin-api@0.6.17
    • @backstage/errors@1.2.4

0.1.10-next.1

Patch Changes

  • Updated dependencies
    • @backstage/backend-plugin-api@0.6.17-next.1
    • @backstage/errors@1.2.4

0.1.10-next.0

Patch Changes

  • Updated dependencies
    • @backstage/backend-plugin-api@0.6.17-next.0
    • @backstage/errors@1.2.4

0.1.9

Patch Changes

  • Updated dependencies
    • @backstage/backend-plugin-api@0.6.16
    • @backstage/errors@1.2.4

0.1.8

Patch Changes

  • Updated dependencies
    • @backstage/backend-plugin-api@0.6.15
    • @backstage/errors@1.2.4

0.1.7

Patch Changes

  • 85ec23e: Updated dependency json-schema-to-ts to ^3.0.0.
  • Updated dependencies
    • @backstage/errors@1.2.4
    • @backstage/backend-plugin-api@0.6.14

0.1.7-next.2

Patch Changes

  • Updated dependencies
    • @backstage/backend-plugin-api@0.6.14-next.2
    • @backstage/errors@1.2.4-next.0

0.1.7-next.1

Patch Changes

  • Updated dependencies
    • @backstage/backend-plugin-api@0.6.14-next.1
    • @backstage/errors@1.2.4-next.0

0.1.6-next.0

Patch Changes

  • 85ec23e: Updated dependency json-schema-to-ts to ^3.0.0.
  • Updated dependencies
    • @backstage/errors@1.2.4-next.0
    • @backstage/backend-plugin-api@0.6.13-next.0

0.1.3

Patch Changes

  • 2067689: Internal updates due to json-schema-to-ts
  • Updated dependencies
    • @backstage/backend-plugin-api@0.6.10
    • @backstage/errors@1.2.3

0.1.3-next.3

Patch Changes

  • Updated dependencies
    • @backstage/backend-plugin-api@0.6.10-next.3
    • @backstage/errors@1.2.3

0.1.3-next.2

Patch Changes

  • Updated dependencies
    • @backstage/backend-plugin-api@0.6.10-next.2
    • @backstage/errors@1.2.3

0.1.3-next.1

Patch Changes

  • Updated dependencies
    • @backstage/backend-plugin-api@0.6.10-next.1
    • @backstage/errors@1.2.3

0.1.3-next.0

Patch Changes

  • 2067689: Internal updates due to json-schema-to-ts
  • Updated dependencies
    • @backstage/backend-plugin-api@0.6.10-next.0
    • @backstage/errors@1.2.3

0.1.2

Patch Changes

  • 4016f21: Remove some unused dependencies
  • Updated dependencies
    • @backstage/backend-plugin-api@0.6.9
    • @backstage/errors@1.2.3

0.1.2-next.2

Patch Changes

  • Updated dependencies
    • @backstage/backend-plugin-api@0.6.9-next.2

0.1.2-next.1

Patch Changes

  • Updated dependencies
    • @backstage/backend-plugin-api@0.6.9-next.1
    • @backstage/errors@1.2.3

0.1.2-next.0

Patch Changes

  • 4016f21: Remove some unused dependencies
  • Updated dependencies
    • @backstage/backend-plugin-api@0.6.9-next.0
    • @backstage/errors@1.2.3

0.1.1

Patch Changes

  • aaa6fb3: Minor updates for TypeScript 5.2.2+ compatibility
  • Updated dependencies
    • @backstage/backend-plugin-api@0.6.8
    • @backstage/config@1.1.1
    • @backstage/errors@1.2.3

0.1.1-next.3

Patch Changes

  • Updated dependencies
    • @backstage/backend-plugin-api@0.6.8-next.3
    • @backstage/config@1.1.1
    • @backstage/errors@1.2.3

0.1.1-next.2

Patch Changes

  • Updated dependencies
    • @backstage/backend-plugin-api@0.6.8-next.2
    • @backstage/config@1.1.1
    • @backstage/errors@1.2.3

0.1.1-next.1

Patch Changes

  • Updated dependencies
    • @backstage/backend-plugin-api@0.6.8-next.1
    • @backstage/config@1.1.1
    • @backstage/errors@1.2.3

0.1.1-next.0

Patch Changes

  • aaa6fb3bc9: Minor updates for TypeScript 5.2.2+ compatibility
  • Updated dependencies
    • @backstage/backend-plugin-api@0.6.8-next.0
    • @backstage/config@1.1.1
    • @backstage/errors@1.2.3

0.1.0

Minor Changes

  • 785fb1ea75: Adds a new route, /openapi.json to validated routers for displaying their full OpenAPI spec in a standard endpoint.

Patch Changes

  • 6694b369a3: Adds a new function wrapInOpenApiTestServer that allows for proxied requests at runtime. This will support the new yarn backstage-repo-tools schema openapi test command.
  • Updated dependencies
    • @backstage/backend-plugin-api@0.6.7
    • @backstage/config@1.1.1
    • @backstage/errors@1.2.3

0.1.0-next.2

Patch Changes

  • Updated dependencies
    • @backstage/backend-plugin-api@0.6.7-next.2

0.1.0-next.1

Patch Changes

  • Updated dependencies
    • @backstage/backend-plugin-api@0.6.7-next.1
    • @backstage/config@1.1.1
    • @backstage/errors@1.2.3

0.1.0-next.0

Minor Changes

  • 785fb1ea75: Adds a new route, /openapi.json to validated routers for displaying their full OpenAPI spec in a standard endpoint.

Patch Changes

  • 6694b369a3: Adds a new function wrapInOpenApiTestServer that allows for proxied requests at runtime. This will support the new yarn backstage-repo-tools schema openapi test command.
  • Updated dependencies
    • @backstage/backend-plugin-api@0.6.7-next.0
    • @backstage/config@1.1.1
    • @backstage/errors@1.2.3

0.0.5

Patch Changes

  • 7c83975531: Adds new public utility types for common OpenAPI values, like request and response shapes and parameters available on an endpoint.

    deprecated internal namespace The internal namespace will continue to be exported but now uses OpenAPI format for path parameters. You should use the new utility types.

  • Updated dependencies

    • @backstage/errors@1.2.3

0.0.5-next.0

Patch Changes

  • 7c83975531: Adds new public utility types for common OpenAPI values, like request and response shapes and parameters available on an endpoint.

    deprecated internal namespace The internal namespace will continue to be exported but now uses OpenAPI format for path parameters. You should use the new utility types.

  • Updated dependencies

    • @backstage/errors@1.2.3-next.0

0.0.4

Patch Changes

  • Updated dependencies
    • @backstage/errors@1.2.2

0.0.4-next.0

Patch Changes

  • Updated dependencies
    • @backstage/errors@1.2.2-next.0

0.0.3

Patch Changes

  • ebeb775869: Add a new createRouter method for generating an express router that validates against your spec. Also fixes a bug with the query parameters type resolution.
  • 12a8c94eda: Add package repository and homepage metadata
  • Updated dependencies
    • @backstage/errors@1.2.1

0.0.3-next.1

Patch Changes

  • 12a8c94eda: Add package repository and homepage metadata
  • Updated dependencies
    • @backstage/errors@1.2.1

0.0.3-next.0

Patch Changes

  • ebeb775869: Add a new createRouter method for generating an express router that validates against your spec. Also fixes a bug with the query parameters type resolution.
  • Updated dependencies
    • @backstage/errors@1.2.1

0.0.2

Patch Changes

  • fe16bd39e8: Use permalinks for links including a line number reference
  • 27956d7867: Adjusted README accordingly after the generated output now has a .generated.ts extension
  • 021cfbb515: Corrected resolution of parameter nested schema to use central schemas.
  • 799c33047e: Updated README to reflect changes in @backstage/repo-tools.

0.0.2-next.1

Patch Changes

  • fe16bd39e8: Use permalinks for links including a line number reference
  • 021cfbb515: Corrected resolution of parameter nested schema to use central schemas.

0.0.2-next.0

Patch Changes

  • 27956d7867: Adjusted README accordingly after the generated output now has a .generated.ts extension

0.0.1

Patch Changes

  • 62fe726fdc: New plugin! Primary focus is to support types on Routers in backend packages. Developers can use the ApiRouter from this package in their packages to support a typed experience based on their OpenAPI specs. The ApiRouter supports request bodies, response bodies, query parameters and path parameters, as well as full path-based context of the above. This means no more guessing on an endpoint like req.post('/not-my-route', (req, res)=>{res.send(req.body.badparam)}). Typescript would catch /not-my-route, req.body.badparam, res.send(req.body.badparam).

0.0.1-next.0

Patch Changes

  • 62fe726fdc: New plugin! Primary focus is to support types on Routers in backend packages. Developers can use the ApiRouter from this package in their packages to support a typed experience based on their OpenAPI specs. The ApiRouter supports request bodies, response bodies, query parameters and path parameters, as well as full path-based context of the above. This means no more guessing on an endpoint like req.post('/not-my-route', (req, res)=>{res.send(req.body.badparam)}). Typescript would catch /not-my-route, req.body.badparam, res.send(req.body.badparam).
Reference in New Issue View Git Blame Copy Permalink