MirrorMirror
/
Signal-Server
mirror of https://github.com/signalapp/Signal-Server.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Updating documentation

This commit is contained in:
Documentation Updater 2024-04-01 20:31:39 +00:00
parent c02e8928df
commit 640a47bafc
1 changed files with 19 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
signal-server-openapi.yaml
View File

@ -3442,17 +3442,23 @@ components:
properties: properties:
cdn: cdn:
type: integer type: integer
description: "If present, the CDN type where the message backup is stored" description: The CDN type where the message backup is stored. Media may
be stored elsewhere.
format: int32 format: int32
backupDir: backupDir:
type: string type: string
description: | description: |
If present, the directory of your backup data on the cdn. The message backup can be found at /backupDir/backupName The base directory of your backup data on the cdn. The message backup can be found in the returned cdn at
and stored media can be found at /backupDir/media/mediaId. /backupDir/backupName and stored media can be found at /backupDir/mediaDir/mediaId
mediaDir:
type: string
description: |
The prefix path component for media objects on a cdn. Stored media for mediaId can be found at
/backupDir/mediaDir/mediaId.
backupName: backupName:
type: string type: string
description: "If present, the name of the most recent message backup on\ description: The name of the most recent message backup on the cdn. The
\ the cdn. The backup is at /backupDir/backupName" backup is at /backupDir/backupName
usedSpace: usedSpace:
type: integer type: integer
description: The amount of space used to store media description: The amount of space used to store media
@ -3610,6 +3616,14 @@ components:
description: A page of media objects stored for this backup ID description: A page of media objects stored for this backup ID
items: items:
$ref: '#/components/schemas/StoredMediaObject' $ref: '#/components/schemas/StoredMediaObject'
backupDir:
type: string
description: |
The base directory of your backup data on the cdn. The stored media can be found at /backupDir/mediaDir/mediaId
mediaDir:
type: string
description: |
The prefix path component for the media objects. The stored media for mediaId can be found at /backupDir/mediaDir/mediaId.
cursor: cursor:
type: string type: string
description: "If set, the cursor value to pass to the next list request\ description: "If set, the cursor value to pass to the next list request\