Updating documentation
This commit is contained in:
Documentation Updater
parent
8347ca3201
commit
5d97bc9d20
|
|
@ -1477,15 +1477,15 @@ paths:
|
||||||
schema:
|
schema:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
done:
|
|
||||||
type: boolean
|
|
||||||
cancelled:
|
|
||||||
type: boolean
|
|
||||||
completedExceptionally:
|
completedExceptionally:
|
||||||
type: boolean
|
type: boolean
|
||||||
numberOfDependents:
|
numberOfDependents:
|
||||||
type: integer
|
type: integer
|
||||||
format: int32
|
format: int32
|
||||||
|
done:
|
||||||
|
type: boolean
|
||||||
|
cancelled:
|
||||||
|
type: boolean
|
||||||
security:
|
security:
|
||||||
- authenticatedAccount: []
|
- authenticatedAccount: []
|
||||||
/v1/messages/uuid/{uuid}:
|
/v1/messages/uuid/{uuid}:
|
||||||
|
|
@ -2101,15 +2101,15 @@ paths:
|
||||||
schema:
|
schema:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
done:
|
|
||||||
type: boolean
|
|
||||||
cancelled:
|
|
||||||
type: boolean
|
|
||||||
completedExceptionally:
|
completedExceptionally:
|
||||||
type: boolean
|
type: boolean
|
||||||
numberOfDependents:
|
numberOfDependents:
|
||||||
type: integer
|
type: integer
|
||||||
format: int32
|
format: int32
|
||||||
|
done:
|
||||||
|
type: boolean
|
||||||
|
cancelled:
|
||||||
|
type: boolean
|
||||||
security:
|
security:
|
||||||
- authenticatedAccount: []
|
- authenticatedAccount: []
|
||||||
- {}
|
- {}
|
||||||
|
|
@ -2143,15 +2143,15 @@ paths:
|
||||||
schema:
|
schema:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
done:
|
|
||||||
type: boolean
|
|
||||||
cancelled:
|
|
||||||
type: boolean
|
|
||||||
completedExceptionally:
|
completedExceptionally:
|
||||||
type: boolean
|
type: boolean
|
||||||
numberOfDependents:
|
numberOfDependents:
|
||||||
type: integer
|
type: integer
|
||||||
format: int32
|
format: int32
|
||||||
|
done:
|
||||||
|
type: boolean
|
||||||
|
cancelled:
|
||||||
|
type: boolean
|
||||||
security:
|
security:
|
||||||
- authenticatedAccount: []
|
- authenticatedAccount: []
|
||||||
- {}
|
- {}
|
||||||
|
|
@ -2184,15 +2184,15 @@ paths:
|
||||||
schema:
|
schema:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
done:
|
|
||||||
type: boolean
|
|
||||||
cancelled:
|
|
||||||
type: boolean
|
|
||||||
completedExceptionally:
|
completedExceptionally:
|
||||||
type: boolean
|
type: boolean
|
||||||
numberOfDependents:
|
numberOfDependents:
|
||||||
type: integer
|
type: integer
|
||||||
format: int32
|
format: int32
|
||||||
|
done:
|
||||||
|
type: boolean
|
||||||
|
cancelled:
|
||||||
|
type: boolean
|
||||||
security:
|
security:
|
||||||
- authenticatedAccount: []
|
- authenticatedAccount: []
|
||||||
- {}
|
- {}
|
||||||
|
|
@ -2319,15 +2319,15 @@ paths:
|
||||||
schema:
|
schema:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
done:
|
|
||||||
type: boolean
|
|
||||||
cancelled:
|
|
||||||
type: boolean
|
|
||||||
completedExceptionally:
|
completedExceptionally:
|
||||||
type: boolean
|
type: boolean
|
||||||
numberOfDependents:
|
numberOfDependents:
|
||||||
type: integer
|
type: integer
|
||||||
format: int32
|
format: int32
|
||||||
|
done:
|
||||||
|
type: boolean
|
||||||
|
cancelled:
|
||||||
|
type: boolean
|
||||||
deprecated: true
|
deprecated: true
|
||||||
security:
|
security:
|
||||||
- authenticatedAccount: []
|
- authenticatedAccount: []
|
||||||
|
|
@ -2356,15 +2356,15 @@ paths:
|
||||||
schema:
|
schema:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
done:
|
|
||||||
type: boolean
|
|
||||||
cancelled:
|
|
||||||
type: boolean
|
|
||||||
completedExceptionally:
|
completedExceptionally:
|
||||||
type: boolean
|
type: boolean
|
||||||
numberOfDependents:
|
numberOfDependents:
|
||||||
type: integer
|
type: integer
|
||||||
format: int32
|
format: int32
|
||||||
|
done:
|
||||||
|
type: boolean
|
||||||
|
cancelled:
|
||||||
|
type: boolean
|
||||||
security:
|
security:
|
||||||
- authenticatedAccount: []
|
- authenticatedAccount: []
|
||||||
- {}
|
- {}
|
||||||
|
|
@ -2400,15 +2400,15 @@ paths:
|
||||||
schema:
|
schema:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
done:
|
|
||||||
type: boolean
|
|
||||||
cancelled:
|
|
||||||
type: boolean
|
|
||||||
completedExceptionally:
|
completedExceptionally:
|
||||||
type: boolean
|
type: boolean
|
||||||
numberOfDependents:
|
numberOfDependents:
|
||||||
type: integer
|
type: integer
|
||||||
format: int32
|
format: int32
|
||||||
|
done:
|
||||||
|
type: boolean
|
||||||
|
cancelled:
|
||||||
|
type: boolean
|
||||||
security:
|
security:
|
||||||
- authenticatedAccount: []
|
- authenticatedAccount: []
|
||||||
- {}
|
- {}
|
||||||
|
|
@ -2447,15 +2447,15 @@ paths:
|
||||||
schema:
|
schema:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
done:
|
|
||||||
type: boolean
|
|
||||||
cancelled:
|
|
||||||
type: boolean
|
|
||||||
completedExceptionally:
|
completedExceptionally:
|
||||||
type: boolean
|
type: boolean
|
||||||
numberOfDependents:
|
numberOfDependents:
|
||||||
type: integer
|
type: integer
|
||||||
format: int32
|
format: int32
|
||||||
|
done:
|
||||||
|
type: boolean
|
||||||
|
cancelled:
|
||||||
|
type: boolean
|
||||||
security:
|
security:
|
||||||
- authenticatedAccount: []
|
- authenticatedAccount: []
|
||||||
- {}
|
- {}
|
||||||
|
|
@ -2773,10 +2773,9 @@ components:
|
||||||
type: string
|
type: string
|
||||||
description: |
|
description: |
|
||||||
An APNs token set for the account's primary device. If provided, the account's primary
|
An APNs token set for the account's primary device. If provided, the account's primary
|
||||||
device will be notified of new messages via push notifications to the given token. If
|
device will be notified of new messages via push notifications to the given token.
|
||||||
creating an account "atomically," callers must provide exactly one of an APNs token
|
Callers must provide exactly one of an APNs token set, an FCM token, or an
|
||||||
set, an FCM token, or an `AccountAttributes` entity with `fetchesMessages` set to
|
`AccountAttributes` entity with `fetchesMessages` set to `true`.
|
||||||
`true`.
|
|
||||||
GcmRegistrationId:
|
GcmRegistrationId:
|
||||||
required:
|
required:
|
||||||
- gcmRegistrationId
|
- gcmRegistrationId
|
||||||
|
|
@ -2786,10 +2785,9 @@ components:
|
||||||
type: string
|
type: string
|
||||||
description: |
|
description: |
|
||||||
An FCM/GCM token for the account's primary device. If provided, the account's primary
|
An FCM/GCM token for the account's primary device. If provided, the account's primary
|
||||||
device will be notified of new messages via push notifications to the given token. If
|
device will be notified of new messages via push notifications to the given token.
|
||||||
creating an account "atomically," callers must provide exactly one of an APNs token
|
Callers must provide exactly one of an APNs token set, an FCM token, or an
|
||||||
set, an FCM token, or an `AccountAttributes` entity with `fetchesMessages` set to
|
`AccountAttributes` entity with `fetchesMessages` set to `true`.
|
||||||
`true`.
|
|
||||||
DeviceName:
|
DeviceName:
|
||||||
required:
|
required:
|
||||||
- deviceName
|
- deviceName
|
||||||
|
|
@ -2932,14 +2930,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:
|
||||||
|
|
@ -2958,9 +2956,7 @@ components:
|
||||||
description: |
|
description: |
|
||||||
The signature of the serialized `publicKey` with the account (or phone-number identity)'s identity key, base64-encoded.
|
The signature of the serialized `publicKey` with the account (or phone-number identity)'s identity key, base64-encoded.
|
||||||
description: |
|
description: |
|
||||||
A signed EC pre-key to be associated with this account's PNI. If provided, an account
|
A signed EC pre-key to be associated with this account's PNI.
|
||||||
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:
|
||||||
|
|
@ -2969,9 +2965,7 @@ components:
|
||||||
fingerprint:
|
fingerprint:
|
||||||
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.
|
||||||
provided, an account will be created "atomically," and all other properties needed for
|
|
||||||
atomic account creation must also be present.
|
|
||||||
IncomingMessage:
|
IncomingMessage:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
|
|
@ -3005,9 +2999,7 @@ components:
|
||||||
description: |
|
description: |
|
||||||
The signature of the serialized `publicKey` with the account (or phone-number identity)'s identity key, base64-encoded.
|
The signature of the serialized `publicKey` with the account (or phone-number identity)'s identity key, base64-encoded.
|
||||||
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.
|
||||||
provided, an account will be created "atomically," and all other properties needed for
|
|
||||||
atomic account creation must also be present.
|
|
||||||
PhoneNumberIdentityKeyDistributionRequest:
|
PhoneNumberIdentityKeyDistributionRequest:
|
||||||
required:
|
required:
|
||||||
- deviceMessages
|
- deviceMessages
|
||||||
|
|
@ -3416,6 +3408,11 @@ components:
|
||||||
password:
|
password:
|
||||||
type: string
|
type: string
|
||||||
DeviceActivationRequest:
|
DeviceActivationRequest:
|
||||||
|
required:
|
||||||
|
- aciPqLastResortPreKey
|
||||||
|
- aciSignedPreKey
|
||||||
|
- pniPqLastResortPreKey
|
||||||
|
- pniSignedPreKey
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
aciSignedPreKey:
|
aciSignedPreKey:
|
||||||
|
|
@ -3432,6 +3429,10 @@ components:
|
||||||
$ref: '#/components/schemas/GcmRegistrationId'
|
$ref: '#/components/schemas/GcmRegistrationId'
|
||||||
LinkDeviceRequest:
|
LinkDeviceRequest:
|
||||||
required:
|
required:
|
||||||
|
- aciPqLastResortPreKey
|
||||||
|
- aciSignedPreKey
|
||||||
|
- pniPqLastResortPreKey
|
||||||
|
- pniSignedPreKey
|
||||||
- verificationCode
|
- verificationCode
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
|
|
@ -3471,13 +3472,13 @@ components:
|
||||||
WebSocketClient:
|
WebSocketClient:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
|
createdTimestamp:
|
||||||
|
type: integer
|
||||||
|
format: int64
|
||||||
userAgent:
|
userAgent:
|
||||||
type: string
|
type: string
|
||||||
open:
|
open:
|
||||||
type: boolean
|
type: boolean
|
||||||
createdTimestamp:
|
|
||||||
type: integer
|
|
||||||
format: int64
|
|
||||||
WebSocketSessionContext:
|
WebSocketSessionContext:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
|
|
@ -3939,6 +3940,12 @@ components:
|
||||||
RegistrationRequest:
|
RegistrationRequest:
|
||||||
required:
|
required:
|
||||||
- accountAttributes
|
- accountAttributes
|
||||||
|
- aciIdentityKey
|
||||||
|
- aciPqLastResortPreKey
|
||||||
|
- aciSignedPreKey
|
||||||
|
- pniIdentityKey
|
||||||
|
- pniPqLastResortPreKey
|
||||||
|
- pniSignedPreKey
|
||||||
- skipDeviceTransfer
|
- skipDeviceTransfer
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
|
|
@ -3970,12 +3977,6 @@ components:
|
||||||
false and if a device transfer is technically possible, the registration request will
|
false and if a device transfer is technically possible, the registration request will
|
||||||
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.
|
||||||
requireAtomic:
|
|
||||||
type: boolean
|
|
||||||
description: |
|
|
||||||
If true, indicates that this is a request for "atomic" registration. If any properties
|
|
||||||
needed for atomic account creation are not present, the request will fail. If false,
|
|
||||||
atomic account creation can still occur, but only if all required fields are present.
|
|
||||||
aciIdentityKey:
|
aciIdentityKey:
|
||||||
$ref: '#/components/schemas/IdentityKey'
|
$ref: '#/components/schemas/IdentityKey'
|
||||||
pniIdentityKey:
|
pniIdentityKey:
|
||||||
|
|
@ -3994,8 +3995,6 @@ components:
|
||||||
$ref: '#/components/schemas/GcmRegistrationId'
|
$ref: '#/components/schemas/GcmRegistrationId'
|
||||||
everySignedKeyValid:
|
everySignedKeyValid:
|
||||||
type: boolean
|
type: boolean
|
||||||
completeRequest:
|
|
||||||
type: boolean
|
|
||||||
valid:
|
valid:
|
||||||
type: boolean
|
type: boolean
|
||||||
UserRemoteConfig:
|
UserRemoteConfig:
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue