Skip to content

Release v2.2.4 - #25

Merged
kodjunkie merged 3 commits into
masterfrom
release/v2.2.4
Jun 10, 2026
Merged

Release v2.2.4#25
kodjunkie merged 3 commits into
masterfrom
release/v2.2.4

Conversation

@kodjunkie

Copy link
Copy Markdown
Owner

Patch release — cleans up the generated OpenAPI/Swagger descriptions so they read for your API consumers instead of exposing library internals, and brings the Prisma adapter to logging parity with the other three adapters.

Changed

  • Generated OpenAPI descriptions no longer reference library internals (@Crud(...) config or CrudValidationGroups) — operation and parameter descriptions are now written for API consumers and describe query syntax inline (field||$operator||value).
  • The per-parameter "Docs" HTML anchors are consolidated into a single CommonMark "Query Syntax" reference link on the list / get-one operations (renders in swagger-ui, Redoc, and other OpenAPI tooling). Endpoints without a query surface carry no link.

Added

  • @nestjs-crud/prisma now emits the same debug-level CrudService initialized: <model> constructor log as the TypeORM, Drizzle, and MikroORM adapters (visible only when debug logging is enabled) — closes a logging-parity gap.

Removed

  • Internal Swagger.docsLink helper removed — superseded by the self-contained parameter descriptions above.

TypeORM, Drizzle, and MikroORM services log 'CrudService initialized:'
at construction; the Prisma adapter was silent. Same debug-level line
now emitted with the model name.
Operation descriptions referenced library internals — @crud({ query:
{ softDelete: true } }) and CrudValidationGroups — which mean nothing
to API consumers reading the generated docs and leak the backend's
library stack. Behavior is now described in consumer terms.

Per-parameter 'Docs' HTML anchors are consolidated into a single
CommonMark 'Query Syntax' reference link on the getMany/getOne
operation descriptions (the only routes with a query surface);
query-parameter descriptions describe their syntax inline. The
internal Swagger.docsLink helper is removed.
@kodjunkie
kodjunkie merged commit a850b3f into master Jun 10, 2026
12 checks passed
@github-actions

Copy link
Copy Markdown

Packages with version v2.2.4 have been released

@kodjunkie
kodjunkie deleted the release/v2.2.4 branch June 10, 2026 22:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant