This page documents the REST endpoints used for GitHub connectivity checks and manual GitHub-based sync runs.

For the full endpoint list, see API Reference.

Endpoints

GET /wp-json/docsync/v1/sync/test-token

Test the configured GitHub Personal Access Token (PAT).

• Permissions: requires manage_options
• Response: diagnostic object returned by the GitHub client.
• Errors:
  • 400 no_token when no PAT is configured
  • 500 connection_failed when the GitHub API request fails

POST /wp-json/docsync/v1/sync/test-repo

Test access to a repository URL.

• 400 no_token when no PAT is configured
• 500 connection_failed when the GitHub API request fails

Manual GitHub Sync

POST /wp-json/docsync/v1/sync/all

Run GitHub sync across all project terms that have a GitHub URL configured.

• 400 no_token when no PAT is configured
• 500 connection_failed when the GitHub API request fails

POST /wp-json/docsync/v1/sync/term/{id}

Run GitHub sync for a single project term.

• Permissions: requires manage_options
• Body:
  json

  { "repo_url": "https://github.com/owner/repo" }
  

• Response: repository diagnostic object on success.
• Errors: returns a WP REST error response; error data may include owner, repo, and sso_url.