Updating documentation
This commit is contained in:
Documentation Updater
parent
8f2f872113
commit
fdca7ea9f1
|
|
@ -60,17 +60,7 @@ paths:
|
||||||
content:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
type: object
|
$ref: '#/components/schemas/UsernameHashResponse'
|
||||||
properties:
|
|
||||||
completedExceptionally:
|
|
||||||
type: boolean
|
|
||||||
numberOfDependents:
|
|
||||||
type: integer
|
|
||||||
format: int32
|
|
||||||
cancelled:
|
|
||||||
type: boolean
|
|
||||||
done:
|
|
||||||
type: boolean
|
|
||||||
"401":
|
"401":
|
||||||
description: Account authentication check failed.
|
description: Account authentication check failed.
|
||||||
"409":
|
"409":
|
||||||
|
|
@ -109,16 +99,6 @@ paths:
|
||||||
'*/*':
|
'*/*':
|
||||||
schema:
|
schema:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
|
||||||
completedExceptionally:
|
|
||||||
type: boolean
|
|
||||||
numberOfDependents:
|
|
||||||
type: integer
|
|
||||||
format: int32
|
|
||||||
cancelled:
|
|
||||||
type: boolean
|
|
||||||
done:
|
|
||||||
type: boolean
|
|
||||||
security:
|
security:
|
||||||
- authenticatedAccount: []
|
- authenticatedAccount: []
|
||||||
/v1/accounts/apn:
|
/v1/accounts/apn:
|
||||||
|
|
@ -194,16 +174,6 @@ paths:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
|
||||||
completedExceptionally:
|
|
||||||
type: boolean
|
|
||||||
numberOfDependents:
|
|
||||||
type: integer
|
|
||||||
format: int32
|
|
||||||
cancelled:
|
|
||||||
type: boolean
|
|
||||||
done:
|
|
||||||
type: boolean
|
|
||||||
"401":
|
"401":
|
||||||
description: Account authentication check failed.
|
description: Account authentication check failed.
|
||||||
security:
|
security:
|
||||||
|
|
@ -293,17 +263,7 @@ paths:
|
||||||
content:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
type: object
|
$ref: '#/components/schemas/AccountIdentifierResponse'
|
||||||
properties:
|
|
||||||
completedExceptionally:
|
|
||||||
type: boolean
|
|
||||||
numberOfDependents:
|
|
||||||
type: integer
|
|
||||||
format: int32
|
|
||||||
cancelled:
|
|
||||||
type: boolean
|
|
||||||
done:
|
|
||||||
type: boolean
|
|
||||||
"400":
|
"400":
|
||||||
description: Request must not be authenticated.
|
description: Request must not be authenticated.
|
||||||
"404":
|
"404":
|
||||||
|
|
@ -333,17 +293,7 @@ paths:
|
||||||
content:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
type: object
|
$ref: '#/components/schemas/EncryptedUsername'
|
||||||
properties:
|
|
||||||
completedExceptionally:
|
|
||||||
type: boolean
|
|
||||||
numberOfDependents:
|
|
||||||
type: integer
|
|
||||||
format: int32
|
|
||||||
cancelled:
|
|
||||||
type: boolean
|
|
||||||
done:
|
|
||||||
type: boolean
|
|
||||||
"400":
|
"400":
|
||||||
description: Request must not be authenticated.
|
description: Request must not be authenticated.
|
||||||
"404":
|
"404":
|
||||||
|
|
@ -405,17 +355,7 @@ paths:
|
||||||
content:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
type: object
|
$ref: '#/components/schemas/ReserveUsernameHashResponse'
|
||||||
properties:
|
|
||||||
completedExceptionally:
|
|
||||||
type: boolean
|
|
||||||
numberOfDependents:
|
|
||||||
type: integer
|
|
||||||
format: int32
|
|
||||||
cancelled:
|
|
||||||
type: boolean
|
|
||||||
done:
|
|
||||||
type: boolean
|
|
||||||
"401":
|
"401":
|
||||||
description: Account authentication check failed.
|
description: Account authentication check failed.
|
||||||
"409":
|
"409":
|
||||||
|
|
@ -1058,12 +998,8 @@ paths:
|
||||||
default:
|
default:
|
||||||
description: default response
|
description: default response
|
||||||
content:
|
content:
|
||||||
application/json:
|
application/json: {}
|
||||||
schema:
|
text/plain: {}
|
||||||
type: object
|
|
||||||
text/plain:
|
|
||||||
schema:
|
|
||||||
type: object
|
|
||||||
security:
|
security:
|
||||||
- authenticatedAccount: []
|
- authenticatedAccount: []
|
||||||
/v1/keepalive:
|
/v1/keepalive:
|
||||||
|
|
@ -1175,17 +1111,7 @@ paths:
|
||||||
content:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
type: object
|
$ref: '#/components/schemas/PreKeyCount'
|
||||||
properties:
|
|
||||||
completedExceptionally:
|
|
||||||
type: boolean
|
|
||||||
numberOfDependents:
|
|
||||||
type: integer
|
|
||||||
format: int32
|
|
||||||
cancelled:
|
|
||||||
type: boolean
|
|
||||||
done:
|
|
||||||
type: boolean
|
|
||||||
"401":
|
"401":
|
||||||
description: Account authentication check failed.
|
description: Account authentication check failed.
|
||||||
security:
|
security:
|
||||||
|
|
@ -1304,16 +1230,6 @@ paths:
|
||||||
'*/*':
|
'*/*':
|
||||||
schema:
|
schema:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
|
||||||
completedExceptionally:
|
|
||||||
type: boolean
|
|
||||||
numberOfDependents:
|
|
||||||
type: integer
|
|
||||||
format: int32
|
|
||||||
cancelled:
|
|
||||||
type: boolean
|
|
||||||
done:
|
|
||||||
type: boolean
|
|
||||||
security:
|
security:
|
||||||
- authenticatedAccount: []
|
- authenticatedAccount: []
|
||||||
/v1/messages/report/{source}/{messageGuid}:
|
/v1/messages/report/{source}/{messageGuid}:
|
||||||
|
|
@ -1584,17 +1500,7 @@ paths:
|
||||||
content:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
type: object
|
$ref: '#/components/schemas/BatchIdentityCheckResponse'
|
||||||
properties:
|
|
||||||
completedExceptionally:
|
|
||||||
type: boolean
|
|
||||||
numberOfDependents:
|
|
||||||
type: integer
|
|
||||||
format: int32
|
|
||||||
cancelled:
|
|
||||||
type: boolean
|
|
||||||
done:
|
|
||||||
type: boolean
|
|
||||||
/v1/profile:
|
/v1/profile:
|
||||||
put:
|
put:
|
||||||
tags:
|
tags:
|
||||||
|
|
@ -1849,19 +1755,7 @@ paths:
|
||||||
default:
|
default:
|
||||||
description: default response
|
description: default response
|
||||||
content:
|
content:
|
||||||
application/json:
|
application/json: {}
|
||||||
schema:
|
|
||||||
type: object
|
|
||||||
properties:
|
|
||||||
completedExceptionally:
|
|
||||||
type: boolean
|
|
||||||
numberOfDependents:
|
|
||||||
type: integer
|
|
||||||
format: int32
|
|
||||||
cancelled:
|
|
||||||
type: boolean
|
|
||||||
done:
|
|
||||||
type: boolean
|
|
||||||
/v1/subscription/boost/create:
|
/v1/subscription/boost/create:
|
||||||
post:
|
post:
|
||||||
tags:
|
tags:
|
||||||
|
|
@ -1877,19 +1771,7 @@ paths:
|
||||||
default:
|
default:
|
||||||
description: default response
|
description: default response
|
||||||
content:
|
content:
|
||||||
application/json:
|
application/json: {}
|
||||||
schema:
|
|
||||||
type: object
|
|
||||||
properties:
|
|
||||||
completedExceptionally:
|
|
||||||
type: boolean
|
|
||||||
numberOfDependents:
|
|
||||||
type: integer
|
|
||||||
format: int32
|
|
||||||
cancelled:
|
|
||||||
type: boolean
|
|
||||||
done:
|
|
||||||
type: boolean
|
|
||||||
/v1/subscription/boost/receipt_credentials:
|
/v1/subscription/boost/receipt_credentials:
|
||||||
post:
|
post:
|
||||||
tags:
|
tags:
|
||||||
|
|
@ -1910,19 +1792,7 @@ paths:
|
||||||
default:
|
default:
|
||||||
description: default response
|
description: default response
|
||||||
content:
|
content:
|
||||||
application/json:
|
application/json: {}
|
||||||
schema:
|
|
||||||
type: object
|
|
||||||
properties:
|
|
||||||
completedExceptionally:
|
|
||||||
type: boolean
|
|
||||||
numberOfDependents:
|
|
||||||
type: integer
|
|
||||||
format: int32
|
|
||||||
cancelled:
|
|
||||||
type: boolean
|
|
||||||
done:
|
|
||||||
type: boolean
|
|
||||||
/v1/subscription/boost/paypal/create:
|
/v1/subscription/boost/paypal/create:
|
||||||
post:
|
post:
|
||||||
tags:
|
tags:
|
||||||
|
|
@ -1938,19 +1808,7 @@ paths:
|
||||||
default:
|
default:
|
||||||
description: default response
|
description: default response
|
||||||
content:
|
content:
|
||||||
application/json:
|
application/json: {}
|
||||||
schema:
|
|
||||||
type: object
|
|
||||||
properties:
|
|
||||||
completedExceptionally:
|
|
||||||
type: boolean
|
|
||||||
numberOfDependents:
|
|
||||||
type: integer
|
|
||||||
format: int32
|
|
||||||
cancelled:
|
|
||||||
type: boolean
|
|
||||||
done:
|
|
||||||
type: boolean
|
|
||||||
/v1/subscription/{subscriberId}/create_payment_method/paypal:
|
/v1/subscription/{subscriberId}/create_payment_method/paypal:
|
||||||
post:
|
post:
|
||||||
tags:
|
tags:
|
||||||
|
|
@ -2086,19 +1944,7 @@ paths:
|
||||||
default:
|
default:
|
||||||
description: default response
|
description: default response
|
||||||
content:
|
content:
|
||||||
application/json:
|
application/json: {}
|
||||||
schema:
|
|
||||||
type: object
|
|
||||||
properties:
|
|
||||||
completedExceptionally:
|
|
||||||
type: boolean
|
|
||||||
numberOfDependents:
|
|
||||||
type: integer
|
|
||||||
format: int32
|
|
||||||
cancelled:
|
|
||||||
type: boolean
|
|
||||||
done:
|
|
||||||
type: boolean
|
|
||||||
security:
|
security:
|
||||||
- authenticatedAccount: []
|
- authenticatedAccount: []
|
||||||
- {}
|
- {}
|
||||||
|
|
@ -2116,19 +1962,7 @@ paths:
|
||||||
default:
|
default:
|
||||||
description: default response
|
description: default response
|
||||||
content:
|
content:
|
||||||
application/json:
|
application/json: {}
|
||||||
schema:
|
|
||||||
type: object
|
|
||||||
properties:
|
|
||||||
completedExceptionally:
|
|
||||||
type: boolean
|
|
||||||
numberOfDependents:
|
|
||||||
type: integer
|
|
||||||
format: int32
|
|
||||||
cancelled:
|
|
||||||
type: boolean
|
|
||||||
done:
|
|
||||||
type: boolean
|
|
||||||
security:
|
security:
|
||||||
- authenticatedAccount: []
|
- authenticatedAccount: []
|
||||||
- {}
|
- {}
|
||||||
|
|
@ -2146,19 +1980,7 @@ paths:
|
||||||
default:
|
default:
|
||||||
description: default response
|
description: default response
|
||||||
content:
|
content:
|
||||||
application/json:
|
application/json: {}
|
||||||
schema:
|
|
||||||
type: object
|
|
||||||
properties:
|
|
||||||
completedExceptionally:
|
|
||||||
type: boolean
|
|
||||||
numberOfDependents:
|
|
||||||
type: integer
|
|
||||||
format: int32
|
|
||||||
cancelled:
|
|
||||||
type: boolean
|
|
||||||
done:
|
|
||||||
type: boolean
|
|
||||||
security:
|
security:
|
||||||
- authenticatedAccount: []
|
- authenticatedAccount: []
|
||||||
- {}
|
- {}
|
||||||
|
|
@ -2179,19 +2001,7 @@ paths:
|
||||||
default:
|
default:
|
||||||
description: default response
|
description: default response
|
||||||
content:
|
content:
|
||||||
application/json:
|
application/json: {}
|
||||||
schema:
|
|
||||||
type: object
|
|
||||||
properties:
|
|
||||||
completedExceptionally:
|
|
||||||
type: boolean
|
|
||||||
numberOfDependents:
|
|
||||||
type: integer
|
|
||||||
format: int32
|
|
||||||
cancelled:
|
|
||||||
type: boolean
|
|
||||||
done:
|
|
||||||
type: boolean
|
|
||||||
/v1/subscription/boost/badges:
|
/v1/subscription/boost/badges:
|
||||||
get:
|
get:
|
||||||
tags:
|
tags:
|
||||||
|
|
@ -2201,19 +2011,7 @@ paths:
|
||||||
default:
|
default:
|
||||||
description: default response
|
description: default response
|
||||||
content:
|
content:
|
||||||
application/json:
|
application/json: {}
|
||||||
schema:
|
|
||||||
type: object
|
|
||||||
properties:
|
|
||||||
completedExceptionally:
|
|
||||||
type: boolean
|
|
||||||
numberOfDependents:
|
|
||||||
type: integer
|
|
||||||
format: int32
|
|
||||||
cancelled:
|
|
||||||
type: boolean
|
|
||||||
done:
|
|
||||||
type: boolean
|
|
||||||
deprecated: true
|
deprecated: true
|
||||||
/v1/subscription/configuration:
|
/v1/subscription/configuration:
|
||||||
get:
|
get:
|
||||||
|
|
@ -2229,19 +2027,7 @@ paths:
|
||||||
default:
|
default:
|
||||||
description: default response
|
description: default response
|
||||||
content:
|
content:
|
||||||
application/json:
|
application/json: {}
|
||||||
schema:
|
|
||||||
type: object
|
|
||||||
properties:
|
|
||||||
completedExceptionally:
|
|
||||||
type: boolean
|
|
||||||
numberOfDependents:
|
|
||||||
type: integer
|
|
||||||
format: int32
|
|
||||||
cancelled:
|
|
||||||
type: boolean
|
|
||||||
done:
|
|
||||||
type: boolean
|
|
||||||
/v1/subscription/{subscriberId}/default_payment_method/{paymentMethodId}:
|
/v1/subscription/{subscriberId}/default_payment_method/{paymentMethodId}:
|
||||||
post:
|
post:
|
||||||
tags:
|
tags:
|
||||||
|
|
@ -2549,6 +2335,16 @@ components:
|
||||||
type: object
|
type: object
|
||||||
description: A service identifier is a tuple of a UUID and identity type that
|
description: A service identifier is a tuple of a UUID and identity type that
|
||||||
identifies an account and identity within the Signal service.
|
identifies an account and identity within the Signal service.
|
||||||
|
UsernameHashResponse:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
usernameHash:
|
||||||
|
type: string
|
||||||
|
description: "The hash of the confirmed username, as supplied in the request"
|
||||||
|
usernameLinkHandle:
|
||||||
|
type: string
|
||||||
|
description: A handle that can be included in username links to retrieve
|
||||||
|
the stored encrypted username
|
||||||
ConfirmUsernameHashRequest:
|
ConfirmUsernameHashRequest:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
|
|
@ -2603,6 +2399,32 @@ components:
|
||||||
type: array
|
type: array
|
||||||
items:
|
items:
|
||||||
type: string
|
type: string
|
||||||
|
AccountIdentifierResponse:
|
||||||
|
required:
|
||||||
|
- uuid
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
uuid:
|
||||||
|
type: string
|
||||||
|
description: An identifier for an account based on the account's ACI
|
||||||
|
EncryptedUsername:
|
||||||
|
required:
|
||||||
|
- usernameLinkEncryptedValue
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
usernameLinkEncryptedValue:
|
||||||
|
maxLength: 128
|
||||||
|
minLength: 1
|
||||||
|
type: string
|
||||||
|
description: the URL-safe base64 encoding of the encrypted username
|
||||||
|
ReserveUsernameHashResponse:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
usernameHash:
|
||||||
|
type: array
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
|
format: byte
|
||||||
ReserveUsernameHashRequest:
|
ReserveUsernameHashRequest:
|
||||||
required:
|
required:
|
||||||
- usernameHashes
|
- usernameHashes
|
||||||
|
|
@ -2724,16 +2546,6 @@ components:
|
||||||
description: A handle that can be included in username links to retrieve
|
description: A handle that can be included in username links to retrieve
|
||||||
the stored encrypted username
|
the stored encrypted username
|
||||||
format: uuid
|
format: uuid
|
||||||
EncryptedUsername:
|
|
||||||
required:
|
|
||||||
- usernameLinkEncryptedValue
|
|
||||||
type: object
|
|
||||||
properties:
|
|
||||||
usernameLinkEncryptedValue:
|
|
||||||
maxLength: 128
|
|
||||||
minLength: 1
|
|
||||||
type: string
|
|
||||||
description: the URL-safe base64 encoding of the encrypted username
|
|
||||||
MismatchedDevices:
|
MismatchedDevices:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
|
|
@ -2848,14 +2660,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:
|
||||||
|
|
@ -3297,13 +3109,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:
|
||||||
|
|
@ -3364,6 +3176,19 @@ components:
|
||||||
items:
|
items:
|
||||||
type: string
|
type: string
|
||||||
format: byte
|
format: byte
|
||||||
|
PreKeyCount:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
count:
|
||||||
|
type: integer
|
||||||
|
description: the number of stored unsigned elliptic-curve prekeys for this
|
||||||
|
device
|
||||||
|
format: int32
|
||||||
|
pqCount:
|
||||||
|
type: integer
|
||||||
|
description: the number of stored one-time post-quantum prekeys for this
|
||||||
|
device
|
||||||
|
format: int32
|
||||||
PreKeyState:
|
PreKeyState:
|
||||||
required:
|
required:
|
||||||
- identityKey
|
- identityKey
|
||||||
|
|
@ -3652,14 +3477,10 @@ components:
|
||||||
items:
|
items:
|
||||||
type: string
|
type: string
|
||||||
format: byte
|
format: byte
|
||||||
BatchIdentityCheckRequest:
|
BatchIdentityCheckResponse:
|
||||||
required:
|
|
||||||
- elements
|
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
elements:
|
elements:
|
||||||
maxItems: 1000
|
|
||||||
minItems: 0
|
|
||||||
type: array
|
type: array
|
||||||
items:
|
items:
|
||||||
$ref: '#/components/schemas/Element'
|
$ref: '#/components/schemas/Element'
|
||||||
|
|
@ -3680,6 +3501,17 @@ components:
|
||||||
items:
|
items:
|
||||||
type: string
|
type: string
|
||||||
format: byte
|
format: byte
|
||||||
|
BatchIdentityCheckRequest:
|
||||||
|
required:
|
||||||
|
- elements
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
elements:
|
||||||
|
maxItems: 1000
|
||||||
|
minItems: 0
|
||||||
|
type: array
|
||||||
|
items:
|
||||||
|
$ref: '#/components/schemas/Element'
|
||||||
CreateProfileRequest:
|
CreateProfileRequest:
|
||||||
required:
|
required:
|
||||||
- commitment
|
- commitment
|
||||||
|
|
@ -3883,6 +3715,8 @@ components:
|
||||||
description: "A list of SVR auth values, previously retrieved from `/v1/backup/auth`;\
|
description: "A list of SVR auth values, previously retrieved from `/v1/backup/auth`;\
|
||||||
\ may contain at most 10."
|
\ may contain at most 10."
|
||||||
items:
|
items:
|
||||||
|
maxLength: 10
|
||||||
|
minLength: 0
|
||||||
type: string
|
type: string
|
||||||
description: "A list of SVR auth values, previously retrieved from `/v1/backup/auth`;\
|
description: "A list of SVR auth values, previously retrieved from `/v1/backup/auth`;\
|
||||||
\ may contain at most 10."
|
\ may contain at most 10."
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue