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-06-09 15:32:43 +00:00
parent 19854af8d8
commit 41b02d4e90
1 changed files with 47 additions and 41 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

88
signal-server-openapi.yaml
View File

@ -1158,7 +1158,7 @@ paths:
content: content:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/SignedPreKey' $ref: '#/components/schemas/ECSignedPreKey'
security: security:
- authenticatedAccount: [] - authenticatedAccount: []
put: put:
@ -1174,7 +1174,7 @@ paths:
content: content:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/SignedPreKey' $ref: '#/components/schemas/ECSignedPreKey'
responses: responses:
default: default:
description: default response description: default response
@ -2613,14 +2613,14 @@ components:
devicePniSignedPrekeys: devicePniSignedPrekeys:
type: object type: object
additionalProperties: additionalProperties:
$ref: '#/components/schemas/SignedPreKey' $ref: '#/components/schemas/ECSignedPreKey'
description: |- description: |-
A new signed elliptic-curve prekey for each enabled device on the account, including this one. A new signed elliptic-curve prekey for each enabled device on the account, including this one.
Each must be accompanied by a valid signature from the new identity key in this request. Each must be accompanied by a valid signature from the new identity key in this request.
devicePniPqLastResortPrekeys: devicePniPqLastResortPrekeys:
type: object type: object
additionalProperties: additionalProperties:
$ref: '#/components/schemas/SignedPreKey' $ref: '#/components/schemas/KEMSignedPreKey'
description: |- description: |-
A new signed post-quantum last-resort prekey for each enabled device on the account, including this one. A new signed post-quantum last-resort prekey for each enabled device on the account, including this one.
May be absent, in which case the last resort PQ prekeys for each device will be deleted if any had been stored. May be absent, in which case the last resort PQ prekeys for each device will be deleted if any had been stored.
@ -2649,6 +2649,23 @@ components:
items: items:
type: string type: string
format: byte format: byte
ECSignedPreKey:
type: object
properties:
keyId:
type: integer
format: int64
publicKey:
$ref: '#/components/schemas/ECPublicKey'
signature:
type: array
items:
type: string
format: byte
description: |
A signed EC pre-key to be associated with this account's PNI. If provided, an account
will be created "atomically," and all other properties needed for atomic account
creation must also be present.
IdentityKey: IdentityKey:
type: object type: object
properties: properties:
@ -2674,21 +2691,16 @@ components:
format: int32 format: int32
content: content:
type: string type: string
SignedPreKey: KEMPublicKey:
required: type: object
- keyId KEMSignedPreKey:
- publicKey
- signature
type: object type: object
properties: properties:
keyId: keyId:
type: integer type: integer
format: int64 format: int64
publicKey: publicKey:
type: array $ref: '#/components/schemas/KEMPublicKey'
items:
type: string
format: byte
signature: signature:
type: array type: array
items: items:
@ -2995,14 +3007,14 @@ components:
devicePniSignedPrekeys: devicePniSignedPrekeys:
type: object type: object
additionalProperties: additionalProperties:
$ref: '#/components/schemas/SignedPreKey' $ref: '#/components/schemas/ECSignedPreKey'
description: |- description: |-
A new signed elliptic-curve prekey for each enabled device on the account, including this one. A new signed elliptic-curve prekey for each enabled device on the account, including this one.
Each must be accompanied by a valid signature from the new identity key in this request. Each must be accompanied by a valid signature from the new identity key in this request.
devicePniPqLastResortPrekeys: devicePniPqLastResortPrekeys:
type: object type: object
additionalProperties: additionalProperties:
$ref: '#/components/schemas/SignedPreKey' $ref: '#/components/schemas/KEMSignedPreKey'
description: |- description: |-
A new signed post-quantum last-resort prekey for each enabled device on the account, including this one. A new signed post-quantum last-resort prekey for each enabled device on the account, including this one.
May be absent, in which case the last resort PQ prekeys for each device will be deleted if any had been stored. May be absent, in which case the last resort PQ prekeys for each device will be deleted if any had been stored.
@ -3043,14 +3055,14 @@ components:
devicePniSignedPrekeys: devicePniSignedPrekeys:
type: object type: object
additionalProperties: additionalProperties:
$ref: '#/components/schemas/SignedPreKey' $ref: '#/components/schemas/ECSignedPreKey'
description: |- description: |-
A new signed elliptic-curve prekey for each enabled device on the account, including this one. A new signed elliptic-curve prekey for each enabled device on the account, including this one.
Each must be accompanied by a valid signature from the new identity key in this request. Each must be accompanied by a valid signature from the new identity key in this request.
devicePniPqLastResortPrekeys: devicePniPqLastResortPrekeys:
type: object type: object
additionalProperties: additionalProperties:
$ref: '#/components/schemas/SignedPreKey' $ref: '#/components/schemas/KEMSignedPreKey'
description: |- description: |-
A new signed post-quantum last-resort prekey for each enabled device on the account, including this one. A new signed post-quantum last-resort prekey for each enabled device on the account, including this one.
May be absent, in which case the last resort PQ prekeys for each device will be deleted if any had been stored. May be absent, in which case the last resort PQ prekeys for each device will be deleted if any had been stored.
@ -3314,13 +3326,13 @@ components:
type: object type: object
properties: properties:
aciSignedPreKey: aciSignedPreKey:
$ref: '#/components/schemas/SignedPreKey' $ref: '#/components/schemas/ECSignedPreKey'
pniSignedPreKey: pniSignedPreKey:
$ref: '#/components/schemas/SignedPreKey' $ref: '#/components/schemas/ECSignedPreKey'
aciPqLastResortPreKey: aciPqLastResortPreKey:
$ref: '#/components/schemas/SignedPreKey' $ref: '#/components/schemas/KEMSignedPreKey'
pniPqLastResortPreKey: pniPqLastResortPreKey:
$ref: '#/components/schemas/SignedPreKey' $ref: '#/components/schemas/KEMSignedPreKey'
apnToken: apnToken:
$ref: '#/components/schemas/ApnRegistrationId' $ref: '#/components/schemas/ApnRegistrationId'
gcmToken: gcmToken:
@ -3338,13 +3350,13 @@ components:
accountAttributes: accountAttributes:
$ref: '#/components/schemas/AccountAttributes' $ref: '#/components/schemas/AccountAttributes'
aciSignedPreKey: aciSignedPreKey:
$ref: '#/components/schemas/SignedPreKey' $ref: '#/components/schemas/ECSignedPreKey'
pniSignedPreKey: pniSignedPreKey:
$ref: '#/components/schemas/SignedPreKey' $ref: '#/components/schemas/ECSignedPreKey'
aciPqLastResortPreKey: aciPqLastResortPreKey:
$ref: '#/components/schemas/SignedPreKey' $ref: '#/components/schemas/KEMSignedPreKey'
pniPqLastResortPreKey: pniPqLastResortPreKey:
$ref: '#/components/schemas/SignedPreKey' $ref: '#/components/schemas/KEMSignedPreKey'
apnToken: apnToken:
$ref: '#/components/schemas/ApnRegistrationId' $ref: '#/components/schemas/ApnRegistrationId'
gcmToken: gcmToken:
@ -3401,20 +3413,14 @@ 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
PreKey: ECPreKey:
required:
- keyId
- publicKey
type: object type: object
properties: properties:
keyId: keyId:
type: integer type: integer
format: int64 format: int64
publicKey: publicKey:
type: array $ref: '#/components/schemas/ECPublicKey'
items:
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\
@ -3431,9 +3437,9 @@ components:
\ for the device; if absent or empty, any stored unsigned EC prekeys for\ \ for the device; if absent or empty, any stored unsigned EC prekeys for\
\ the device are not deleted." \ the device are not deleted."
items: items:
$ref: '#/components/schemas/PreKey' $ref: '#/components/schemas/ECPreKey'
signedPreKey: signedPreKey:
$ref: '#/components/schemas/SignedPreKey' $ref: '#/components/schemas/ECSignedPreKey'
pqPreKeys: pqPreKeys:
type: array type: array
description: "A list of signed post-quantum one-time prekeys to use for\ description: "A list of signed post-quantum one-time prekeys to use for\
@ -3442,9 +3448,9 @@ components:
\ PQ prekeys for the device; if absent or empty, any stored unsigned PQ\ \ PQ prekeys for the 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/SignedPreKey' $ref: '#/components/schemas/KEMSignedPreKey'
pqLastResortPreKey: pqLastResortPreKey:
$ref: '#/components/schemas/SignedPreKey' $ref: '#/components/schemas/KEMSignedPreKey'
identityKey: identityKey:
$ref: '#/components/schemas/IdentityKey' $ref: '#/components/schemas/IdentityKey'
signatureValidOnEachSignedKey: signatureValidOnEachSignedKey:
@ -3787,13 +3793,13 @@ components:
pniIdentityKey: pniIdentityKey:
$ref: '#/components/schemas/IdentityKey' $ref: '#/components/schemas/IdentityKey'
aciSignedPreKey: aciSignedPreKey:
$ref: '#/components/schemas/SignedPreKey' $ref: '#/components/schemas/ECSignedPreKey'
pniSignedPreKey: pniSignedPreKey:
$ref: '#/components/schemas/SignedPreKey' $ref: '#/components/schemas/ECSignedPreKey'
aciPqLastResortPreKey: aciPqLastResortPreKey:
$ref: '#/components/schemas/SignedPreKey' $ref: '#/components/schemas/KEMSignedPreKey'
pniPqLastResortPreKey: pniPqLastResortPreKey:
$ref: '#/components/schemas/SignedPreKey' $ref: '#/components/schemas/KEMSignedPreKey'
apnToken: apnToken:
$ref: '#/components/schemas/ApnRegistrationId' $ref: '#/components/schemas/ApnRegistrationId'
gcmToken: gcmToken: