From 640a47bafc3bed4b86305ae6b3bdb290c2c5b36f Mon Sep 17 00:00:00 2001 From: Documentation Updater Date: Mon, 1 Apr 2024 20:31:39 +0000 Subject: [PATCH] Updating documentation --- signal-server-openapi.yaml | 24 +++++++++++++++++++----- 1 file changed, 19 insertions(+), 5 deletions(-) diff --git a/signal-server-openapi.yaml b/signal-server-openapi.yaml index e8e9861eb..7d68e0d15 100644 --- a/signal-server-openapi.yaml +++ b/signal-server-openapi.yaml @@ -3442,17 +3442,23 @@ components: properties: cdn: 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 backupDir: type: string description: | - If present, the directory of your backup data on the cdn. The message backup can be found at /backupDir/backupName - and stored media can be found at /backupDir/media/mediaId. + The base directory of your backup data on the cdn. The message backup can be found in the returned cdn at + /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: type: string - description: "If present, the name of the most recent message backup on\ - \ the cdn. The backup is at /backupDir/backupName" + description: The name of the most recent message backup on the cdn. The + backup is at /backupDir/backupName usedSpace: type: integer 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 items: $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: type: string description: "If set, the cursor value to pass to the next list request\