Skip to content

docs: clarify path parameter runtime validation - #34

Merged
smiggleworth merged 1 commit into
mainfrom
docs/path-parameter-runtime-validation
Aug 24, 2026
Merged

docs: clarify path parameter runtime validation#34
smiggleworth merged 1 commit into
mainfrom
docs/path-parameter-runtime-validation

Conversation

@smiggleworth

Copy link
Copy Markdown
Contributor

Closes #25.

Summary

  • clarify that .params<T>() generics are compile-time-only
  • document that runtime validation and coercion require per-parameter validators
  • distinguish auto-derived name checks from value validation
  • carry the same contract into generated API documentation

Validation

  • npm run check

No runtime, package version, or publishing changes.

@smiggleworth
smiggleworth marked this pull request as ready for review August 24, 2026 10:33
Copilot AI lite review requested due to automatic review settings August 24, 2026 10:33

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@smiggleworth
smiggleworth merged commit 1e5fe1a into main Aug 24, 2026
3 checks passed
@smiggleworth
smiggleworth deleted the docs/path-parameter-runtime-validation branch August 24, 2026 10:34
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.

Path parameter runtime validation depends on whether .params() was explicitly called, undocumented

2 participants