From 78e76338c87b8bfbd870e1dece44e31d9474981d Mon Sep 17 00:00:00 2001 From: Documentation Updater Date: Mon, 21 Oct 2024 19:48:25 +0000 Subject: [PATCH] Updating documentation --- signal-server-openapi.yaml | 86 ++++++++++++++++---------------------- 1 file changed, 37 insertions(+), 49 deletions(-) diff --git a/signal-server-openapi.yaml b/signal-server-openapi.yaml index 84f257567..391388266 100644 --- a/signal-server-openapi.yaml +++ b/signal-server-openapi.yaml @@ -1220,26 +1220,6 @@ paths: $ref: '#/components/schemas/ExternalServiceCredentials' security: - authenticatedAccount: [] - /v2/attachments/form/upload: - get: - tags: - - Attachments - operationId: getAttachmentUploadForm - parameters: - - name: User-Agent - in: header - schema: - type: string - responses: - default: - description: default response - content: - application/json: - schema: - $ref: '#/components/schemas/AttachmentDescriptorV2' - deprecated: true - security: - - authenticatedAccount: [] /v4/attachments/form/upload: get: tags: @@ -1248,7 +1228,7 @@ paths: description: | Retrieve an upload form that can be used to perform a resumable upload. The response will include a cdn number indicating what protocol should be used to perform the upload. - operationId: getAttachmentUploadForm_1 + operationId: getAttachmentUploadForm responses: "200": description: "Success, response body includes upload form" @@ -1329,6 +1309,31 @@ paths: description: Rate limited. security: - authenticatedAccount: [] + /v2/calling/relays: + get: + tags: + - Calling + summary: Get 1:1 calling relay options for the client + description: | + Get 1:1 relay addresses in IpV4, Ipv6, and URL formats. + operationId: getCallingRelays_1 + responses: + "200": + description: '`JSON` with call endpoints.' + content: + application/json: + schema: + $ref: '#/components/schemas/GetCallingRelaysResponse' + "400": + description: Invalid get call endpoint request. + "401": + description: Account authentication check failed. + "422": + description: Invalid request format. + "429": + description: Rate limited. + security: + - authenticatedAccount: [] /v1/certificate/delivery: get: tags: @@ -4244,28 +4249,6 @@ components: description: | The public key, serialized in libsignal's elliptic-curve public key format and then encoded as a standard (i.e. not URL-safe), padded, base64-encoded string. - AttachmentDescriptorV2: - type: object - properties: - attachmentId: - type: integer - format: int64 - key: - type: string - credential: - type: string - acl: - type: string - algorithm: - type: string - date: - type: string - policy: - type: string - signature: - type: string - attachmentIdString: - type: string AttachmentDescriptorV3: type: object properties: @@ -4308,6 +4291,13 @@ components: createCallLinkCredentialRequest: type: string format: byte + GetCallingRelaysResponse: + type: object + properties: + relays: + type: array + items: + $ref: '#/components/schemas/TurnToken' DeliveryCertificate: type: object properties: @@ -4517,13 +4507,13 @@ components: WebSocketClient: type: object properties: + created: + type: string + format: date-time userAgent: type: string open: type: boolean - createdTimestamp: - type: integer - format: int64 WebSocketSessionContext: type: object properties: @@ -5116,15 +5106,13 @@ components: Element: required: - fingerprint + - uuid type: object properties: uuid: type: string description: A service identifier is a tuple of a UUID and identity type that identifies an account and identity within the Signal service. - aci: - type: string - description: An identifier for an account based on the account's ACI fingerprint: type: string format: byte