From 3c5aaac30a77a7d1748fae647abdbb0083d567c6 Mon Sep 17 00:00:00 2001
From: Sirn Thanabulpong <sirn@ogsite.net>
Date: Sun, 14 Aug 2022 07:26:30 +0900
Subject: [PATCH] Mention ident_v6 in API documentation

And the reason why IPv6 has ident_v6 instead of reusing standard ident type
---
 fanboi2/templates/api/_posts.mako | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/fanboi2/templates/api/_posts.mako b/fanboi2/templates/api/_posts.mako
index aabbb22..61ccabc 100644
--- a/fanboi2/templates/api/_posts.mako
+++ b/fanboi2/templates/api/_posts.mako
@@ -141,9 +141,11 @@
                             <th class="api-table-item title">ident_type</th>
                             <td class="api-table-item type">String</td>
                             <td class="api-table-item">
-                                <p>The type of the user ident to distinguish user info.</p>
+                                <p>The type of the user ident.</p>
+                                <p>IPv6 idents are normalized to <code>/64</code> CIDR by default which may be shared between multiple users in some network configuration (such as mobile network) and thus are distinguised by a separate ident_type.</p>
                                 <ul>
-                                    <li><strong>ident</strong> — normal user ident</li>
+                                    <li><strong>ident</strong> — normal user ident (IPv4)</li>
+                                    <li><strong>ident_v6</strong> — normal user ident (IPv6)</li>
                                     <li><strong>ident_admin</strong> — admin ident</li>
                                 </ul>
                                 <pre class="codeblock">"ident_type":"ident"</pre>
-- 
2.45.2