RepositoryRulePullRequest.php

<?php

declare(strict_types=1);

namespace ApiClients\Client\GitHubEnterprise\Schema;

use ApiClients\Client\GitHubEnterprise\Schema;

final readonly class RepositoryRulePullRequest
{
    public const SCHEMA_JSON         = '{
    "title": "pull_request",
    "required": [
        "type"
    ],
    "type": "object",
    "properties": {
        "type": {
            "enum": [
                "pull_request"
            ],
            "type": "string"
        },
        "parameters": {
            "required": [
                "dismiss_stale_reviews_on_push",
                "require_code_owner_review",
                "require_last_push_approval",
                "required_approving_review_count",
                "required_review_thread_resolution"
            ],
            "type": "object",
            "properties": {
                "allowed_merge_methods": {
                    "type": "array",
                    "items": {
                        "enum": [
                            "merge",
                            "squash",
                            "rebase"
                        ],
                        "type": "string"
                    },
                    "description": "Array of allowed merge methods. Allowed values include `merge`, `squash`, and `rebase`. At least one option must be enabled."
                },
                "automatic_copilot_code_review_enabled": {
                    "type": "boolean",
                    "description": "> [!NOTE]\\n> `automatic_copilot_code_review_enabled` is in beta and subject to change.\\n\\nAutomatically request review from Copilot for new pull requests, if the author has access to Copilot code review."
                },
                "dismiss_stale_reviews_on_push": {
                    "type": "boolean",
                    "description": "New, reviewable commits pushed will dismiss previous pull request review approvals."
                },
                "require_code_owner_review": {
                    "type": "boolean",
                    "description": "Require an approving review in pull requests that modify files that have a designated code owner."
                },
                "require_last_push_approval": {
                    "type": "boolean",
                    "description": "Whether the most recent reviewable push must be approved by someone other than the person who pushed it."
                },
                "required_approving_review_count": {
                    "maximum": 10,
                    "minimum": 0,
                    "type": "integer",
                    "description": "The number of approving reviews that are required before a pull request can be merged."
                },
                "required_review_thread_resolution": {
                    "type": "boolean",
                    "description": "All conversations on code must be resolved before a pull request can be merged."
                }
            }
        }
    },
    "description": "Require all commits be made to a non-target branch and submitted via a pull request before they can be merged."
}';
    public const SCHEMA_TITLE        = 'pull_request';
    public const SCHEMA_DESCRIPTION  = 'Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.';
    public const SCHEMA_EXAMPLE_DATA = '{
    "type": "pull_request",
    "parameters": {
        "allowed_merge_methods": [
            "generated",
            "generated"
        ],
        "automatic_copilot_code_review_enabled": false,
        "dismiss_stale_reviews_on_push": false,
        "require_code_owner_review": false,
        "require_last_push_approval": false,
        "required_approving_review_count": 31,
        "required_review_thread_resolution": false
    }
}';

    public function __construct(public string $type, public Schema\RepositoryRulePullRequest\Parameters|null $parameters)
    {
    }
}