From f078e1a2aecb546aceb25091e417bb7d53f8c5e0 Mon Sep 17 00:00:00 2001 From: Era Dorta Date: Fri, 29 Aug 2025 19:55:45 +0200 Subject: [PATCH] Add documentation --- src/docs/docs.go | 66 +++++++++++++++++++++++++++++++++++++++++++ src/docs/swagger.json | 66 +++++++++++++++++++++++++++++++++++++++++++ src/docs/swagger.yaml | 43 ++++++++++++++++++++++++++++ 3 files changed, 175 insertions(+) diff --git a/src/docs/docs.go b/src/docs/docs.go index e81bcbb..7ac72f3 100644 --- a/src/docs/docs.go +++ b/src/docs/docs.go @@ -1854,6 +1854,53 @@ const docTemplate = `{ } } }, + "/v1/remote-delete/{number}": { + "post": { + "description": "Delete a signal message", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "tags": [ + "Messages" + ], + "summary": "Delete a signal message.", + "parameters": [ + { + "type": "string", + "description": "Registered Phone Number", + "name": "number", + "in": "path", + "required": true + }, + { + "description": "Type", + "name": "data", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/api.RemoteDeleteRequest" + } + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/api.RemoteDeleteResponse" + } + }, + "400": { + "description": "Bad Request", + "schema": { + "$ref": "#/definitions/api.Error" + } + } + } + } + }, "/v1/search/{number}": { "get": { "description": "Check if one or more phone numbers are registered with the Signal Service.", @@ -2394,6 +2441,25 @@ const docTemplate = `{ } } }, + "api.RemoteDeleteRequest": { + "type": "object", + "properties": { + "recipient": { + "type": "string" + }, + "timestamp": { + "type": "integer" + } + } + }, + "api.RemoteDeleteResponse": { + "type": "object", + "properties": { + "timestamp": { + "type": "string" + } + } + }, "api.SearchResponse": { "type": "object", "properties": { diff --git a/src/docs/swagger.json b/src/docs/swagger.json index e8b1a45..89873b9 100644 --- a/src/docs/swagger.json +++ b/src/docs/swagger.json @@ -1851,6 +1851,53 @@ } } }, + "/v1/remote-delete/{number}": { + "post": { + "description": "Delete a signal message", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "tags": [ + "Messages" + ], + "summary": "Delete a signal message.", + "parameters": [ + { + "type": "string", + "description": "Registered Phone Number", + "name": "number", + "in": "path", + "required": true + }, + { + "description": "Type", + "name": "data", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/api.RemoteDeleteRequest" + } + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/api.RemoteDeleteResponse" + } + }, + "400": { + "description": "Bad Request", + "schema": { + "$ref": "#/definitions/api.Error" + } + } + } + } + }, "/v1/search/{number}": { "get": { "description": "Check if one or more phone numbers are registered with the Signal Service.", @@ -2391,6 +2438,25 @@ } } }, + "api.RemoteDeleteRequest": { + "type": "object", + "properties": { + "recipient": { + "type": "string" + }, + "timestamp": { + "type": "integer" + } + } + }, + "api.RemoteDeleteResponse": { + "type": "object", + "properties": { + "timestamp": { + "type": "string" + } + } + }, "api.SearchResponse": { "type": "object", "properties": { diff --git a/src/docs/swagger.yaml b/src/docs/swagger.yaml index 5638db2..9f15502 100644 --- a/src/docs/swagger.yaml +++ b/src/docs/swagger.yaml @@ -121,6 +121,18 @@ definitions: use_voice: type: boolean type: object + api.RemoteDeleteRequest: + properties: + recipient: + type: string + timestamp: + type: integer + type: object + api.RemoteDeleteResponse: + properties: + timestamp: + type: string + type: object api.SearchResponse: properties: number: @@ -1706,6 +1718,37 @@ paths: summary: Verify a registered phone number. tags: - Devices + /v1/remote-delete/{number}: + post: + consumes: + - application/json + description: Delete a signal message + parameters: + - description: Registered Phone Number + in: path + name: number + required: true + type: string + - description: Type + in: body + name: data + required: true + schema: + $ref: '#/definitions/api.RemoteDeleteRequest' + produces: + - application/json + responses: + "201": + description: Created + schema: + $ref: '#/definitions/api.RemoteDeleteResponse' + "400": + description: Bad Request + schema: + $ref: '#/definitions/api.Error' + summary: Delete a signal message. + tags: + - Messages /v1/search/{number}: get: consumes: