fixed swagger documentation for search endpoint

see #622
bbernhard · Nov 29, 2024 · db97de3 · db97de3
1 parent b530fbb
commit db97de3
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 4 deletions.
diff --git a/src/api/api.go b/src/api/api.go
@@ -1724,7 +1724,7 @@ func (a *Api) SendStopTyping(c *gin.Context) {
 // @Param numbers query []string true "Numbers to check" collectionFormat(multi)
 // @Success 200 {object} []SearchResponse
 // @Failure 400 {object} Error
-// @Router /v1/search [get]
+// @Router /v1/search/{number} [get]
 func (a *Api) SearchForNumbers(c *gin.Context) {
 	query := c.Request.URL.Query()
 	if _, ok := query["numbers"]; !ok {

diff --git a/src/docs/docs.go b/src/docs/docs.go
@@ -1699,7 +1699,7 @@ const docTemplate = `{
                 }
             }
         },
-        "/v1/search": {
+        "/v1/search/{number}": {
             "get": {
                 "description": "Check if one or more phone numbers are registered with the Signal Service.",
                 "consumes": [
@@ -2715,6 +2715,8 @@ var SwaggerInfo = &swag.Spec{
 	Description:      "This is the Signal Cli REST API documentation.",
 	InfoInstanceName: "swagger",
 	SwaggerTemplate:  docTemplate,
+	LeftDelim:        "{{",
+	RightDelim:       "}}",
 }
 
 func init() {

diff --git a/src/docs/swagger.json b/src/docs/swagger.json
@@ -1696,7 +1696,7 @@
                 }
             }
         },
-        "/v1/search": {
+        "/v1/search/{number}": {
             "get": {
                 "description": "Check if one or more phone numbers are registered with the Signal Service.",
                 "consumes": [

diff --git a/src/docs/swagger.yaml b/src/docs/swagger.yaml
@@ -1534,7 +1534,7 @@ paths:
       summary: Verify a registered phone number.
       tags:
       - Devices
-  /v1/search:
+  /v1/search/{number}:
     get:
       consumes:
       - application/json