Updating documentation

This commit is contained in:
Documentation Updater
2026-08-20 22:18:56 +00:00
parent 05018238b2
commit f648ed8311
4 changed files with 1328 additions and 6 deletions
File diff suppressed because it is too large Load Diff
+161 -1
View File
@@ -311,6 +311,24 @@
</p>
<p>
<a href="#message-org.signal.chat.profile.SetV1AvatarRequest">
<span class="tag" style="min-width: 6em">Message</span>
<code>SetV1AvatarRequest</code>
</a>
</p>
<p>
<a href="#message-org.signal.chat.profile.SetV1AvatarResponse">
<span class="tag" style="min-width: 6em">Message</span>
<code>SetV1AvatarResponse</code>
</a>
</p>
<p>
@@ -414,6 +432,32 @@ should use the version of this method in <code>ProfileAnonymous</code> instead.<
<p>Note: <code>Accounts.SetZkCredentialKey</code> is a pre-requisite for this RPC</p></p>
</div>
</div>
<div class="box">
<div class="block">
<h5 class="title is-5" id="service-org.signal.chat.profile.Profile-SetV1Avatar">
<a href="#service-org.signal.chat.profile.Profile-SetV1Avatar">
rpc <code>SetV1Avatar</code>
</a>
</h5>
Request: <code><a href="org.signal.chat.profile.html#message-org.signal.chat.profile.SetV1AvatarRequest"><span title="org.signal.chat.profile.SetV1AvatarRequest">org.signal.chat.profile.SetV1AvatarRequest</span>
</a></code><br>
Response: <code><a href="org.signal.chat.profile.html#message-org.signal.chat.profile.SetV1AvatarResponse"><span title="org.signal.chat.profile.SetV1AvatarResponse">org.signal.chat.profile.SetV1AvatarResponse</span>
</a></code><br>
</div>
<div class="block">
<p><p>Returns credentials used by clients to upload a v1 avatar, deleting any current avatar.</p>
<p>This RPC streamlines avatar changes during the v1 -&gt; v2 transition by minimizing uploads:
1. SetV1Avatar
2. Upload to CDN
3. SetProfile with v1 <code>AVATAR_CHANGE_UNCHANGED</code> and the v1 avatar in the v2 profile body</p>
<p>Clients that do this will be required to upload current avatars using <code>ProfilesAnonymous.GetAvatarUploadFormRequest</code>
once v1 Profile APIs are no longer supported.</p></p>
</div>
</div>
</div>
@@ -1200,7 +1244,7 @@ performed with this form will be limited to the provided length.</p></td>
</a>
</code>
</td>
<td class="content"></td>
<td class="content"><p>the policy and credential used by clients to upload an avatar to the CDN</p></td>
</tr>
@@ -2821,6 +2865,122 @@ field number without serialization overhead. This is purely aesthetic.</p></td>
</div>
<div class="block">
<h4 class="title is-4 type-heading" id="message-org.signal.chat.profile.SetV1AvatarRequest">
<span>
<a href="#message-org.signal.chat.profile.SetV1AvatarRequest" title="org.signal.chat.profile.SetV1AvatarRequest">message SetV1AvatarRequest</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>
version
</td>
<td>
<code title="string">
<span>string</span>
</code>
</td>
<td class="content"><p>The profile version. Required.</p></td>
</tr>
<tr>
<td>2</td>
<td>
commitment
</td>
<td>
<code title="bytes">
<span>bytes</span>
</code>
</td>
<td class="content"><p>The profile key commitment. Required if this is a new profile version.</p></td>
</tr>
</tbody>
</table>
</div>
<div class="block">
<h4 class="title is-4 type-heading" id="message-org.signal.chat.profile.SetV1AvatarResponse">
<span>
<a href="#message-org.signal.chat.profile.SetV1AvatarResponse" title="org.signal.chat.profile.SetV1AvatarResponse">message SetV1AvatarResponse</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>
form
</td>
<td>
<code title="org.signal.chat.common.S3UploadForm">
<a href="org.signal.chat.common.html#message-org.signal.chat.common.S3UploadForm"><span title="org.signal.chat.common.S3UploadForm">org.signal.chat.common.S3UploadForm</span>
</a>
</code>
</td>
<td class="content"><p>the policy and credential used by clients to upload an avatar to the CDN</p></td>
</tr>
</tbody>
</table>
</div>
+2 -2
View File
File diff suppressed because one or more lines are too long
+12 -3
View File
@@ -3160,6 +3160,9 @@ paths:
description: "If present, an positive integer indicating the number\
\ of seconds before a subsequent attempt could succeed"
style: simple
"441":
description: "A valid one-time password (TOTP) is required, but either no\
\ password was provided or it was incorrect"
"499":
description: Client must support post-quantum ratchet
/v2/config:
@@ -5856,12 +5859,12 @@ components:
DonationPermit:
type: object
properties:
spendId:
type: string
format: byte
expiration:
type: string
format: date-time
spendId:
type: string
format: byte
internalContentsForJNI:
type: string
format: byte
@@ -6377,6 +6380,12 @@ components:
must not be provided if `sessionId` or `recoveryPassword` is provided.
format: byte
nullable: true
totp:
type: integer
description: |
A TOTP one-time password; required if recovering an account that has TOTP keys.
format: int32
nullable: true
accountAttributes:
$ref: "#/components/schemas/AccountAttributes"
skipDeviceTransfer: