/bff/admin/sync-documentation-repo

One-click operator shortcut that always targets the bizkithub-documentation organisation (id 81) regardless of which organisation the caller is currently browsing. Reads the git repo URL and branch from that organisation's own configuration (post_import_git_repo_url, post_import_git_branch), runs the standard git-import pipeline, and immediately flips every NEWLY-CREATED post from private to public. Updated and unchanged posts keep whatever visibility an operator had already chosen. Requires internal admin membership.

AdminpostBffAdminSync-documentation-repo

Parameters

No parameters required

This endpoint takes no path, query, header or body parameters.

Response schema

1 status code documented

200Success

successbooleanRequired

Whether the sync completed without a hard failure.

ownerstringRequired

Resolved GitHub owner from the configured repo URL.

repostringRequired

Resolved GitHub repository name.

branchstring | nullRequired

Resolved branch name; null when the default branch was used implicitly.

One of 2:

Variant 1

string

Variant 2

null

filesFoundnumberRequired

Number of Markdown files discovered in the repo.

creatednumberRequired

Posts inserted for the first time.

updatednumberRequired

Existing posts whose title or body changed.

unchangednumberRequired

Existing posts whose title + body matched byte-for-byte.

publishedCountnumberRequired

Newly-created posts flipped from private to public.

errorCountnumberRequired

Number of files that could not be imported (see errors).

warningCountnumberRequired

Number of files that imported with a warning.

errorsobject[]Required

Per-file errors that did NOT abort the run.

Each array item:

pathstringRequired

Repository path of the failing file.

messagestringRequired

Reason the file was skipped.

Response example

application/json

{
  "success": false,
  "owner": "example_owner",
  "repo": "example_repo",
  "filesFound": 0,
  "created": 0,
  "updated": 0,
  "unchanged": 0,
  "publishedCount": 0,
  "errorCount": 0,
  "warningCount": 0,
  "errors": [
    {
      "path": "example_path",
      "message": "example_message"
    }
  ]
}

Request example

POST /bff/admin/sync-documentation-repo

post

curl -X POST "https://api.bizkithub.com/bff/admin/sync-documentation-repo" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key