Skip to content

docs(examples): use semantic project identifiers - #1083

Open
seonghobae wants to merge 3 commits into
developfrom
fix/example-project-semantic-identifiers
Open

docs(examples): use semantic project identifiers#1083
seonghobae wants to merge 3 commits into
developfrom
fix/example-project-semantic-identifiers

Conversation

@seonghobae

@seonghobae seonghobae commented Sep 2, 2026

Copy link
Copy Markdown
Contributor

Naming repair

Align the paired vulnerable/fixed project examples with the organization naming contract without changing the security lesson.

  • rename the organization-owned dynamic route parameter from id to projectId;
  • rename the organization-owned example database columns id, name, and data to project_id, project_name, and project_payload_json;
  • translate Supabase result keys at the adapter boundary to projectRecord and projectQueryError while preserving vendor-owned data/error keys;
  • preserve the externally owned Supabase auth reference auth.users(id) exactly;
  • keep user_id unchanged because it is already a meaningful multiword identifier.

Test-first evidence

RED commit 05100f7f1cdec52d7da24c7620f290843bdb7404 adds a focused static contract that fails against the prior example docs. The following two commits update the vulnerable and fixed examples together so the contract, query example, route parameter, and example DDL agree.

This changes documentation examples only: no persisted production database, migration, foreign key, index, UPSERT path, locking behavior, or runtime API is modified.


Devin Review

@coderabbitai

coderabbitai Bot commented Sep 2, 2026

Copy link
Copy Markdown

Warning

Review limit reached

Next included review available in 46 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used the included review currently available.

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Learn how review limits work.

Review configuration:

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Team

Run ID: ab9d3141-2ec1-4110-91ef-3a44a23f848a

📥 Commits

Reviewing files that changed from the base of the PR and between e71d37e and 84176a1.

📒 Files selected for processing (3)
  • examples/fixed-vibe-app/README.md
  • examples/vulnerable-vibe-app/README.md
  • tests/test_example_schema_naming_contract.py

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.

@devin-ai-integration devin-ai-integration Bot 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.

✅ Devin Review: No Issues Found

Devin Review analyzed this PR and found no bugs or issues to report.

Devin Review

@seonghobae seonghobae added documentation Improvements or additions to documentation priority: medium Normal-priority or P2 work status: needs-review Open pull request requiring current-head review or checks type: docs Documentation, ADR, PRD, or technical writing labels Sep 2, 2026 — with ChatGPT Codex Connector
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation priority: medium Normal-priority or P2 work status: needs-review Open pull request requiring current-head review or checks type: docs Documentation, ADR, PRD, or technical writing

Projects

Status: Backlog

Development

Successfully merging this pull request may close these issues.

1 participant