Skip to content

docs(examples): align READMEs with 1.0.0; fix car-sharing chain order#25

Merged
intech merged 1 commit into
mainfrom
docs/audit-fixes-1.0.0
Jun 20, 2026
Merged

docs(examples): align READMEs with 1.0.0; fix car-sharing chain order#25
intech merged 1 commit into
mainfrom
docs/audit-fixes-1.0.0

Conversation

@intech

@intech intech commented Jun 20, 2026

Copy link
Copy Markdown
Contributor

Summary

Example READMEs aligned with the published 1.0.0 surface, plus one verified code
fix in the car-sharing flagship.

car-sharing interceptor order (ADR-024)

The gateway chain placed authentication after validation/observability. It now
follows ADR-024 — errorHandler → JWT auth → proto authz → OTel → validation
so unauthenticated requests are rejected before validation, and OTel runs after
authz so getAuthContext() is populated for enduser.* span attributes.
Verified: tsc --noEmit clean, e2e 7/7 pass.

The car-sharing Dockerfile now builds without a committed lockfile (pnpm install resolves @connectum/* to the published 1.0.0 versions), matching the
example's no-committed-lockfile policy.

README fixes

  • extensions/redact: the illustrative proto block is marked as hand-rolled
    stubs (no connectum/options.proto exists).
  • getting-started: Node floor consistency (>=25.2.0 for run-directly TS).
  • with-events-dlq: DLQ metadata description and the errorSerializer note.
  • Missing dependencies in extensions/redact and interceptors/jwt; hris
    layout; with-custom-interceptor doc comment (fixed-window).

Part of a coordinated 1.0.0 documentation pass with companion PRs in the
framework and docs repositories.

🤖 Generated with Claude Code

https://claude.ai/code/session_01MdeH7fExPmiRHRirGuvGk3

- car-sharing: interceptor order to ADR-024 (auth immediately after
  errorHandler, before validation; OTel after authz for enduser span
  attributes) -- e2e 7/7, typecheck clean
- car-sharing Dockerfile builds without a committed lockfile (pnpm install
  resolves @connectum/* to published 1.0.0)
- README fixes: extensions/redact proto note, getting-started Node floor,
  with-events-dlq metadata, missing deps; rateLimit comment (fixed-window)

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01MdeH7fExPmiRHRirGuvGk3
@coderabbitai

coderabbitai Bot commented Jun 20, 2026

Copy link
Copy Markdown

Warning

Review limit reached

@intech, we couldn't start this review because you've reached your PR review rate limit.

More reviews will be available in 59 minutes and 59 seconds. Learn how PR review limits work.

Your organization has used up its prepaid credits, and credit purchases are no longer available. Enable the review add-on in the billing tab to keep reviews running — you're only billed for reviews past your plan's rate limits ($0.25/file).

⌛ How to resolve this issue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based credits.

🚦 How do rate limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan refill rate.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, the refill rate gradually slows as usage increases. The highest same-day bursts are limited more strictly.

Please see our Fair Usage Limits Policy for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: b218fd4c-7043-4ebf-b41a-8fe015a6c7eb

📥 Commits

Reviewing files that changed from the base of the PR and between b91013b and 4edf624.

📒 Files selected for processing (13)
  • car-sharing/Dockerfile
  • car-sharing/README.md
  • car-sharing/src/server.ts
  • extensions/redact/README.md
  • getting-started/README.md
  • hris/README.md
  • interceptors/jwt/README.md
  • o11y-coroot/README.md
  • performance-test-server/README.md
  • with-custom-interceptor/src/interceptors/rateLimitInterceptor.ts
  • with-events-amqp/README.md
  • with-events-dlq/README.md
  • with-events-redpanda/README.md
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/audit-fixes-1.0.0

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.

@github-actions github-actions Bot added the type:docs Documentation: guides, README, JSDoc label Jun 20, 2026
@intech

intech commented Jun 20, 2026

Copy link
Copy Markdown
Contributor Author

@coderabbitai review

@coderabbitai

coderabbitai Bot commented Jun 20, 2026

Copy link
Copy Markdown
✅ Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@intech intech merged commit e306f50 into main Jun 20, 2026
7 checks passed
@intech intech deleted the docs/audit-fixes-1.0.0 branch June 20, 2026 12:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

type:docs Documentation: guides, README, JSDoc

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant