{% 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 protection status of a pull</p>
  </div>

  <div class="card shadow-sm mb-4">
    <div class="card-body">
      <h2 class="h6 text-uppercase text-muted">Auth</h2>
      <div class="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">Example</h2>
      <div class="bg-light border rounded p-3">
        <pre class="mb-0"><code>pearing-cli get-pull-protection teams/platform/website 42</code></pre>
      </div>
    </div>
  </div>

  <div class="card shadow-sm mb-4">
    <div class="card-body">
      <h2 class="h6 text-uppercase text-muted">Expected Response</h2>
      <p class="mb-0">Prints a JSON object showing all matching branch protection rules, per-check status (<code>ok</code>, <code>pending</code>, or <code>failed</code>), and whether the pull is currently blocked from merging. When no rules match the target branch, <code>status</code> is <code>ok</code> and <code>rules</code> is empty.</p>
    </div>
  </div>

  <div class="card shadow-sm mb-4">
    <div class="card-body">
      <h2 class="h6 text-uppercase text-muted">Errors</h2>
      <ul class="mb-0">
        <li><code>404 Not Found</code> when the referenced resource does not exist.</li>
        <li><code>403 Forbidden</code> when owner/repo access checks fail.</li>
      </ul>
      <p class="text-muted mt-2 mb-0">Common auth errors are documented on the CLI overview page.</p>
    </div>
  </div>

  <div class="card shadow-sm">
    <div class="card-body">
      <h2 class="h6 text-uppercase text-muted">Help Output</h2>
      <div class="bg-light border rounded p-3">
        <pre class="mb-0"><code>Fetch the protection status of a pull.

Shows all matching branch protection rules, per-check status,
and whether the pull is currently blocked from merging.

Usage: pearing-cli get-pull-protection &lt;REPO&gt; &lt;NUMBER&gt;

Arguments:
  &lt;REPO&gt;    Target repo locator (`teams/&lt;team_slug&gt;/&lt;repo_slug&gt;` or `&lt;username&gt;/&lt;repo_slug&gt;`), or `&lt;repo_slug&gt;` for authenticated user
  &lt;NUMBER&gt;  Pull number in target repo

Options:
  -h, --help  Print help (see more with '--help')</code></pre>
      </div>
    </div>
  </div>
{% endblock %}