Updating documentation

signal-server-openapi.yaml

@@ -1547,6 +1547,9 @@ paths:
         "403":
           description: The given account was not found or the given verification code
             was incorrect
+        "409":
+          description: The new device is missing a capability supported by all other
+            devices on the account
         "411":
           description: The given account already has its maximum number of linked
             devices
@@ -2037,13 +2040,17 @@ paths:
           content:
             application/json:
               schema:
-                type: string
+                type: array
+                items:
+                  $ref: '#/components/schemas/AccountMismatchedDevices'
         "410":
           description: Mismatched registration ids supplied for some recipient devices
           content:
             application/json:
               schema:
-                type: string
+                type: array
+                items:
+                  $ref: '#/components/schemas/AccountStaleDevices'
       security:
       - authenticatedAccount: []
       - {}
@@ -2123,13 +2130,17 @@ paths:
           content:
             application/json:
               schema:
-                type: string
+                type: array
+                items:
+                  $ref: '#/components/schemas/AccountMismatchedDevices'
         "410":
           description: Mismatched registration ids supplied for some recipient devices
           content:
             application/json:
               schema:
-                type: string
+                type: array
+                items:
+                  $ref: '#/components/schemas/AccountStaleDevices'
   /v1/payments/auth:
     get:
       tags:
@@ -3178,13 +3189,9 @@ components:
       type: object
       properties:
         usernameHash:
-          type: array
-          items:
           type: string
           format: byte
         zkProof:
-          type: array
-          items:
           type: string
           format: byte
         encryptedUsername:
@@ -3208,9 +3215,6 @@ components:
           description: the account identifier for this account's phone-number identity
           format: uuid
         usernameHash:
-          type: array
-          description: "a hash of this account's username, if set"
-          items:
           type: string
           description: "a hash of this account's username, if set"
           format: byte
@@ -3261,8 +3265,6 @@ components:
       type: object
       properties:
         usernameHash:
-          type: array
-          items:
           type: string
           format: byte
     ReserveUsernameHashRequest:
@@ -3273,8 +3275,6 @@ components:
         usernameHashes:
           maxItems: 20
           minItems: 1
-          type: array
-          items:
           type: array
           items:
             type: string
@@ -3288,17 +3288,13 @@ components:
           type: integer
           format: int32
         name:
-          maxItems: 225
+          maxLength: 225
-          minItems: 0
+          minLength: 0
-          type: array
-          items:
           type: string
           format: byte
         registrationLock:
           type: string
         unidentifiedAccessKey:
-          type: array
-          items:
           type: string
           format: byte
         unrestrictedUnidentifiedAccess:
@@ -3308,8 +3304,6 @@ components:
         discoverableByPhoneNumber:
           type: boolean
         recoveryPassword:
-          type: array
-          items:
           type: string
           format: byte
         eachRegistrationIdValid:
@@ -3360,10 +3354,8 @@ components:
       type: object
       properties:
         deviceName:
-          maxItems: 225
+          maxLength: 225
-          minItems: 0
+          minLength: 0
-          type: array
-          items:
           type: string
           format: byte
     RegistrationLock:
@@ -3459,10 +3451,6 @@ components:
       - pniRegistrationIds
       type: object
       properties:
-        reglock:
-          type: string
-          description: "the registration lock password for the new phone number, if\
-            \ necessary"
         sessionId:
           type: string
           description: |-
@@ -3516,6 +3504,10 @@ components:
           type: boolean
         valid:
           type: boolean
+        reglock:
+          type: string
+          description: "the registration lock password for the new phone number, if\
+            \ necessary"
     ECPublicKey:
       type: object
       properties:
@@ -3523,8 +3515,6 @@ components:
           type: integer
           format: int32
         publicKeyBytes:
-          type: array
-          items:
           type: string
           format: byte
     ECSignedPreKey:
@@ -3875,9 +3865,6 @@ components:
       type: object
       properties:
         credential:
-          type: array
-          description: "A BackupAuthCredential, encoded in standard padded base64"
-          items:
           type: string
           description: "A BackupAuthCredential, encoded in standard padded base64"
           format: byte
@@ -4019,8 +4006,6 @@ components:
       type: object
       properties:
         credential:
-          type: array
-          items:
           type: string
           format: byte
         redemptionTime:
@@ -4032,24 +4017,18 @@ components:
       type: object
       properties:
         createCallLinkCredentialRequest:
-          type: array
-          items:
           type: string
           format: byte
     DeliveryCertificate:
       type: object
       properties:
         certificate:
-          type: array
-          items:
           type: string
           format: byte
     CallLinkAuthCredential:
       type: object
       properties:
         credential:
-          type: array
-          items:
           type: string
           format: byte
         redemptionTime:
@@ -4059,8 +4038,6 @@ components:
       type: object
       properties:
         credential:
-          type: array
-          items:
           type: string
           format: byte
         redemptionTime:
@@ -4128,8 +4105,6 @@ components:
           type: integer
           format: int64
         name:
-          type: array
-          items:
           type: string
           format: byte
         lastSeen:
@@ -4221,8 +4196,6 @@ components:
       type: object
       properties:
         receiptCredentialPresentation:
-          type: array
-          items:
           type: string
           format: byte
         visible:
@@ -4260,23 +4233,6 @@ components:
           - ACI
           - PNI
         digest:
-          type: array
-          description: |
-            A 32-byte digest of the client's repeated-use keys for the given identity type. The digest is calculated as:
-
-            SHA256(identityKeyBytes || signedEcPreKeyId || signedEcPreKeyIdBytes || lastResortKeyId || lastResortKeyBytes)
-
-            …where the elements of the hash are:
-
-            - identityKeyBytes: the serialized form of the client's public identity key as produced by libsignal (i.e. one
-              version byte followed by 32 bytes of key material for a total of 33 bytes)
-            - signedEcPreKeyId: an 8-byte, big-endian representation of the ID of the client's signed EC pre-key
-            - signedEcPreKeyBytes: the serialized form of the client's signed EC pre-key as produced by libsignal (i.e. one
-              version byte followed by 32 bytes of key material for a total of 33 bytes)
-            - lastResortKeyId: an 8-byte, big-endian representation of the ID of the client's last-resort Kyber key
-            - lastResortKeyBytes: the serialized form of the client's last-resort Kyber key as produced by libsignal (i.e.
-              one version byte followed by 1568 bytes of key material for a total of 1569 bytes)
-          items:
           type: string
           description: |
             A 32-byte digest of the client's repeated-use keys for the given identity type. The digest is calculated as:
@@ -4343,8 +4299,6 @@ components:
       type: object
       properties:
         accessKey:
-          type: array
-          items:
           type: string
           format: byte
     GroupSendFullToken:
@@ -4354,8 +4308,6 @@ components:
           type: string
           format: date-time
         internalContentsForJNI:
-          type: array
-          items:
           type: string
           format: byte
     GroupSendTokenHeader:
@@ -4403,8 +4355,6 @@ components:
       type: object
       properties:
         token:
-          type: array
-          items:
           type: string
           format: byte
     AccountMismatchedDevices:
@@ -4445,16 +4395,12 @@ components:
       type: object
       properties:
         accessKeys:
-          type: array
-          items:
           type: string
           format: byte
     Recipient:
       type: object
       properties:
         devices:
-          type: array
-          items:
           type: string
           format: byte
         devicesAndRegistrationIds:
@@ -4537,8 +4483,6 @@ components:
         identityKey:
           $ref: '#/components/schemas/IdentityKey'
         unidentifiedAccess:
-          type: array
-          items:
           type: string
           format: byte
         unrestrictedUnidentifiedAccess:
@@ -4566,8 +4510,6 @@ components:
         identityKey:
           $ref: '#/components/schemas/IdentityKey'
         unidentifiedAccess:
-          type: array
-          items:
           type: string
           format: byte
         unrestrictedUnidentifiedAccess:
@@ -4583,30 +4525,20 @@ components:
           description: A service identifier is a tuple of a UUID and identity type
             that identifies an account and identity within the Signal service.
         name:
-          type: array
-          items:
           type: string
           format: byte
         about:
-          type: array
-          items:
           type: string
           format: byte
         aboutEmoji:
-          type: array
-          items:
           type: string
           format: byte
         avatar:
           type: string
         paymentAddress:
-          type: array
-          items:
           type: string
           format: byte
         phoneNumberSharing:
-          type: array
-          items:
           type: string
           format: byte
     CredentialProfileResponse:
@@ -4615,8 +4547,6 @@ components:
         identityKey:
           $ref: '#/components/schemas/IdentityKey'
         unidentifiedAccess:
-          type: array
-          items:
           type: string
           format: byte
         unrestrictedUnidentifiedAccess:
@@ -4632,30 +4562,20 @@ components:
           description: A service identifier is a tuple of a UUID and identity type
             that identifies an account and identity within the Signal service.
         name:
-          type: array
-          items:
           type: string
           format: byte
         about:
-          type: array
-          items:
           type: string
           format: byte
         aboutEmoji:
-          type: array
-          items:
           type: string
           format: byte
         avatar:
           type: string
         paymentAddress:
-          type: array
-          items:
           type: string
           format: byte
         phoneNumberSharing:
-          type: array
-          items:
           type: string
           format: byte
     BatchIdentityCheckResponse:
@@ -4678,8 +4598,6 @@ components:
           type: string
           description: An identifier for an account based on the account's ACI
         fingerprint:
-          type: array
-          items:
           type: string
           format: byte
     BatchIdentityCheckRequest:
@@ -4699,41 +4617,25 @@ components:
       - version
       type: object
       properties:
-        avatar:
-          type: boolean
-        badgeIds:
-          type: array
-          items:
-            type: string
         commitment:
           $ref: '#/components/schemas/ProfileKeyCommitment'
         version:
           type: string
         name:
-          type: array
-          items:
           type: string
           format: byte
         aboutEmoji:
-          type: array
-          items:
           type: string
           format: byte
         about:
-          type: array
-          items:
           type: string
           format: byte
         paymentAddress:
-          type: array
-          items:
           type: string
           format: byte
         sameAvatar:
           type: boolean
         phoneNumberSharing:
-          type: array
-          items:
           type: string
           format: byte
         avatarChange:
@@ -4742,12 +4644,16 @@ components:
           - UNCHANGED
           - CLEAR
           - UPDATE
+        avatar:
+          type: boolean
+        badgeIds:
+          type: array
+          items:
+            type: string
     ProfileKeyCommitment:
       type: object
       properties:
         internalContentsForJNI:
-          type: array
-          items:
           type: string
           format: byte
     ProvisioningMessage:
@@ -4776,11 +4682,6 @@ components:
             metadata object. Must be provided if `recoveryPassword` is not provided; must not be
             provided if `recoveryPassword` is provided.
         recoveryPassword:
-          type: array
-          description: |
-            A base64-encoded registration recovery password. Must be provided if `sessionId` is
-            not provided; must not be provided if `sessionId` is provided
-          items:
           type: string
           description: |
             A base64-encoded registration recovery password. Must be provided if `sessionId` is
@@ -4857,6 +4758,9 @@ components:
       - tokens
       type: object
       properties:
+        number:
+          type: string
+          description: The e164-formatted phone number.
         tokens:
           maxItems: 10
           minItems: 0
@@ -4865,15 +4769,10 @@ components:
             A list of SVR tokens, previously retrieved from `backup/auth`. Tokens should be the
             of the form "username:password". May contain at most 10 tokens.
           items:
-            maxLength: 10
-            minLength: 0
             type: string
             description: |-
               A list of SVR tokens, previously retrieved from `backup/auth`. Tokens should be the
               of the form "username:password". May contain at most 10 tokens.
-        number:
-          type: string
-          description: The e164-formatted phone number.
     AuthCheckResponseV3:
       required:
       - matches
@@ -5005,8 +4904,6 @@ components:
         paymentIntentId:
           type: string
         receiptCredentialRequest:
-          type: array
-          items:
           type: string
           format: byte
         processor:
@@ -5058,8 +4955,6 @@ components:
       type: object
       properties:
         receiptCredentialRequest:
-          type: array
-          items:
           type: string
           format: byte
     VerificationSessionResponse: