Skip to content

Add openapi body validation openspec change#1707

Merged
notaphplover merged 3 commits intomainfrom
docs/add-openapi-body-validation-openspec-change
Apr 4, 2026
Merged

Add openapi body validation openspec change#1707
notaphplover merged 3 commits intomainfrom
docs/add-openapi-body-validation-openspec-change

Conversation

@notaphplover
Copy link
Copy Markdown
Member

@notaphplover notaphplover commented Mar 27, 2026

Added

  • Added OpenApi body validation openspec change.

Context

See #1701

Summary by CodeRabbit

  • Documentation
    • Added design and specification documents for planned OpenAPI request body validation feature, including a new @Validate() decorator and OpenApiValidationPipe implementations for OpenAPI v3.1 and v3.2 support.

@notaphplover notaphplover self-assigned this Mar 27, 2026
@changeset-bot
Copy link
Copy Markdown

changeset-bot bot commented Mar 27, 2026

⚠️ No Changeset found

Latest commit: 82b5bc7

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Mar 27, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: bee165c3-3237-483d-9849-b500fee7f74a

📥 Commits

Reviewing files that changed from the base of the PR and between 985f075 and 82b5bc7.

📒 Files selected for processing (5)
  • openspec/changes/add-openapi-body-validation/.openspec.yaml
  • openspec/changes/add-openapi-body-validation/design.md
  • openspec/changes/add-openapi-body-validation/proposal.md
  • openspec/changes/add-openapi-body-validation/specs/openapi-body-validation/spec.md
  • openspec/changes/add-openapi-body-validation/tasks.md

📝 Walkthrough

Walkthrough

This PR establishes design, proposal, specification, and implementation task documentation for an OpenAPI-driven request-body validation feature spanning multiple packages (@inversifyjs/http-core, @inversifyjs/http-open-api, and a new @inversifyjs/http-openapi-validation) with support for OpenAPI v3.1 and v3.2.

Changes

Cohort / File(s) Summary
Specification & Documentation
openspec/changes/add-openapi-body-validation/.openspec.yaml, openspec/changes/add-openapi-body-validation/design.md, openspec/changes/add-openapi-body-validation/proposal.md, openspec/changes/add-openapi-body-validation/specs/openapi-body-validation/spec.md, openspec/changes/add-openapi-body-validation/tasks.md
Adds comprehensive specification documents including metadata, design rationale, API contract proposals, functional requirements, and implementation tasks for OpenAPI body validation feature. Defines required exports from existing packages, new @Validate() decorator, and version-specific OpenApiValidationPipe implementations.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related PRs

  • Extract OpenApi abstractions #1715: Implements the public openApiObject getter and related type changes for SwaggerUiProvider that are required by this feature's proposal.
  • Add 3.2 Swagger UI provider #1728: Introduces v3.2 SwaggerUiProvider implementation and v3.2 metadata exports that directly support the multi-version design outlined here.

Suggested reviewers

  • adrianmjim

Poem

🐰 Hops excitedly
Specifications drafted with care,
OpenAPI's body now validated with flair!
Version three-point-one and two align,
A decorator and pipe work in design—
Tasks mapped out, ready to build! 🎯

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'Add openapi body validation openspec change' directly and clearly describes the main change in the pull request, which adds documentation for an OpenAPI body validation feature as an openspec change.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/add-openapi-body-validation-openspec-change

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@notaphplover notaphplover marked this pull request as ready for review April 4, 2026 11:10
@notaphplover notaphplover merged commit ca6ede9 into main Apr 4, 2026
8 checks passed
@notaphplover notaphplover deleted the docs/add-openapi-body-validation-openspec-change branch April 4, 2026 11:43
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