Skip to content

docs: Add REST API docs for version control endpoints#898

Merged
willeastcott merged 4 commits intomainfrom
docs/version-control-api
Feb 15, 2026
Merged

docs: Add REST API docs for version control endpoints#898
willeastcott merged 4 commits intomainfrom
docs/version-control-api

Conversation

@willeastcott
Copy link
Contributor

@willeastcott willeastcott commented Feb 15, 2026

Fixes playcanvas/editor#162
Partially addresses playcanvas/editor#498

Summary

  • Add documentation for 4 version control REST API endpoints: create branch (POST /branches), list checkpoints (GET /branches/:id/checkpoints), get checkpoint (GET /checkpoints/:id), and create checkpoint (POST /checkpoints)
  • Add Japanese translations for all 4 new pages
  • Update sidebar to include new entries alphabetically in the REST API section

Test plan

  • Verify pages render correctly with npm run start
  • Verify Japanese translations render with npm run start -- --locale ja
  • Confirm sidebar shows new entries in alphabetical order
  • Verify all internal links (rate limiting anchors) resolve correctly

Made with Cursor

Add documentation for branch and checkpoint version control endpoints: create branch, list checkpoints, get checkpoint, and create checkpoint. Includes Japanese translations and sidebar updates.

Co-authored-by: Cursor <cursoragent@cursor.com>
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR adds REST API documentation for four version control endpoints that enable programmatic management of branches and checkpoints in PlayCanvas projects. The documentation includes both English originals and Japanese translations, following the established documentation patterns.

Changes:

  • Add documentation for branch creation (POST /branches) and checkpoint management (GET/POST /checkpoints, GET /branches/:id/checkpoints)
  • Include Japanese translations for all new API documentation pages
  • Update sidebar navigation to include new entries in alphabetical order

Reviewed changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
sidebars.js Adds 4 new API documentation entries in alphabetical order within the REST API section
docs/user-manual/api/branch-create.md Documents POST endpoint for creating new branches from existing branches/checkpoints
docs/user-manual/api/checkpoint-create.md Documents POST endpoint for creating checkpoints that capture branch state
docs/user-manual/api/checkpoint-get.md Documents GET endpoint for retrieving a checkpoint by ID
docs/user-manual/api/checkpoint-list.md Documents GET endpoint for listing checkpoints for a branch with pagination
i18n/ja/docusaurus-plugin-content-docs/current/user-manual/api/branch-create.md Japanese translation of branch creation documentation
i18n/ja/docusaurus-plugin-content-docs/current/user-manual/api/checkpoint-create.md Japanese translation of checkpoint creation documentation
i18n/ja/docusaurus-plugin-content-docs/current/user-manual/api/checkpoint-get.md Japanese translation of checkpoint retrieval documentation
i18n/ja/docusaurus-plugin-content-docs/current/user-manual/api/checkpoint-list.md Japanese translation of checkpoint listing documentation

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

willeastcott and others added 3 commits February 15, 2026 20:09
…/branch-create.md

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
…/checkpoint-list.md

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
…/checkpoint-create.md

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@willeastcott willeastcott merged commit c1132fc into main Feb 15, 2026
3 checks passed
@willeastcott willeastcott deleted the docs/version-control-api branch February 15, 2026 20:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add a public REST API to poll for checkpoints in a branch

1 participant