UNPKG

cberg

Version:

Node.js Client for the Codeberg API

74 lines (66 loc) 3.41 kB
# BranchProtection BranchProtection represents a branch protection for a repository ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **apply_to_admins** | **boolean** | | [optional] [default to undefined] **approvals_whitelist_teams** | **Array<string>** | | [optional] [default to undefined] **approvals_whitelist_username** | **Array<string>** | | [optional] [default to undefined] **block_on_official_review_requests** | **boolean** | | [optional] [default to undefined] **block_on_outdated_branch** | **boolean** | | [optional] [default to undefined] **block_on_rejected_reviews** | **boolean** | | [optional] [default to undefined] **branch_name** | **string** | Deprecated: true | [optional] [default to undefined] **created_at** | **string** | | [optional] [default to undefined] **dismiss_stale_approvals** | **boolean** | | [optional] [default to undefined] **enable_approvals_whitelist** | **boolean** | | [optional] [default to undefined] **enable_merge_whitelist** | **boolean** | | [optional] [default to undefined] **enable_push** | **boolean** | | [optional] [default to undefined] **enable_push_whitelist** | **boolean** | | [optional] [default to undefined] **enable_status_check** | **boolean** | | [optional] [default to undefined] **ignore_stale_approvals** | **boolean** | | [optional] [default to undefined] **merge_whitelist_teams** | **Array<string>** | | [optional] [default to undefined] **merge_whitelist_usernames** | **Array<string>** | | [optional] [default to undefined] **protected_file_patterns** | **string** | | [optional] [default to undefined] **push_whitelist_deploy_keys** | **boolean** | | [optional] [default to undefined] **push_whitelist_teams** | **Array<string>** | | [optional] [default to undefined] **push_whitelist_usernames** | **Array<string>** | | [optional] [default to undefined] **require_signed_commits** | **boolean** | | [optional] [default to undefined] **required_approvals** | **number** | | [optional] [default to undefined] **rule_name** | **string** | | [optional] [default to undefined] **status_check_contexts** | **Array<string>** | | [optional] [default to undefined] **unprotected_file_patterns** | **string** | | [optional] [default to undefined] **updated_at** | **string** | | [optional] [default to undefined] ## Example ```typescript import { BranchProtection } from 'berg'; const instance: BranchProtection = { apply_to_admins, approvals_whitelist_teams, approvals_whitelist_username, block_on_official_review_requests, block_on_outdated_branch, block_on_rejected_reviews, branch_name, created_at, dismiss_stale_approvals, enable_approvals_whitelist, enable_merge_whitelist, enable_push, enable_push_whitelist, enable_status_check, ignore_stale_approvals, merge_whitelist_teams, merge_whitelist_usernames, protected_file_patterns, push_whitelist_deploy_keys, push_whitelist_teams, push_whitelist_usernames, require_signed_commits, required_approvals, rule_name, status_check_contexts, unprotected_file_patterns, updated_at, }; ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)