diff --git a/src/api/api.go b/src/api/api.go index dcc84ae..e7ef1ee 100644 --- a/src/api/api.go +++ b/src/api/api.go @@ -330,7 +330,7 @@ func wsPing(ws *websocket.Conn) { // @Summary Receive Signal Messages. // @Tags Messages -// @Description Receives Signal Messages from the Signal Network. +// @Description Receives Signal Messages from the Signal Network. If you are running the docker container in normal/native mode, this is a GET endpoint. In json-rpc mode this is a websocket endpoint. // @Accept json // @Produce json // @Success 200 {object} []string diff --git a/src/docs/docs.go b/src/docs/docs.go index ec0f7ab..4279001 100644 --- a/src/docs/docs.go +++ b/src/docs/docs.go @@ -696,7 +696,7 @@ var doc = `{ }, "/v1/receive/{number}": { "get": { - "description": "Receives Signal Messages from the Signal Network.", + "description": "Receives Signal Messages from the Signal Network. If you are running the docker container in normal/native mode, this is a GET endpoint. In json-rpc mode this is a websocket endpoint.", "consumes": [ "application/json" ], diff --git a/src/docs/swagger.json b/src/docs/swagger.json index 6ed4db9..b7fcad0 100644 --- a/src/docs/swagger.json +++ b/src/docs/swagger.json @@ -681,7 +681,7 @@ }, "/v1/receive/{number}": { "get": { - "description": "Receives Signal Messages from the Signal Network.", + "description": "Receives Signal Messages from the Signal Network. If you are running the docker container in normal/native mode, this is a GET endpoint. In json-rpc mode this is a websocket endpoint.", "consumes": [ "application/json" ], diff --git a/src/docs/swagger.yaml b/src/docs/swagger.yaml index 8465dfd..139e792 100644 --- a/src/docs/swagger.yaml +++ b/src/docs/swagger.yaml @@ -615,7 +615,7 @@ paths: get: consumes: - application/json - description: Receives Signal Messages from the Signal Network. + description: Receives Signal Messages from the Signal Network. If you are running the docker container in normal/native mode, this is a GET endpoint. In json-rpc mode this is a websocket endpoint. parameters: - description: Registered Phone Number in: path