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-12-06 17:41:22 +00:00
parent ab8b1a45e3
commit 44af128526
1 changed files with 79 additions and 123 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

202
signal-server-openapi.yaml
View File

@ -564,15 +564,15 @@ paths:
parameters: parameters:
- name: X-Signal-ZK-Auth - name: X-Signal-ZK-Auth
in: header in: header
description: Presentation of a ZK backup auth credential acquired from /v1/archives/auth description: "Presentation of a ZK backup auth credential acquired from /v1/archives/auth,\
as a base64 encoded string \ encoded in standard padded base64"
required: true required: true
schema: schema:
type: string type: string
- name: X-Signal-ZK-Auth-Signature - name: X-Signal-ZK-Auth-Signature
in: header in: header
description: Signature of the ZK auth credential's presentation as a base64 description: "Signature of the ZK auth credential's presentation, encoded\
encoded string \ in standard padded base64"
required: true required: true
schema: schema:
type: string type: string
@ -606,15 +606,15 @@ paths:
parameters: parameters:
- name: X-Signal-ZK-Auth - name: X-Signal-ZK-Auth
in: header in: header
description: Presentation of a ZK backup auth credential acquired from /v1/archives/auth description: "Presentation of a ZK backup auth credential acquired from /v1/archives/auth,\
as a base64 encoded string \ encoded in standard padded base64"
required: true required: true
schema: schema:
type: string type: string
- name: X-Signal-ZK-Auth-Signature - name: X-Signal-ZK-Auth-Signature
in: header in: header
description: Signature of the ZK auth credential's presentation as a base64 description: "Signature of the ZK auth credential's presentation, encoded\
encoded string \ in standard padded base64"
required: true required: true
schema: schema:
type: string type: string
@ -651,15 +651,15 @@ paths:
parameters: parameters:
- name: X-Signal-ZK-Auth - name: X-Signal-ZK-Auth
in: header in: header
description: Presentation of a ZK backup auth credential acquired from /v1/archives/auth description: "Presentation of a ZK backup auth credential acquired from /v1/archives/auth,\
as a base64 encoded string \ encoded in standard padded base64"
required: true required: true
schema: schema:
type: string type: string
- name: X-Signal-ZK-Auth-Signature - name: X-Signal-ZK-Auth-Signature
in: header in: header
description: Signature of the ZK auth credential's presentation as a base64 description: "Signature of the ZK auth credential's presentation, encoded\
encoded string \ in standard padded base64"
required: true required: true
schema: schema:
type: string type: string
@ -696,15 +696,15 @@ paths:
parameters: parameters:
- name: X-Signal-ZK-Auth - name: X-Signal-ZK-Auth
in: header in: header
description: Presentation of a ZK backup auth credential acquired from /v1/archives/auth description: "Presentation of a ZK backup auth credential acquired from /v1/archives/auth,\
as a base64 encoded string \ encoded in standard padded base64"
required: true required: true
schema: schema:
type: string type: string
- name: X-Signal-ZK-Auth-Signature - name: X-Signal-ZK-Auth-Signature
in: header in: header
description: Signature of the ZK auth credential's presentation as a base64 description: "Signature of the ZK auth credential's presentation, encoded\
encoded string \ in standard padded base64"
required: true required: true
schema: schema:
type: string type: string
@ -754,15 +754,15 @@ paths:
parameters: parameters:
- name: X-Signal-ZK-Auth - name: X-Signal-ZK-Auth
in: header in: header
description: Presentation of a ZK backup auth credential acquired from /v1/archives/auth description: "Presentation of a ZK backup auth credential acquired from /v1/archives/auth,\
as a base64 encoded string \ encoded in standard padded base64"
required: true required: true
schema: schema:
type: string type: string
- name: X-Signal-ZK-Auth-Signature - name: X-Signal-ZK-Auth-Signature
in: header in: header
description: Signature of the ZK auth credential's presentation as a base64 description: "Signature of the ZK auth credential's presentation, encoded\
encoded string \ in standard padded base64"
required: true required: true
schema: schema:
type: string type: string
@ -813,13 +813,13 @@ paths:
required: true required: true
schema: schema:
type: integer type: integer
format: int32 format: int64
- name: redemptionEndSeconds - name: redemptionEndSeconds
in: query in: query
required: true required: true
schema: schema:
type: integer type: integer
format: int32 format: int64
responses: responses:
"200": "200":
content: content:
@ -845,15 +845,15 @@ paths:
parameters: parameters:
- name: X-Signal-ZK-Auth - name: X-Signal-ZK-Auth
in: header in: header
description: Presentation of a ZK backup auth credential acquired from /v1/archives/auth description: "Presentation of a ZK backup auth credential acquired from /v1/archives/auth,\
as a base64 encoded string \ encoded in standard padded base64"
required: true required: true
schema: schema:
type: string type: string
- name: X-Signal-ZK-Auth-Signature - name: X-Signal-ZK-Auth-Signature
in: header in: header
description: Signature of the ZK auth credential's presentation as a base64 description: "Signature of the ZK auth credential's presentation, encoded\
encoded string \ in standard padded base64"
required: true required: true
schema: schema:
type: string type: string
@ -918,15 +918,15 @@ paths:
parameters: parameters:
- name: X-Signal-ZK-Auth - name: X-Signal-ZK-Auth
in: header in: header
description: Presentation of a ZK backup auth credential acquired from /v1/archives/auth description: "Presentation of a ZK backup auth credential acquired from /v1/archives/auth,\
as a base64 encoded string \ encoded in standard padded base64"
required: true required: true
schema: schema:
type: string type: string
- name: X-Signal-ZK-Auth-Signature - name: X-Signal-ZK-Auth-Signature
in: header in: header
description: Signature of the ZK auth credential's presentation as a base64 description: "Signature of the ZK auth credential's presentation, encoded\
encoded string \ in standard padded base64"
required: true required: true
schema: schema:
type: string type: string
@ -1094,12 +1094,12 @@ paths:
in: query in: query
schema: schema:
type: integer type: integer
format: int32 format: int64
- name: redemptionEndSeconds - name: redemptionEndSeconds
in: query in: query
schema: schema:
type: integer type: integer
format: int32 format: int64
- name: pniAsServiceId - name: pniAsServiceId
in: query in: query
schema: schema:
@ -1258,6 +1258,10 @@ paths:
in: header in: header
schema: schema:
$ref: '#/components/schemas/BasicAuthorizationHeader' $ref: '#/components/schemas/BasicAuthorizationHeader'
- name: User-Agent
in: header
schema:
type: string
requestBody: requestBody:
content: content:
application/json: application/json:
@ -1350,6 +1354,10 @@ paths:
in: header in: header
schema: schema:
$ref: '#/components/schemas/BasicAuthorizationHeader' $ref: '#/components/schemas/BasicAuthorizationHeader'
- name: User-Agent
in: header
schema:
type: string
requestBody: requestBody:
content: content:
application/json: application/json:
@ -1497,6 +1505,10 @@ paths:
in: query in: query
schema: schema:
type: string type: string
default: aci
enum:
- ACI
- PNI
responses: responses:
"200": "200":
description: Body contains the number of available one-time prekeys for description: Body contains the number of available one-time prekeys for
@ -1513,9 +1525,7 @@ paths:
tags: tags:
- Keys - Keys
summary: Upload new prekeys summary: Upload new prekeys
description: |2 description: Upload new pre-keys for this device.
Upload new prekeys for this device. Can also be used, from the primary device only, to set the account's identity
key, but this is deprecated now that accounts can be created atomically.
operationId: setKeys operationId: setKeys
parameters: parameters:
- name: identity - name: identity
@ -1527,12 +1537,10 @@ paths:
(pni) identity (pni) identity
default: aci default: aci
enum: enum:
- ACI
- PNI
- aci - aci
- pni - pni
- name: User-Agent
in: header
schema:
type: string
responses: responses:
"200": "200":
description: Indicates that new keys were successfully stored. description: Indicates that new keys were successfully stored.
@ -1550,13 +1558,17 @@ paths:
- Keys - Keys
summary: Upload a new signed prekey summary: Upload a new signed prekey
description: |2 description: |2
Upload a new signed elliptic-curve prekey for this device. Deprecated; use PUT /v2/keys with instead. Upload a new signed elliptic-curve prekey for this device. Deprecated; use PUT /v2/keys instead.
operationId: setSignedKey operationId: setSignedKey
parameters: parameters:
- name: identity - name: identity
in: query in: query
schema: schema:
type: string type: string
default: aci
enum:
- ACI
- PNI
requestBody: requestBody:
content: content:
application/json: application/json:
@ -1697,16 +1709,10 @@ paths:
put: put:
tags: tags:
- Messages - Messages
summary: Send multi-recipient sealed-sender message
description: |
Deliver a common-payload message to multiple recipients.
An unidentifed-access key for all recipients must be provided, unless the message is a story.
operationId: sendMultiRecipientMessage operationId: sendMultiRecipientMessage
parameters: parameters:
- name: Unidentified-Access-Key - name: Unidentified-Access-Key
in: header in: header
description: The bitwise xor of the unidentified access keys for every recipient
of the message
schema: schema:
$ref: '#/components/schemas/CombinedUnidentifiedSenderAccessKeys' $ref: '#/components/schemas/CombinedUnidentifiedSenderAccessKeys'
- name: User-Agent - name: User-Agent
@ -1715,60 +1721,33 @@ paths:
type: string type: string
- name: online - name: online
in: query in: query
description: "If true, deliver the message only to recipients that are online\
\ when it is sent"
schema: schema:
type: boolean type: boolean
- name: ts - name: ts
in: query in: query
description: The sender's timestamp for the envelope
schema: schema:
type: integer type: integer
format: int64 format: int64
- name: urgent - name: urgent
in: query in: query
description: "If true, this message should cause push notifications to be\
\ sent to recipients"
schema: schema:
type: boolean type: boolean
default: true default: true
- name: story - name: story
in: query in: query
description: "If true, the message is a story; access tokens are not checked\
\ and sending to nonexistent recipients is permitted"
schema: schema:
type: boolean type: boolean
requestBody: requestBody:
description: The sealed-sender multi-recipient message payload
content: content:
application/vnd.signal-messenger.mrm: application/vnd.signal-messenger.mrm:
schema: schema:
$ref: '#/components/schemas/MultiRecipientMessage' $ref: '#/components/schemas/MultiRecipientMessage'
required: true required: true
responses: responses:
"200": default:
description: Message was successfully sent to all recipients description: default response
"400":
description: The envelope specified delivery to the same recipient device
multiple times
"401":
description: The message is not a story and the unauthorized access key
is incorrect
"404":
description: The message is not a story and some of the recipient service
IDs do not correspond to registered Signal users
"409":
description: Incorrect set of devices supplied for some recipients
content: content:
application/json: application/json: {}
schema:
type: string
"410":
description: Mismatched registration ids supplied for some recipient devices
content:
application/json:
schema:
type: string
/v1/payments/auth: /v1/payments/auth:
get: get:
tags: tags:
@ -3378,7 +3357,7 @@ components:
format: int32 format: int32
mediaId: mediaId:
type: string type: string
description: The mediaId of the object in URL-safe base64 description: "The mediaId of the object, encoded in URL-safe padded base64"
description: Detailed outcome information for each copy request in the batch description: Detailed outcome information for each copy request in the batch
CopyMediaBatchRequest: CopyMediaBatchRequest:
required: required:
@ -3412,16 +3391,18 @@ components:
format: int32 format: int32
mediaId: mediaId:
type: string type: string
description: mediaId to copy on to the backup CDN in URL-safe base64 description: "mediaId to copy on to the backup CDN, encoded in URL-safe\
\ padded base64"
hmacKey: hmacKey:
type: string type: string
description: "A 32-byte key for the MAC, base64 encoded" description: "A 32-byte key for the MAC, encoded in standard padded base64"
encryptionKey: encryptionKey:
type: string type: string
description: "A 32-byte encryption key for AES, base64 encoded" description: "A 32-byte encryption key for AES, encoded in standard padded\
\ base64"
iv: iv:
type: string type: string
description: "A 16-byte IV for AES, base64 encoded" description: "A 16-byte IV for AES, encoded in standard padded base64"
RemoteAttachment: RemoteAttachment:
required: required:
- cdn - cdn
@ -3450,10 +3431,10 @@ components:
properties: properties:
credential: credential:
type: array type: array
description: A base64 encoded BackupAuthCredential description: "A BackupAuthCredential, encoded in standard padded base64"
items: items:
type: string type: string
description: A base64 encoded BackupAuthCredential description: "A BackupAuthCredential, encoded in standard padded base64"
format: byte format: byte
redemptionTime: redemptionTime:
type: integer type: integer
@ -3486,14 +3467,14 @@ components:
backupAuthCredentialRequest: backupAuthCredentialRequest:
type: string type: string
description: | description: |
A BackupAuthCredentialRequest containing a blinded encrypted backup-id, encoded as a base64 string A BackupAuthCredentialRequest containing a blinded encrypted backup-id, encoded in standard padded base64
SetPublicKeyRequest: SetPublicKeyRequest:
type: object type: object
properties: properties:
backupIdPublicKey: backupIdPublicKey:
type: string type: string
description: "The public key, serialized in libsignal's elliptic-curve public\ description: "The public key, serialized in libsignal's elliptic-curve public\
\ key format and then base64-encoded." \ key format, and encoded in standard padded base64."
AttachmentDescriptorV2: AttachmentDescriptorV2:
type: object type: object
properties: properties:
@ -3790,10 +3771,10 @@ components:
type: string type: string
description: | description: |
The public key, serialized in libsignal's elliptic-curve public key format and then base64-encoded. The public key, serialized in libsignal's elliptic-curve public key format and then base64-encoded.
description: "A list of unsigned elliptic-curve prekeys to use for this device.\ description: |
\ If present and not empty, replaces all stored unsigned EC prekeys for the\ A list of unsigned elliptic-curve prekeys to use for this device. If present and not empty, replaces all stored
\ device; if absent or empty, any stored unsigned EC prekeys for the device\ unsigned EC prekeys for the device; if absent or empty, any stored unsigned EC prekeys for the device are not
\ are not deleted." deleted.
PreKeyResponse: PreKeyResponse:
type: object type: object
properties: properties:
@ -3843,36 +3824,29 @@ components:
description: the number of stored one-time post-quantum prekeys for this description: the number of stored one-time post-quantum prekeys for this
device device
format: int32 format: int32
PreKeyState: SetKeysRequest:
required:
- identityKey
type: object type: object
properties: properties:
preKeys: preKeys:
type: array type: array
description: "A list of unsigned elliptic-curve prekeys to use for this\ description: |
\ device. If present and not empty, replaces all stored unsigned EC prekeys\ A list of unsigned elliptic-curve prekeys to use for this device. If present and not empty, replaces all stored
\ for the device; if absent or empty, any stored unsigned EC prekeys for\ unsigned EC prekeys for the device; if absent or empty, any stored unsigned EC prekeys for the device are not
\ the device are not deleted." deleted.
items: items:
$ref: '#/components/schemas/ECPreKey' $ref: '#/components/schemas/ECPreKey'
signedPreKey: signedPreKey:
$ref: '#/components/schemas/ECSignedPreKey' $ref: '#/components/schemas/ECSignedPreKey'
pqPreKeys: pqPreKeys:
type: array type: array
description: "A list of signed post-quantum one-time prekeys to use for\ description: |
\ this device. Each key must have a valid signature from the identity\ A list of signed post-quantum one-time prekeys to use for this device. Each key must have a valid signature from
\ key in this request. If present and not empty, replaces all stored unsigned\ the identity key in this request. If present and not empty, replaces all stored unsigned PQ prekeys for the
\ PQ prekeys for the device; if absent or empty, any stored unsigned PQ\ device; if absent or empty, any stored unsigned PQ prekeys for the device are not deleted.
\ prekeys for the device are not deleted."
items: items:
$ref: '#/components/schemas/KEMSignedPreKey' $ref: '#/components/schemas/KEMSignedPreKey'
pqLastResortPreKey: pqLastResortPreKey:
$ref: '#/components/schemas/KEMSignedPreKey' $ref: '#/components/schemas/KEMSignedPreKey'
identityKey:
$ref: '#/components/schemas/IdentityKey'
signatureValidOnEachSignedKey:
type: boolean
SpamReport: SpamReport:
type: object type: object
properties: properties:
@ -3897,24 +3871,6 @@ components:
timestamp: timestamp:
type: integer type: integer
format: int64 format: int64
AccountMismatchedDevices:
type: object
properties:
uuid:
type: string
description: A service identifier is a tuple of a UUID and identity type
that identifies an account and identity within the Signal service.
devices:
$ref: '#/components/schemas/MismatchedDevices'
AccountStaleDevices:
type: object
properties:
uuid:
type: string
description: A service identifier is a tuple of a UUID and identity type
that identifies an account and identity within the Signal service.
devices:
$ref: '#/components/schemas/StaleDevices'
CombinedUnidentifiedSenderAccessKeys: CombinedUnidentifiedSenderAccessKeys:
type: object type: object
properties: properties: