Forgejo · Schema

CreateBranchProtectionOption

CreateBranchProtectionOption options for creating a branch protection

GitSource Code ManagementSelf-HostedDevOpsCI/CDOpen SourceForgeRepositoriesIssuesPull Requests

Properties

Name Type Description
apply_to_admins boolean
approvals_whitelist_teams array
approvals_whitelist_username array
block_on_official_review_requests boolean
block_on_outdated_branch boolean
block_on_rejected_reviews boolean
branch_name string Deprecated: true
dismiss_stale_approvals boolean
enable_approvals_whitelist boolean
enable_merge_whitelist boolean
enable_push boolean
enable_push_whitelist boolean
enable_status_check boolean
ignore_stale_approvals boolean
merge_whitelist_teams array
merge_whitelist_usernames array
protected_file_patterns string
push_whitelist_deploy_keys boolean
push_whitelist_teams array
push_whitelist_usernames array
require_signed_commits boolean
required_approvals integer
rule_name string
status_check_contexts array
unprotected_file_patterns string
View JSON Schema on GitHub

JSON Schema

createbranchprotectionoption.json Raw ↑
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "CreateBranchProtectionOption",
  "description": "CreateBranchProtectionOption options for creating a branch protection",
  "type": "object",
  "properties": {
    "apply_to_admins": {
      "type": "boolean",
      "x-go-name": "ApplyToAdmins"
    },
    "approvals_whitelist_teams": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "x-go-name": "ApprovalsWhitelistTeams"
    },
    "approvals_whitelist_username": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "x-go-name": "ApprovalsWhitelistUsernames"
    },
    "block_on_official_review_requests": {
      "type": "boolean",
      "x-go-name": "BlockOnOfficialReviewRequests"
    },
    "block_on_outdated_branch": {
      "type": "boolean",
      "x-go-name": "BlockOnOutdatedBranch"
    },
    "block_on_rejected_reviews": {
      "type": "boolean",
      "x-go-name": "BlockOnRejectedReviews"
    },
    "branch_name": {
      "description": "Deprecated: true",
      "type": "string",
      "x-go-name": "BranchName"
    },
    "dismiss_stale_approvals": {
      "type": "boolean",
      "x-go-name": "DismissStaleApprovals"
    },
    "enable_approvals_whitelist": {
      "type": "boolean",
      "x-go-name": "EnableApprovalsWhitelist"
    },
    "enable_merge_whitelist": {
      "type": "boolean",
      "x-go-name": "EnableMergeWhitelist"
    },
    "enable_push": {
      "type": "boolean",
      "x-go-name": "EnablePush"
    },
    "enable_push_whitelist": {
      "type": "boolean",
      "x-go-name": "EnablePushWhitelist"
    },
    "enable_status_check": {
      "type": "boolean",
      "x-go-name": "EnableStatusCheck"
    },
    "ignore_stale_approvals": {
      "type": "boolean",
      "x-go-name": "IgnoreStaleApprovals"
    },
    "merge_whitelist_teams": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "x-go-name": "MergeWhitelistTeams"
    },
    "merge_whitelist_usernames": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "x-go-name": "MergeWhitelistUsernames"
    },
    "protected_file_patterns": {
      "type": "string",
      "x-go-name": "ProtectedFilePatterns"
    },
    "push_whitelist_deploy_keys": {
      "type": "boolean",
      "x-go-name": "PushWhitelistDeployKeys"
    },
    "push_whitelist_teams": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "x-go-name": "PushWhitelistTeams"
    },
    "push_whitelist_usernames": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "x-go-name": "PushWhitelistUsernames"
    },
    "require_signed_commits": {
      "type": "boolean",
      "x-go-name": "RequireSignedCommits"
    },
    "required_approvals": {
      "type": "integer",
      "format": "int64",
      "x-go-name": "RequiredApprovals"
    },
    "rule_name": {
      "type": "string",
      "x-go-name": "RuleName"
    },
    "status_check_contexts": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "x-go-name": "StatusCheckContexts"
    },
    "unprotected_file_patterns": {
      "type": "string",
      "x-go-name": "UnprotectedFilePatterns"
    }
  },
  "x-go-package": "forgejo.org/modules/structs"
}