Updating documentation

This commit is contained in:
Documentation Updater 2024-11-26 23:24:32 +00:00
parent 36d86e83cf
commit d953f5cde3
1 changed files with 24 additions and 25 deletions

View File

@ -1691,7 +1691,12 @@ paths:
content: content:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/TransferArchiveResult' description: |
The location of the transfer archive if the archive was successfully uploaded, otherwise a error indicating that
the upload has failed and the destination device should stop waiting
oneOf:
- $ref: '#/components/schemas/RemoteAttachment'
- $ref: '#/components/schemas/RemoteAttachmentError'
"204": "204":
description: No transfer archive was uploaded before the call completed; description: No transfer archive was uploaded before the call completed;
clients may repeat the call to continue waiting clients may repeat the call to continue waiting
@ -4264,19 +4269,16 @@ components:
- cdn - cdn
- key - key
type: object type: object
allOf: properties:
- $ref: '#/components/schemas/TransferArchiveResult' cdn:
- type: object type: integer
properties: description: The attachment cdn
cdn: format: int32
type: integer key:
description: The attachment cdn maxLength: 64
format: int32 minLength: 0
key: type: string
maxLength: 64 description: The attachment key
minLength: 0
type: string
description: The attachment key
CopyMediaResponse: CopyMediaResponse:
required: required:
- cdn - cdn
@ -4664,25 +4666,22 @@ components:
required: required:
- error - error
type: object type: object
properties:
error:
type: string
description: The type of error encountered
enum:
- RELINK_REQUESTED
- CONTINUE_WITHOUT_UPLOAD
description: Indicates an attachment failed to upload description: Indicates an attachment failed to upload
allOf:
- $ref: '#/components/schemas/TransferArchiveResult'
- type: object
properties:
error:
type: string
description: The type of error encountered
enum:
- RELINK_REQUESTED
- CONTINUE_WITHOUT_UPLOAD
TransferArchiveResult: TransferArchiveResult:
type: object type: object
description: | description: |
The location of the transfer archive if the archive was successfully uploaded, otherwise a error indicating that The location of the transfer archive if the archive was successfully uploaded, otherwise a error indicating that
the upload has failed and the destination device should stop waiting the upload has failed and the destination device should stop waiting
oneOf: oneOf:
- $ref: '#/components/schemas/RemoteAttachmentError'
- $ref: '#/components/schemas/RemoteAttachment' - $ref: '#/components/schemas/RemoteAttachment'
- $ref: '#/components/schemas/RemoteAttachmentError'
TransferArchiveUploadedRequest: TransferArchiveUploadedRequest:
required: required:
- transferArchive - transferArchive