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-05-26 22:52:40 +00:00
parent 2e67c13fe3
commit 431d6d6f59
1 changed files with 67 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

57
signal-server-openapi.yaml
View File

@ -2493,9 +2493,14 @@ components:
type: string type: string
description: the registration verification code to authenticate this request description: the registration verification code to authenticate this request
pniIdentityKey: pniIdentityKey:
type: array
description: the new public identity key to use for the phone-number identity
associated with the new phone number
items:
type: string type: string
description: the new public identity key to use for the phone-number identity description: the new public identity key to use for the phone-number identity
associated with the new phone number associated with the new phone number
format: byte
deviceMessages: deviceMessages:
type: array type: array
description: |- description: |-
@ -2557,9 +2562,15 @@ components:
type: integer type: integer
format: int64 format: int64
publicKey: publicKey:
type: array
items:
type: string type: string
format: byte
signature: signature:
type: array
items:
type: string type: string
format: byte
description: | description: |
A signed Kyber-1024 "last resort" pre-key to be associated with this account's PNI. If A signed Kyber-1024 "last resort" pre-key to be associated with this account's PNI. If
provided, an account will be created "atomically," and all other properties needed for provided, an account will be created "atomically," and all other properties needed for
@ -2829,9 +2840,14 @@ components:
type: string type: string
description: the new phone number for this account description: the new phone number for this account
pniIdentityKey: pniIdentityKey:
type: array
description: the new public identity key to use for the phone-number identity
associated with the new phone number
items:
type: string type: string
description: the new public identity key to use for the phone-number identity description: the new public identity key to use for the phone-number identity
associated with the new phone number associated with the new phone number
format: byte
deviceMessages: deviceMessages:
type: array type: array
description: |- description: |-
@ -2879,8 +2895,12 @@ components:
type: object type: object
properties: properties:
pniIdentityKey: pniIdentityKey:
type: array
description: the new identity key for this account's phone-number identity
items:
type: string type: string
description: the new identity key for this account's phone-number identity description: the new identity key for this account's phone-number identity
format: byte
deviceMessages: deviceMessages:
type: array type: array
description: |- description: |-
@ -3217,11 +3237,11 @@ components:
properties: properties:
open: open:
type: boolean type: boolean
userAgent:
type: string
createdTimestamp: createdTimestamp:
type: integer type: integer
format: int64 format: int64
userAgent:
type: string
WebSocketSessionContext: WebSocketSessionContext:
type: object type: object
properties: properties:
@ -3260,7 +3280,10 @@ components:
type: integer type: integer
format: int64 format: int64
publicKey: publicKey:
type: array
items:
type: string type: string
format: byte
description: "A list of unsigned elliptic-curve prekeys to use for this device.\ description: "A list of unsigned elliptic-curve prekeys to use for this device.\
\ If present and not empty, replaces all stored unsigned EC prekeys for the\ \ If present and not empty, replaces all stored unsigned EC prekeys for the\
\ device; if absent or empty, any stored unsigned EC prekeys for the device\ \ device; if absent or empty, any stored unsigned EC prekeys for the device\
@ -3292,11 +3315,18 @@ components:
pqLastResortPreKey: pqLastResortPreKey:
$ref: '#/components/schemas/SignedPreKey' $ref: '#/components/schemas/SignedPreKey'
identityKey: identityKey:
type: array
description: "Required. The public identity key for this identity (account\
\ or phone-number identity). If this device is not the primary device\
\ for the account, must match the existing stored identity key for this\
\ identity."
items:
type: string type: string
description: "Required. The public identity key for this identity (account\ description: "Required. The public identity key for this identity (account\
\ or phone-number identity). If this device is not the primary device\ \ or phone-number identity). If this device is not the primary device\
\ for the account, must match the existing stored identity key for this\ \ for the account, must match the existing stored identity key for this\
\ identity." \ identity."
format: byte
signatureValidOnEachSignedKey: signatureValidOnEachSignedKey:
type: boolean type: boolean
SpamReport: SpamReport:
@ -3431,7 +3461,10 @@ components:
type: object type: object
properties: properties:
identityKey: identityKey:
type: array
items:
type: string type: string
format: byte
unidentifiedAccess: unidentifiedAccess:
type: string type: string
unrestrictedUnidentifiedAccess: unrestrictedUnidentifiedAccess:
@ -3468,7 +3501,10 @@ components:
type: object type: object
properties: properties:
identityKey: identityKey:
type: array
items:
type: string type: string
format: byte
unidentifiedAccess: unidentifiedAccess:
type: string type: string
unrestrictedUnidentifiedAccess: unrestrictedUnidentifiedAccess:
@ -3496,7 +3532,10 @@ components:
type: object type: object
properties: properties:
identityKey: identityKey:
type: array
items:
type: string type: string
format: byte
unidentifiedAccess: unidentifiedAccess:
type: string type: string
unrestrictedUnidentifiedAccess: unrestrictedUnidentifiedAccess:
@ -3633,17 +3672,31 @@ components:
fail with an HTTP/409 response indicating that the client should prompt the user to fail with an HTTP/409 response indicating that the client should prompt the user to
transfer data from an existing device. transfer data from an existing device.
aciIdentityKey: aciIdentityKey:
type: array
description: |
The ACI-associated identity key for the account, encoded as a base64 string. If
provided, an account will be created "atomically," and all other properties needed for
atomic account creation must also be present.
items:
type: string type: string
description: | description: |
The ACI-associated identity key for the account, encoded as a base64 string. If The ACI-associated identity key for the account, encoded as a base64 string. If
provided, an account will be created "atomically," and all other properties needed for provided, an account will be created "atomically," and all other properties needed for
atomic account creation must also be present. atomic account creation must also be present.
format: byte
pniIdentityKey: pniIdentityKey:
type: array
description: |
The PNI-associated identity key for the account, encoded as a base64 string. If
provided, an account will be created "atomically," and all other properties needed for
atomic account creation must also be present.
items:
type: string type: string
description: | description: |
The PNI-associated identity key for the account, encoded as a base64 string. If The PNI-associated identity key for the account, encoded as a base64 string. If
provided, an account will be created "atomically," and all other properties needed for provided, an account will be created "atomically," and all other properties needed for
atomic account creation must also be present. atomic account creation must also be present.
format: byte
aciSignedPreKey: aciSignedPreKey:
$ref: '#/components/schemas/SignedPreKey' $ref: '#/components/schemas/SignedPreKey'
pniSignedPreKey: pniSignedPreKey: