Updating documentation

This commit is contained in:
Documentation Updater 2026-06-23 21:13:57 +00:00
parent 05e38de854
commit 87cd46d42f
4 changed files with 190 additions and 5 deletions

View File

@ -134,7 +134,10 @@ header. If provided, the request will fail with a <code>BAD_AUTHENTICATION</code
</table>
<h3>Logging Errors</h3>
<p>When logging error responses, clients may always log the status code, domain, and reason.</p>
<p>For errors with domain <code>grpc.chat.signal.org</code> and reason <code>CONSTRAINT_VIOLATED</code>, clients should check the <code>details</code> field for a <code>BadRequest</code> proto. If present, they should log the <code>field</code> of each violation in <code>field_violations</code>.</p></div>
<p>For errors with domain <code>grpc.chat.signal.org</code> and reason <code>CONSTRAINT_VIOLATED</code>, clients should check the <code>details</code> field for a <code>BadRequest</code> proto. If present, they should log the <code>field</code> of each violation in <code>field_violations</code>.</p>
<h3>GOAWAY</h3>
<p>In a partial or total server outage, the server may start rejecting new connection requests or terminating existing connections with an HTTP/2 GOAWAY frame with code 0x40.</p>
<p>If clients receive a 0x40 GOAWAY they should retry connections with an aggressive exponential backoff.</p></div>
<h3 id="packages" class="title is-3">
Packages

View File

@ -1925,8 +1925,7 @@ another caller.</p></td>
<span>bytes</span>
</code>
</td>
<td class="content"><p>A prioritized list of username hashes to attempt to reserve. Each hash must
be exactly 32 bytes.</p></td>
<td class="content"><p>A prioritized list of username hashes to attempt to reserve.</p></td>
</tr>

View File

@ -73,6 +73,15 @@
<p>
<a href="#message-org.signal.chat.require.ElementConstraint">
<span class="tag" style="min-width: 6em">Message</span>
<code>ElementConstraint</code>
</a>
</p>
<p>
<a href="#message-org.signal.chat.require.SizeConstraint">
<span class="tag" style="min-width: 6em">Message</span>
@ -122,6 +131,180 @@
<div class="block">
<h4 class="title is-4 type-heading" id="message-org.signal.chat.require.ElementConstraint">
<span>
<a href="#message-org.signal.chat.require.ElementConstraint" title="org.signal.chat.require.ElementConstraint">message ElementConstraint</a>
</span>
</h4>
<div class="block content">
</div>
<table class="table is-fullwidth is-hoverable is-bordered">
<thead>
<tr>
<th></th>
<th>Field</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>1</td>
<td>
nonEmpty
</td>
<td>
<code title="bool">
optional
<span>bool</span>
</code>
</td>
<td class="content"></td>
</tr>
<tr>
<td>2</td>
<td>
size
</td>
<td>
<code title="org.signal.chat.require.SizeConstraint">
optional
<a href="org.signal.chat.require.html#message-org.signal.chat.require.SizeConstraint"><span title="org.signal.chat.require.SizeConstraint">org.signal.chat.require.SizeConstraint</span>
</a>
</code>
</td>
<td class="content"></td>
</tr>
<tr>
<td>3</td>
<td>
exactlySize
</td>
<td>
<code title="uint32">
repeated
<span>uint32</span>
</code>
</td>
<td class="content"></td>
</tr>
<tr>
<td>4</td>
<td>
e164
</td>
<td>
<code title="bool">
optional
<span>bool</span>
</code>
</td>
<td class="content"></td>
</tr>
<tr>
<td>5</td>
<td>
base64url
</td>
<td>
<code title="bool">
optional
<span>bool</span>
</code>
</td>
<td class="content"></td>
</tr>
<tr>
<td>6</td>
<td>
range
</td>
<td>
<code title="org.signal.chat.require.ValueRangeConstraint">
optional
<a href="org.signal.chat.require.html#message-org.signal.chat.require.ValueRangeConstraint"><span title="org.signal.chat.require.ValueRangeConstraint">org.signal.chat.require.ValueRangeConstraint</span>
</a>
</code>
</td>
<td class="content"></td>
</tr>
<tr>
<td>7</td>
<td>
identityType
</td>
<td>
<code title="org.signal.chat.require.IdentityType">
optional
<a href="org.signal.chat.require.html#enum-org.signal.chat.require.IdentityType"><span title="org.signal.chat.require.IdentityType">org.signal.chat.require.IdentityType</span>
</a>
</code>
</td>
<td class="content"></td>
</tr>
<tr>
<td>8</td>
<td>
specified
</td>
<td>
<code title="bool">
optional
<span>bool</span>
</code>
</td>
<td class="content"></td>
</tr>
</tbody>
</table>
</div>
<div class="block">

File diff suppressed because one or more lines are too long