post/api/v1/two-way-sync/{spaceId}/bind

Request

  • Base URL: https://falconer.com (the document declares no server; this is the origin it was published from)
  • URL: https://falconer.com/api/v1/two-way-sync/{spaceId}/bind
  • Auth: none declared

Path parameters

spaceIdinteger required

Space id, from GET /spaces.

Headers

x-organization-idstring

Required when using OAuth bearer tokens.

Request body

repositorystring required

owner/repo, from GET /github/repositories.

branchstring required
basePathstring

Repository folder to sync; the repository root when omitted.

mergeStrategy'direct_commit' | 'review_request' | 'pull_request' required
direction'import' | 'export'

import (default) pulls the repository in. export binds without importing; run POST /two-way-sync/{spaceId}/export next. Export needs direct_commit.

setUpDocsiteboolean

Also reserve a docs site seeded from the repository docs config.

Response

Bound; the first import is running.

spaceIdinteger required
folderIdinteger required

The Space root folder's ID, for /nav and /folders.

repositorystring required
taskIdstring nullable required

Poll GET /two-way-sync/{spaceId}/runs/{taskId}. null when no run started: an export bind, or a retry folded into a run already queued.

Changes

No recorded changes to this operation across all 1 revision of this API.