Skip to content

docs: add list project pages API reference#258

Merged
danciaclara merged 1 commit intomasterfrom
doc-add-project-page-docs
Apr 8, 2026
Merged

docs: add list project pages API reference#258
danciaclara merged 1 commit intomasterfrom
doc-add-project-page-docs

Conversation

@iam-vipin
Copy link
Copy Markdown
Member

@iam-vipin iam-vipin commented Apr 8, 2026

Add documentation for the new List Project Pages API endpoint (GET /api/v1/workspaces/{workspace_slug}/projects/{project_id}/pages/).

  • New page: docs/api-reference/page/list-project-pages.md
  • Updated sidebar in config.mts

Related: https://github.com/makeplane/plane-ee/pull/6650

Summary by CodeRabbit

  • Documentation
    • Added comprehensive API reference documentation for the "List Project Pages" endpoint, including the complete endpoint path and all required/optional parameters.
    • Includes OAuth scope requirements, multi-language request examples (cURL, Python, JavaScript), and sample JSON response structures with pagination details.
    • Updated navigation sidebar to include the new API reference entry.

@vercel
Copy link
Copy Markdown

vercel bot commented Apr 8, 2026

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

Project Deployment Actions Updated (UTC)
developer-docs Ready Ready Preview, Comment Apr 8, 2026 1:47pm

Request Review

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Apr 8, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 14de4f6d-3ecf-4e70-a1e8-acb4315bfb2b

📥 Commits

Reviewing files that changed from the base of the PR and between 731ec20 and a6bb7f5.

📒 Files selected for processing (2)
  • docs/.vitepress/config.mts
  • docs/api-reference/page/list-project-pages.md

📝 Walkthrough

Walkthrough

Added API reference documentation and sidebar navigation for the "List Project Pages" endpoint, including endpoint specification, required parameters, OAuth scope requirements, multi-language request examples, and sample response payload structure.

Changes

Cohort / File(s) Summary
VitePress Configuration
docs/.vitepress/config.mts
Added sidebar navigation entry for new "List Project Pages" API reference page.
API Documentation
docs/api-reference/page/list-project-pages.md
New API reference documentation for GET /api/v1/workspaces/{workspace_slug}/projects/{project_id}/pages/ endpoint with parameter definitions, OAuth scope requirements, and multi-language request/response examples.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 Hop along the docs, a new page appears,
List Project Pages clears the API spheres,
With endpoints and examples so neat,
Documentation's now complete! ✨

🚥 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 clearly and concisely summarizes the main change: adding documentation for a new API reference page for listing project pages.
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 docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch doc-add-project-page-docs

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

@danciaclara danciaclara merged commit 58024f4 into master Apr 8, 2026
8 checks passed
@danciaclara danciaclara deleted the doc-add-project-page-docs branch April 8, 2026 14:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants