feat: adding document on how to down the openapi spec

[sriramveeraghanta]

Summary by CodeRabbit

• Documentation
  • Added new documentation page for accessing the OpenAPI 3.0 specification of the Plane public REST API
  • Documentation covers enabling the OpenAPI feature, accessing runtime endpoints, and downloading specifications in YAML or JSON formats
  • Added navigation entry in the dev tools section

Summary by CodeRabbit

• Documentation
  • Added guide for accessing the OpenAPI 3.0 specification for the public REST API.
  • Includes instructions for enabling the feature and using both runtime endpoints and offline generation methods.

[vercel]

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Actions	Updated (UTC)
developer-docs	Ready	Preview, Comment	Mar 20, 2026 11:52am

[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: 3bd47efa-d19d-4362-a91b-9aca8e5d63f3

📥 Commits

Reviewing files that changed from the base of the PR and between f01e37c and e5e9648.

📒 Files selected for processing (1)

• docs/dev-tools/openapi-specification.md

✅ Files skipped from review due to trivial changes (1)

• docs/dev-tools/openapi-specification.md

---

📝 Walkthrough

Walkthrough

Adds a new sidebar entry and a documentation page explaining how to enable and access the Plane REST API OpenAPI 3.0 specification (drf-spectacular), including runtime endpoints and an offline generation workflow.

Changes

Cohort / File(s)	Summary
Docs config docs/.vitepress/config.mts	Added "/dev-tools/" sidebar entry: { text: "OpenAPI Specification", link: "/dev-tools/openapi-specification" }.
OpenAPI docs page docs/dev-tools/openapi-specification.md	New page documenting how to enable drf-spectacular via ENABLE_DRF_SPECTACULAR=1, runtime endpoints (/api/schema/, /api/schema/swagger-ui/, /api/schema/redoc/), download formats (format=openapi-json), and offline generation with python manage.py spectacular --file.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐇 I hopped through docs to leave a trace,
A spec appears in its tidy place,
Swagger, ReDoc, YAML to behold,
drf-spectacular stories told,
Hooray — the API map is bold!

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title contains a typo ('down' instead of 'download') and is vague about the specific content, but it is clearly related to the main changeset of adding OpenAPI specification documentation.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch feat-add-openapi-spec

📝 Coding Plan

• Generate coding plan for human review comments

---

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 the current code and only fix it if needed.

Inline comments:
In `@docs/dev-tools/openapi-specification.md`:
- Around line 47-49: The fenced code block containing the URL
"https://{domain_name}/api/schema/?format=openapi-json" is unlabeled and
triggers markdownlint MD040; update that fenced block in
docs/dev-tools/openapi-specification.md to include a language identifier (for
example use "text") so it becomes ```text ... ``` to satisfy the linter and keep
the content unchanged.

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: e479b769-79cb-43dd-85c8-841c948d620a

📥 Commits

Reviewing files that changed from the base of the PR and between 8bbe71b and f01e37c.

📒 Files selected for processing (2)

• docs/.vitepress/config.mts
• docs/dev-tools/openapi-specification.md