Skip to content

Latest commit

 

History

History
41 lines (26 loc) · 2.28 KB

File metadata and controls

41 lines (26 loc) · 2.28 KB

RepoSyncCreateParameters

Properties

Name Type Description Notes
projectId String ID of the project to connect the Repo Sync to.
name String Optional custom display name for this repo sync. Defaults to null; when null the project name is used as the display name. [optional]
gitProvider GitProviderEnum The Git provider to use. [optional]
connectionType ConnectionTypeEnum The authentication method used to connect to the Git provider. Defaults to `token` if not specified. Valid values: - `token` — Personal access token stored on the Repo Sync. Supported by all providers. - `github_app` — Authenticate via the Phrase GitHub App installation on your account. GitHub only. The account must already have the GitHub App installed; if not, the response will include a `github_app_installation_url`. - `self_hosted` — Token-based auth for self-hosted Git instances. Requires `custom_api_endpoint`.
repoName String Full repository name including the owner, e.g. `my-org/my-repo`.
baseBranch String The default branch to use for imports and exports. [optional]
prBranch String Branch that translations are exported to before opening a pull request. If omitted, exports go directly to `base_branch`. [optional]
autoImport Boolean Enable automatic import of translations triggered by pushes to the repository. [optional]
accessToken String Personal access token for the Git provider. Required when `connection_type` is `token` or `self_hosted`. Not used for `github_app`. [optional]
customApiEndpoint String Custom API endpoint URL for self-hosted Git instances. Required when `connection_type` is `self_hosted`. [optional]

Enum: GitProviderEnum

Name Value
GITHUB "github"
GITLAB "gitlab"
BITBUCKET "bitbucket"

Enum: ConnectionTypeEnum

Name Value
TOKEN "token"
GITHUB_APP "github_app"
SELF_HOSTED "self_hosted"