docs(car-sharing): refresh stale 1.1.0 forward-references (now released)

[intech]

1.1.0 is published, so the "once 1.1.0 is out" forward-references in car-sharing no longer read true. This example still pins @connectum/auth ^1.0.0 (which resolves to 1.0.0) and keeps the public workaround, so the notes are reworded to present tense and the internal-marker migration is pointed at the tracking issue.

• README: the OpenAPI overlay note now states 1.1.0 adds the internal marker and links the migration to Examples: 1.1.0 follow-up — broadcast demos, new-feature showcases, deferred items #36 (instead of "once 1.1.0 is out").
• scripts/openapi-authz.ts: the two internal-marker comments become present-tense (this example targets the 1.0.0 API; on 1.1.0 a method marked internal would add x-internal: true).

Prose/comments only — no behavior change. The "resolves to the 1.0.0 versions" statement is left intact (it is correct: ^1.0.0 resolves to 1.0.0).

Part of #36.

Summary by CodeRabbit

• Documentation
  • Clarified OpenAPI guidance for @connectum/auth so the notes now distinguish between v1.0.0 and v1.1.0 behavior.
  • Added clearer mention of the new internal method marker and its OpenAPI representation.
  • Updated the example reference to point to the current migration/tracking item.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 06289f53-c5db-4292-b388-75abc5556a9e

📥 Commits

Reviewing files that changed from the base of the PR and between 881c989 and f1a92eb.

📒 Files selected for processing (2)

• car-sharing/README.md
• car-sharing/scripts/openapi-authz.ts

---

📝 Walkthrough

Walkthrough

Updated the car-sharing OpenAPI notes and authz script comments to describe the @connectum/auth v1.0.0 overlay target, the v1.1.0 internal marker mapping, and the migration reference.

Changes

OpenAPI auth notes updates

Layer / File(s)	Summary
OpenAPI notes and comments car-sharing/scripts/openapi-authz.ts, car-sharing/README.md	Script comments and README notes now describe the @connectum/auth v1.0.0 overlay target and the v1.1.0 internal → x-internal: true mapping; the README note also links to examples#36.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

• Connectum-Framework/examples#34: Introduced the overlay/authz generation behavior that these notes now describe.

Suggested labels

type:docs

Poem

A bunny hopped by with a doc-page grin,
“Now internal markers tell where secrets begin.”
v1.1.0 twinkled, v1.0.0 stayed true,
And carrots of clarity bloomed in the view.

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately summarizes the doc-only update to refresh stale 1.1.0 forward references in car-sharing.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

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

✨ Finishing Touches

📝 Generate docstrings

• Create stacked PR
• Commit on current branch

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch chore/car-sharing-1.1.0-currency

---

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

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}