{% extends "docs/base.html" %}

{% block docs_content %}
  <div class="mb-4">
    <h1 class="h3 mb-1">Get pull protection</h1>
    <p class="text-muted mb-0">Fetch the branch protection status of a pull request.</p>
  </div>

  <div class="card shadow-sm mb-4">
    <div class="card-body">
      <h2 class="h6 text-uppercase text-muted">Endpoints</h2>
      <div class="bg-light border rounded p-3">
        <pre class="mb-0"><code>GET /api/v1/teams/{team_slug}/repos/{repo_slug}/pulls/{number}/protection
GET /api/v1/users/{username}/repos/{repo_slug}/pulls/{number}/protection</code></pre>
      </div>
      <div class="mt-2 d-flex flex-wrap gap-2">
        <span class="badge text-bg-secondary">Authenticated</span>
      </div>
    </div>
  </div>

  <div class="card shadow-sm mb-4">
    <div class="card-body">
      <h2 class="h6 text-uppercase text-muted">Usage</h2>
      <div class="bg-light border rounded p-3">
        <pre class="mb-0"><code>curl --header "Authorization: Bearer $PEARING_API_TOKEN" \
  "$PEARING_API_URL/v1/teams/platform/repos/website/pulls/42/protection"</code></pre>
      </div>
    </div>
  </div>

  <div class="card shadow-sm mb-4">
    <div class="card-body">
      <h2 class="h6 text-uppercase text-muted">Success</h2>
      <p class="mb-2"><code>200 OK</code> with the protection status for the pull. Each matching branch protection rule is evaluated independently. The top-level <code>status</code> is <code>ok</code>, <code>pending</code>, or <code>failed</code>. When <code>merge_blocked</code> is <code>true</code>, the pull cannot be merged until the blocking conditions are resolved.</p>
      <div class="bg-light border rounded p-3">
        <pre class="mb-0"><code>{
  "pull_number": 42,
  "target_ref": "main",
  "status": "pending",
  "merge_blocked": true,
  "merge_blocked_reason": "0/1 approvals recorded.",
  "rules": [
    {
      "branch_pattern": "main",
      "status": "pending",
      "approvers": ["alice"],
      "checks": [
        {
          "label": "approvals",
          "status": "pending",
          "detail": "0/1 approvals recorded."
        },
        {
          "label": "single_commit",
          "status": "ok",
          "detail": "Not required."
        },
        {
          "label": "fast_forward",
          "status": "ok",
          "detail": "Fast-forward merge is available."
        },
        {
          "label": "owner_merge",
          "status": "ok",
          "detail": "Not required."
        }
      ]
    }
  ]
}</code></pre>
      </div>
    </div>
  </div>

  <div class="card shadow-sm">
    <div class="card-body">
      <h2 class="h6 text-uppercase text-muted">Errors</h2>
      <ul class="mb-0">
        <li><code>403 Forbidden</code> when repo access is denied (<code>repo_access</code>).</li>
        <li><code>404 Not Found</code> when repo or pull number is not found.</li>
      </ul>
      <p class="text-muted mt-2 mb-0">Common auth errors are documented on the API overview page.</p>
    </div>
  </div>
{% endblock %}