docs: add deployment API docs

[isshaddad]

Adds documentation for deployment management APIs (promote, retrieve, get-latest)

---

[changeset-bot]

⚠️ No Changeset found

Latest commit: a2c0f3b

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[coderabbitai]

Walkthrough

The PR adds API documentation for a Deployments API with three new endpoints. It introduces a new documentation group in the navigation structure pointing to three new MDX documentation files. The OpenAPI specification is extended with three new endpoints under the /api/v1/deployments path: one to retrieve a specific deployment by ID, one to retrieve the latest deployment, and one to promote a deployment version. Each endpoint includes responses, security configurations, and code samples in TypeScript and curl.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Description check	⚠️ Warning	The description is minimal and lacks most required template sections including checklist, testing details, and changelog information.	Complete the PR description by filling in the checklist items, testing steps, and changelog section as specified in the repository's template.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Title check	✅ Passed	The title 'docs: add deployment API docs' clearly and concisely summarizes the main change—adding documentation for deployment APIs.

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

✨ Finishing touches

• 📝 Generate docstrings

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch docs/promote-deployment

Important

Action Needed: IP Allowlist Update

If your organization protects your Git platform with IP whitelisting, please add the new CodeRabbit IP address to your allowlist:

• ✨ 136.113.208.247/32 (new)
• 34.170.211.100/32
• 35.222.179.152/32

Reviews will stop working after February 8, 2026 if the new IP is not added to your allowlist.

---

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.}

[devin-ai-integration]

Devin Review found 2 potential issues.

View issues and 3 additional flags in Devin Review.

[vibe-kanban-cloud]

Review Complete

Your review story is ready!

View Story

Comment !reviewfast on this PR to re-generate the story.

[ericallam]

@isshaddad can this PR be closed since the other one was merged?