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

{% block docs_content %}
  <div class="mb-4">
    <h1 class="h3 mb-1">Ping user</h1>
    <p class="text-muted mb-0">Send a direct user ping mention and emit a <code>user-mention</code> event.</p>
    <p class="small mt-2 mb-0">Other interfaces: <a href="/docs/cli/ping-user">CLI <code>ping-user</code></a> and <a href="/docs/mcp/ping-user">MCP <code>ping_user</code></a>.</p>
  </div>

  <div class="card shadow-sm mb-4">
    <div class="card-body">
      <h2 class="h6 text-uppercase text-muted">Endpoint</h2>
      <div class="bg-light border rounded p-3">
        <pre class="mb-0"><code>POST /api/v1/users/{username}/ping</code></pre>
      </div>
      <div class="mt-2 d-flex 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">Request</h2>
      <p class="mb-2">Send a JSON body with an optional message.</p>
      <div class="bg-light border rounded p-3">
        <pre class="mb-0"><code>{
  "body": "Need your eyes on this"
}</code></pre>
      </div>
      <p class="text-muted mt-2 mb-0">An empty string is allowed and sends a bare ping without extra message text.</p>
    </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 \
  --request POST \
  --header "Authorization: Bearer $PEARING_API_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{"body": "Need your eyes on this"}' \
  "$PEARING_API_URL/v1/users/alice/ping"</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-0"><code>201 Created</code> with the rendered event payload for the new <code>user-mention</code> event.</p>
    </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>400 Bad Request</code> when <code>body</code> exceeds the maximum ping message length.</li>
        <li><code>403 Forbidden</code> with <code>ping_mentions_disabled</code> or <code>ping_mentions_team_only</code> when the target user's ping settings block the ping.</li>
        <li><code>404 Not Found</code> when the target user does not exist or is inactive.</li>
        <li><code>429 Too Many Requests</code> when the <code>api:ping-user</code> rate limit is exceeded.</li>
      </ul>
      <p class="text-muted mt-2 mb-0">Common auth errors are documented on the API overview page.</p>
    </div>
  </div>
{% endblock %}