mirror of
https://github.com/signalapp/Signal-Server
synced 2026-05-14 18:40:09 +01:00
Updating documentation
This commit is contained in:
Documentation Updater
+59
-16
@@ -377,6 +377,7 @@ paths:
|
||||
description: "The ID of the device for which to set a name; if omitted,\
|
||||
\ the authenticated device will be targeted for a name change"
|
||||
format: byte
|
||||
nullable: true
|
||||
requestBody:
|
||||
content:
|
||||
'*/*':
|
||||
@@ -1777,6 +1778,7 @@ paths:
|
||||
in: header
|
||||
schema:
|
||||
type: string
|
||||
nullable: true
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
@@ -1907,6 +1909,7 @@ paths:
|
||||
in: header
|
||||
schema:
|
||||
type: string
|
||||
nullable: true
|
||||
responses:
|
||||
"200":
|
||||
description: "Either a new transfer archive was uploaded for the authenticated\
|
||||
@@ -2413,15 +2416,15 @@ paths:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
done:
|
||||
type: boolean
|
||||
cancelled:
|
||||
type: boolean
|
||||
completedExceptionally:
|
||||
type: boolean
|
||||
numberOfDependents:
|
||||
type: integer
|
||||
format: int32
|
||||
done:
|
||||
type: boolean
|
||||
cancelled:
|
||||
type: boolean
|
||||
security:
|
||||
- authenticatedAccount: []
|
||||
/v1/messages/report/{source}/{messageGuid}:
|
||||
@@ -2642,15 +2645,15 @@ paths:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
done:
|
||||
type: boolean
|
||||
cancelled:
|
||||
type: boolean
|
||||
completedExceptionally:
|
||||
type: boolean
|
||||
numberOfDependents:
|
||||
type: integer
|
||||
format: int32
|
||||
done:
|
||||
type: boolean
|
||||
cancelled:
|
||||
type: boolean
|
||||
security:
|
||||
- authenticatedAccount: []
|
||||
- {}
|
||||
@@ -2733,15 +2736,15 @@ paths:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
done:
|
||||
type: boolean
|
||||
cancelled:
|
||||
type: boolean
|
||||
completedExceptionally:
|
||||
type: boolean
|
||||
numberOfDependents:
|
||||
type: integer
|
||||
format: int32
|
||||
done:
|
||||
type: boolean
|
||||
cancelled:
|
||||
type: boolean
|
||||
security:
|
||||
- authenticatedAccount: []
|
||||
- {}
|
||||
@@ -2769,15 +2772,15 @@ paths:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
done:
|
||||
type: boolean
|
||||
cancelled:
|
||||
type: boolean
|
||||
completedExceptionally:
|
||||
type: boolean
|
||||
numberOfDependents:
|
||||
type: integer
|
||||
format: int32
|
||||
done:
|
||||
type: boolean
|
||||
cancelled:
|
||||
type: boolean
|
||||
security:
|
||||
- authenticatedAccount: []
|
||||
- {}
|
||||
@@ -3256,6 +3259,7 @@ paths:
|
||||
in: header
|
||||
schema:
|
||||
type: string
|
||||
nullable: true
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
@@ -3300,6 +3304,7 @@ paths:
|
||||
in: header
|
||||
schema:
|
||||
type: string
|
||||
nullable: true
|
||||
responses:
|
||||
default:
|
||||
description: default response
|
||||
@@ -4027,6 +4032,7 @@ components:
|
||||
type: string
|
||||
description: A handle that can be included in username links to retrieve
|
||||
the stored encrypted username
|
||||
nullable: true
|
||||
ConfirmUsernameHashRequest:
|
||||
required:
|
||||
- zkProof
|
||||
@@ -4044,6 +4050,7 @@ components:
|
||||
type: string
|
||||
description: The url-safe base64-encoded encrypted username to be stored
|
||||
for username links
|
||||
nullable: true
|
||||
AccountIdentifierResponse:
|
||||
required:
|
||||
- uuid
|
||||
@@ -4108,8 +4115,10 @@ components:
|
||||
capabilities:
|
||||
uniqueItems: true
|
||||
type: array
|
||||
nullable: true
|
||||
items:
|
||||
type: string
|
||||
nullable: true
|
||||
enum:
|
||||
- STORAGE
|
||||
- TRANSFER
|
||||
@@ -4120,6 +4129,7 @@ components:
|
||||
recoveryPassword:
|
||||
type: string
|
||||
format: byte
|
||||
nullable: true
|
||||
pniRegistrationId:
|
||||
type: integer
|
||||
format: int32
|
||||
@@ -4196,10 +4206,12 @@ components:
|
||||
type: string
|
||||
description: "a hash of this account's username, if set"
|
||||
format: byte
|
||||
nullable: true
|
||||
usernameLinkHandle:
|
||||
type: string
|
||||
description: "this account's username link handle, if set"
|
||||
format: uuid
|
||||
nullable: true
|
||||
storageCapable:
|
||||
type: boolean
|
||||
description: whether any of this account's devices support storage
|
||||
@@ -4218,6 +4230,7 @@ components:
|
||||
\ since epoch"
|
||||
format: int64
|
||||
description: "If present, the backup level set via /v1/archives/redeem-receipt"
|
||||
nullable: true
|
||||
BadgeEntitlement:
|
||||
type: object
|
||||
properties:
|
||||
@@ -4321,6 +4334,7 @@ components:
|
||||
type: string
|
||||
description: "the registration lock password for the new phone number, if\
|
||||
\ necessary"
|
||||
nullable: true
|
||||
pniIdentityKey:
|
||||
$ref: "#/components/schemas/IdentityKey"
|
||||
deviceMessages:
|
||||
@@ -4497,6 +4511,7 @@ components:
|
||||
format: date-time
|
||||
userAgent:
|
||||
type: string
|
||||
nullable: true
|
||||
PhoneNumberDiscoverabilityRequest:
|
||||
required:
|
||||
- discoverableByPhoneNumber
|
||||
@@ -4863,6 +4878,7 @@ components:
|
||||
type: string
|
||||
hostname:
|
||||
type: string
|
||||
nullable: true
|
||||
DeliveryCertificate:
|
||||
type: object
|
||||
properties:
|
||||
@@ -4901,6 +4917,7 @@ components:
|
||||
pni:
|
||||
type: string
|
||||
format: uuid
|
||||
nullable: true
|
||||
AnswerPushChallengeRequest:
|
||||
required:
|
||||
- challenge
|
||||
@@ -5091,6 +5108,7 @@ components:
|
||||
type: string
|
||||
description: "Additional data to use to bootstrap a connection between devices,\
|
||||
\ in standard unpadded base64."
|
||||
nullable: true
|
||||
description: |
|
||||
Represents a request from a new device to restore account data by some method.
|
||||
RemoteAttachmentError:
|
||||
@@ -5165,6 +5183,7 @@ components:
|
||||
properties:
|
||||
authenticated:
|
||||
type: object
|
||||
nullable: true
|
||||
client:
|
||||
$ref: "#/components/schemas/WebSocketClient"
|
||||
KeyTransparencyDistinguishedKeyResponse:
|
||||
@@ -5455,6 +5474,8 @@ components:
|
||||
token:
|
||||
type: string
|
||||
format: byte
|
||||
nullable: true
|
||||
nullable: true
|
||||
SendMessageResponse:
|
||||
type: object
|
||||
properties:
|
||||
@@ -5513,6 +5534,7 @@ components:
|
||||
accessKeys:
|
||||
type: string
|
||||
format: byte
|
||||
nullable: true
|
||||
Recipient:
|
||||
type: object
|
||||
properties:
|
||||
@@ -5883,6 +5905,7 @@ components:
|
||||
format: byte
|
||||
description: Expiring profile key credential response. Null if profile version
|
||||
was not found
|
||||
nullable: true
|
||||
BatchIdentityCheckResponse:
|
||||
type: object
|
||||
properties:
|
||||
@@ -6034,10 +6057,12 @@ components:
|
||||
type: string
|
||||
description: "a hash of this account's username, if set"
|
||||
format: byte
|
||||
nullable: true
|
||||
usernameLinkHandle:
|
||||
type: string
|
||||
description: "this account's username link handle, if set"
|
||||
format: uuid
|
||||
nullable: true
|
||||
storageCapable:
|
||||
type: boolean
|
||||
description: whether any of this account's devices support storage
|
||||
@@ -6229,16 +6254,19 @@ components:
|
||||
depending on which processor was used
|
||||
outcomeNetworkStatus:
|
||||
type: string
|
||||
nullable: true
|
||||
externalDocs:
|
||||
description: Outcome Network Status
|
||||
url: https://stripe.com/docs/api/charges/object#charge_object-outcome-network_status
|
||||
outcomeReason:
|
||||
type: string
|
||||
nullable: true
|
||||
externalDocs:
|
||||
description: Outcome Reason
|
||||
url: https://stripe.com/docs/api/charges/object#charge_object-outcome-reason
|
||||
outcomeType:
|
||||
type: string
|
||||
nullable: true
|
||||
externalDocs:
|
||||
description: Outcome Type
|
||||
url: https://stripe.com/docs/api/charges/object#charge_object-outcome-type
|
||||
@@ -6487,16 +6515,19 @@ components:
|
||||
description: Duration in seconds after which next SMS can be requested for
|
||||
this session
|
||||
format: int64
|
||||
nullable: true
|
||||
nextCall:
|
||||
type: integer
|
||||
description: Duration in seconds after which next voice call can be requested
|
||||
for this session
|
||||
format: int64
|
||||
nullable: true
|
||||
nextVerificationAttempt:
|
||||
type: integer
|
||||
description: Duration in seconds after which the client can submit a verification
|
||||
code for this session
|
||||
format: int64
|
||||
nullable: true
|
||||
allowedToRequestCode:
|
||||
type: boolean
|
||||
description: Whether it is allowed to request a verification code for this
|
||||
@@ -6528,24 +6559,30 @@ components:
|
||||
type: string
|
||||
description: The APNs or FCM device token to which a push challenge can
|
||||
be sent
|
||||
nullable: true
|
||||
pushTokenType:
|
||||
type: string
|
||||
description: The type of push token
|
||||
nullable: true
|
||||
enum:
|
||||
- apn
|
||||
- fcm
|
||||
pushChallenge:
|
||||
type: string
|
||||
description: Value received by the device in the push challenge
|
||||
nullable: true
|
||||
captcha:
|
||||
type: string
|
||||
description: Captcha token returned after solving a captcha challenge
|
||||
nullable: true
|
||||
mcc:
|
||||
type: string
|
||||
description: Mobile country code of the phone subscriber
|
||||
nullable: true
|
||||
mnc:
|
||||
type: string
|
||||
description: Mobile network code of the phone subscriber
|
||||
nullable: true
|
||||
UpdateVerificationSessionRequest:
|
||||
type: object
|
||||
properties:
|
||||
@@ -6553,24 +6590,30 @@ components:
|
||||
type: string
|
||||
description: The APNs or FCM device token to which a push challenge can
|
||||
be sent
|
||||
nullable: true
|
||||
pushTokenType:
|
||||
type: string
|
||||
description: The type of push token
|
||||
nullable: true
|
||||
enum:
|
||||
- apn
|
||||
- fcm
|
||||
pushChallenge:
|
||||
type: string
|
||||
description: Value received by the device in the push challenge
|
||||
nullable: true
|
||||
captcha:
|
||||
type: string
|
||||
description: Captcha token returned after solving a captcha challenge
|
||||
nullable: true
|
||||
mcc:
|
||||
type: string
|
||||
description: Mobile country code of the phone subscriber
|
||||
nullable: true
|
||||
mnc:
|
||||
type: string
|
||||
description: Mobile network code of the phone subscriber
|
||||
nullable: true
|
||||
SendVerificationCodeFailureResponse:
|
||||
type: object
|
||||
properties:
|
||||
|
||||
Reference in New Issue
Block a user