docs: Document jest-e2e.ts

[akamabu]

Documents apps/api/v2/jest-e2e.ts module purpose and public usage context

[github-actions]

Hey there and thank you for opening this pull request! 👋🏼

We require pull request titles to follow the Conventional Commits specification and it looks like your proposed title needs to be adjusted.

Details:

Unknown release type "Docs" found in pull request title "Docs: Document jest-e2e.ts". 

Available types:
 - feat: A new feature
 - fix: A bug fix
 - docs: Documentation only changes
 - style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
 - refactor: A code change that neither fixes a bug nor adds a feature
 - perf: A code change that improves performance
 - test: Adding missing tests or correcting existing tests
 - build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
 - ci: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
 - chore: Other changes that don't modify src or test files
 - revert: Reverts a previous commit

[github-actions]

Welcome to Cal.diy, @akamabu! Thanks for opening this pull request.

A few things to keep in mind:

• This is Cal.diy, not Cal.com. Cal.diy is a community-driven, fully open-source fork of Cal.com licensed under MIT. Your changes here will be part of Cal.diy — they will not be deployed to the Cal.com production app.
• Please review our Contributing Guidelines if you haven't already.
• Make sure your PR title follows the Conventional Commits format.

A maintainer will review your PR soon. Thanks for contributing!

[coderabbitai]

📝 Walkthrough

Walkthrough

This pull request adds a single module-purpose comment at the top of apps/api/v2/jest-e2e.ts. The comment documents the module's purpose and public usage context. No runtime logic, Jest configuration values, or exported declarations were modified.

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description check	✅ Passed	The description clearly relates to the changeset, explaining that documentation for the jest-e2e.ts module's purpose and usage context has been added.
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.
Title check	✅ Passed	The title 'docs: Document jest-e2e.ts' directly and accurately reflects the main change: adding documentation/comments to the jest-e2e.ts file.

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

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

---

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 and usage tips.}

[coderabbitai]

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@apps/api/v2/jest-e2e.ts`:
- Line 1: Replace the top-of-file comment in apps/api/v2/jest-e2e.ts so it
explains the rationale for this Jest e2e config instead of restating the
filename; remove PR/metadata-style phrasing and instead describe why this custom
e2e setup exists (e.g., targets integration tests against v2 API, isolates env,
specific presets or setup steps) and when/how to use it (when running end-to-end
tests locally/CI and any important caveats), leaving any implementation details
to the code itself.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: e64278ea-b8b8-4f25-a2ae-544488def44b

📥 Commits

Reviewing files that changed from the base of the PR and between fb01494 and 088fc59.

📒 Files selected for processing (1)

• apps/api/v2/jest-e2e.ts

[coderabbitai]

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Make the module comment explain rationale, not change description.

This reads like PR metadata and restates what the file is, rather than why this config exists or when to use it. Prefer a rationale-focused module comment.

Suggested rewrite

-/** Documents apps/api/v2/jest-e2e.ts module purpose and public usage context */
+/** Central Jest E2E config for API v2, tuned for CI shard stability where tests share DB state. */

As per coding guidelines, "Only add code comments that explain why, not what" and "Never add comments that simply restate what the code does."

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

	/** Documents apps/api/v2/jest-e2e.ts module purpose and public usage context */
	/** Central Jest E2E config for API v2, tuned for CI shard stability where tests share DB state. */

🤖 Prompt for AI Agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@apps/api/v2/jest-e2e.ts` at line 1, Replace the top-of-file comment in
apps/api/v2/jest-e2e.ts so it explains the rationale for this Jest e2e config
instead of restating the filename; remove PR/metadata-style phrasing and instead
describe why this custom e2e setup exists (e.g., targets integration tests
against v2 API, isolates env, specific presets or setup steps) and when/how to
use it (when running end-to-end tests locally/CI and any important caveats),
leaving any implementation details to the code itself.