From 358795ca7746bfccc153e2b0a3fcc04480a23f61 Mon Sep 17 00:00:00 2001 From: Documentation Updater Date: Fri, 1 Aug 2025 18:01:50 +0000 Subject: [PATCH] Updating documentation --- signal-server-openapi.yaml | 68 +++++++++++++++++++++++++++----------- 1 file changed, 49 insertions(+), 19 deletions(-) diff --git a/signal-server-openapi.yaml b/signal-server-openapi.yaml index 261569d5e..2e366d67c 100644 --- a/signal-server-openapi.yaml +++ b/signal-server-openapi.yaml @@ -1204,6 +1204,55 @@ paths: security: - authenticatedAccount: [] - {} + /v1/archives/auth/svrb: + get: + tags: + - Archive + summary: Generate credentials for SVRB + description: | + Generate SVRB service credentials. Generated credentials have an expiration time of 1 day (subject to change) + operationId: svrbAuth + parameters: + - name: User-Agent + in: header + schema: + type: string + - name: X-Signal-ZK-Auth + in: header + description: "Presentation of a ZK backup auth credential acquired from /v1/archives/auth,\ + \ encoded in standard padded base64" + required: true + schema: + type: string + - name: X-Signal-ZK-Auth-Signature + in: header + description: "Signature of the ZK auth credential's presentation, encoded\ + \ in standard padded base64" + required: true + schema: + type: string + responses: + "200": + description: '`JSON` with generated credentials.' + content: + application/json: + schema: + type: object + "403": + description: Forbidden. The request had insufficient permissions to perform + the requested action + "401": + description: |- + The provided backup auth credential presentation could not be verified or + The public key signature was invalid or + There is no backup associated with the backup-id in the presentation or + The credential was of the wrong type (messages/media) + "400": + description: Bad arguments. The request may have been made on an authenticated + channel + security: + - authenticatedAccount: [] + - {} /v1/archives/media/upload/form: get: tags: @@ -3129,25 +3178,6 @@ paths: description: Account authentication check failed. security: - authenticatedAccount: [] - /v1/svrb/auth: - get: - tags: - - Secure Value Recovery B - summary: Generate credentials for SVRB - description: | - Generate SVRB service credentials. Generated credentials have an expiration time of 1 day (subject to change) - operationId: getAuth_3 - responses: - "200": - description: '`JSON` with generated credentials.' - content: - application/json: - schema: - $ref: "#/components/schemas/ExternalServiceCredentials" - "401": - description: Account authentication check failed. - security: - - authenticatedAccount: [] /v1/sticker/pack/form/{count}: get: tags: