v1.6.0
·
32 commits
to develop
since this release
Immutable
release. Only release title and notes can be modified.
What's Changed
This release simplifies the OpenAPI schema by removing the non-standard invalid-params extension member and vendor-specific, aligning the documentation with RFC 9457. It also introduces a new helper for registering a named ProblemDetails model in Swagger UI and adds formatting checks to CI.
Features
-
addProblemDetailsSchemahelper — registers the canonicalProblemDetailsschema undercomponents.schemas.ProblemDetailsin an OpenAPI document, making it visible as a named model in Swagger UI:import { addProblemDetailsSchema } from 'nest-problem-details-filter/swagger'; const document = SwaggerModule.createDocument(app, builder); addProblemDetailsSchema(document);
This replaces the manual pattern of mutating
document.components.schemasand is now documented inREADME.md,docs/usage.md, anddocs/openapi.md.
Changes
- Schema cleanup — removed the
invalid-paramsextension member fromPROBLEM_DETAILS_SCHEMAand all documentation. This field appeared only in an RFC 7807 example and was not standardized in RFC 9457. The library never emitted it, and the schema now documents only thecodeanderrorsextension members (errorsis accepted but not emitted by default). - Documentation consistency — fixed contradictions in
docs/openapi.mdwhere the notes incorrectly stated the library emitserrors. All references now consistently state thaterrorsis accepted by the schema but not emitted by default. - CI formatting check — added
npm run format:checkto bothmain.ymlandrelease.ymlpipelines. Theformatscript was also extended to cover bothsrcandtestsdirectories for consistency with thelintscript.
Full Changelog: v1.5.0...v1.6.0