Skip to content

doc: add list workspace wiki pages API doc#257

Merged
danciaclara merged 1 commit intomasterfrom
doc-add-wiki_page_docs
Apr 8, 2026
Merged

doc: add list workspace wiki pages API doc#257
danciaclara merged 1 commit intomasterfrom
doc-add-wiki_page_docs

Conversation

@iam-vipin
Copy link
Copy Markdown
Member

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

Description

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • Feature (non-breaking change which adds functionality)
  • Improvement (change that would cause existing functionality to not work as expected)
  • Code refactoring
  • Performance improvements
  • Documentation update

Screenshots and Media (if applicable)

Screen.Recording.2026-04-08.at.4.28.50.PM.mov

Test Scenarios

References

Summary by CodeRabbit

  • Documentation
    • Added API reference documentation for the "List Workspace Pages" endpoint, including details on parameters, filtering options, pagination, authentication requirements, and example requests in multiple languages.
    • Updated navigation to include the new documentation entry for improved discoverability.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@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 10:59am

Request Review

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Apr 8, 2026

📝 Walkthrough

Walkthrough

Added documentation for a new API endpoint to list workspace pages. The change includes a sidebar navigation update to point to the new reference page and comprehensive endpoint documentation detailing parameters, authentication requirements, request examples, and response structure.

Changes

Cohort / File(s) Summary
API Documentation for List Workspace Pages
docs/.vitepress/config.mts, docs/api-reference/page/list-workspace-pages.md
Added new sidebar navigation entry and comprehensive API reference page for the GET /api/v1/workspaces/{workspace_slug}/pages/ endpoint, including path/query parameters, OAuth scope requirement, cURL/Python/JavaScript examples, and paginated response structure.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Poem

🐰 A new page blooms in our doc's great tree,
Where workspace pages users now can see,
With examples hopping, parameters clear,
The API reference grows through the year! 📚✨

🚥 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 summarizes the main change: adding documentation for the list workspace wiki pages API, which is directly reflected in both the new documentation file and the sidebar configuration update.
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-wiki_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.

Copy link
Copy Markdown

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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/api-reference/page/list-workspace-pages.md`:
- Line 21: Change the three headings currently written as H3 ("### Path
Parameters" and the other two headings at the same locations) to H2 ("## …") so
they follow the H1 in the document and satisfy MD001; specifically update the
headings labeled "Path Parameters" and the other headings at the same spots
(previously prefixed with ###) to use ## instead.
🪄 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: defaults

Review profile: CHILL

Plan: Pro

Run ID: 4a80e8a6-dad0-41a8-96e1-44d274d4283f

📥 Commits

Reviewing files that changed from the base of the PR and between 9fa5d12 and 648ae1c.

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


<div class="params-section">

### Path Parameters
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Fix heading-level jump to satisfy markdown lint (MD001).

After the H1 on Line 7, Lines 21/36/75 should be H2, not H3. This can fail docs lint checks.

💡 Proposed fix
-### Path Parameters
+## Path Parameters
...
-### Query Parameters
+## Query Parameters
...
-### Scopes
+## Scopes

Also applies to: 36-36, 75-75

🧰 Tools
🪛 markdownlint-cli2 (0.22.0)

[warning] 21-21: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3

(MD001, heading-increment)

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/api-reference/page/list-workspace-pages.md` at line 21, Change the three
headings currently written as H3 ("### Path Parameters" and the other two
headings at the same locations) to H2 ("## …") so they follow the H1 in the
document and satisfy MD001; specifically update the headings labeled "Path
Parameters" and the other headings at the same spots (previously prefixed with
###) to use ## instead.

@danciaclara danciaclara merged commit 731ec20 into master Apr 8, 2026
8 checks passed
@danciaclara danciaclara deleted the doc-add-wiki_page_docs branch April 8, 2026 11:13
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.

3 participants