From c62dc45a85b1b52777bcd2b0ea849d7c2a100e9e Mon Sep 17 00:00:00 2001 From: crummy Date: Fri, 25 Oct 2024 10:18:55 +1300 Subject: [PATCH] Fix linting warnings in swagger files --- src/docs/swagger.json | 26 ++++++++++++++++++++++++-- src/docs/swagger.yaml | 18 +++++++++++++++++- 2 files changed, 41 insertions(+), 3 deletions(-) diff --git a/src/docs/swagger.json b/src/docs/swagger.json index 1a8a2ef..8fbf96c 100644 --- a/src/docs/swagger.json +++ b/src/docs/swagger.json @@ -1400,6 +1400,13 @@ ], "summary": "Send a reaction.", "parameters": [ + { + "description": "Reaction ID", + "name": "number", + "in": "path", + "required": true, + "type": "number" + }, { "description": "Reaction", "name": "data", @@ -1438,6 +1445,13 @@ ], "summary": "Remove a reaction.", "parameters": [ + { + "description": "Reaction ID", + "name": "number", + "in": "path", + "required": true, + "type": "number" + }, { "description": "Reaction", "name": "data", @@ -1478,6 +1492,13 @@ ], "summary": "Send a receipt.", "parameters": [ + { + "description": "Receipt ID", + "name": "number", + "in": "path", + "required": true, + "type": "number" + }, { "description": "Receipt", "name": "data", @@ -1671,7 +1692,7 @@ } } }, - "/v1/search": { + "/v1/search/{number}": { "get": { "description": "Check if one or more phone numbers are registered with the Signal Service.", "consumes": [ @@ -1689,7 +1710,8 @@ "type": "string", "description": "Registered Phone Number", "name": "number", - "in": "path" + "in": "path", + "required": true }, { "type": "array", diff --git a/src/docs/swagger.yaml b/src/docs/swagger.yaml index 18ef93f..af6db85 100644 --- a/src/docs/swagger.yaml +++ b/src/docs/swagger.yaml @@ -1329,6 +1329,11 @@ paths: - application/json description: Remove a reaction parameters: + - description: Reaction ID + name: number + in: path + required: true + type: number - description: Reaction in: body name: data @@ -1354,6 +1359,11 @@ paths: - application/json description: React to a message parameters: + - description: Reaction ID + name: number + in: path + required: true + type: number - description: Reaction in: body name: data @@ -1380,6 +1390,11 @@ paths: - application/json description: Send a read or viewed receipt parameters: + - description: Receipt ID + name: number + in: path + required: true + type: number - description: Receipt in: body name: data @@ -1514,7 +1529,7 @@ paths: summary: Verify a registered phone number. tags: - Devices - /v1/search: + /v1/search/{number}: get: consumes: - application/json @@ -1525,6 +1540,7 @@ paths: in: path name: number type: string + required: true - collectionFormat: multi description: Numbers to check in: query