MirrorMirror
/
Signal-Server
mirror of https://github.com/signalapp/Signal-Server.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Updating documentation

This commit is contained in:
Documentation Updater 2023-11-13 19:03:27 +00:00
parent 53dd49a25b
commit 64c5638706
1 changed files with 14 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
signal-server-openapi.yaml
View File

@ -185,9 +185,8 @@ paths:
summary: Set username link summary: Set username link
description: | description: |
Authenticated endpoint. For the given encrypted username generates a username link handle. Authenticated endpoint. For the given encrypted username generates a username link handle.
Username link handle could be used to lookup the encrypted username. The username link handle can be used to lookup the encrypted username.
An account can only have one username link at a time. Calling this endpoint will reset previously stored An account can only have one username link at a time; this endpoint overwrites the previous encrypted username if there was one.
encrypted username and deactivate previous link handle.
operationId: updateUsernameLink operationId: updateUsernameLink
requestBody: requestBody:
content: content:
@ -2701,6 +2700,11 @@ components:
minLength: 1 minLength: 1
type: string type: string
description: the URL-safe base64 encoding of the encrypted username description: the URL-safe base64 encoding of the encrypted username
keepLinkHandle:
type: boolean
description: "if set and the account already has an encrypted-username link\
\ handle, reuse the same link handle rather than generating a new one.\
\ The response will still have the link handle."
ReserveUsernameHashResponse: ReserveUsernameHashResponse:
type: object type: object
properties: properties:
@ -2944,14 +2948,14 @@ components:
ECPublicKey: ECPublicKey:
type: object type: object
properties: properties:
type:
type: integer
format: int32
publicKeyBytes: publicKeyBytes:
type: array type: array
items: items:
type: string type: string
format: byte format: byte
type:
type: integer
format: int32
ECSignedPreKey: ECSignedPreKey:
type: object type: object
properties: properties:
@ -3483,13 +3487,13 @@ components:
WebSocketClient: WebSocketClient:
type: object type: object
properties: properties:
userAgent:
type: string
open:
type: boolean
createdTimestamp: createdTimestamp:
type: integer type: integer
format: int64 format: int64
open:
type: boolean
userAgent:
type: string
WebSocketSessionContext: WebSocketSessionContext:
type: object type: object
properties: properties: