From 72409782eb4f943225b871b2f1d4a234dee7d50a Mon Sep 17 00:00:00 2001
From: Shawn <506895667@qq.com>
Date: Mon, 7 Mar 2022 14:32:58 +0800
Subject: [PATCH] fix: remove the Id field from response of GET, POST /bridges

The response body of POST, GET /bridges should be the same as
 the request body of the POST /bridges:

```
{"type": "mqtt",
 "name": "my_mqtt_bridge"
}
```

We force the user to provide an Id of format `{type}:{name}` when GET,
DELETE, PUT a bridge:

`GET /bridges/{type}:{name}`
---
 apps/emqx_bridge/src/emqx_bridge_api.erl      | 28 +++++++++----------
 .../src/emqx_bridge_http_schema.erl           |  5 +---
 .../src/emqx_bridge_mqtt_schema.erl           |  9 ++----
 3 files changed, 17 insertions(+), 25 deletions(-)

diff --git a/apps/emqx_bridge/src/emqx_bridge_api.erl b/apps/emqx_bridge/src/emqx_bridge_api.erl
index 27171bd08..d373f29ec 100644
--- a/apps/emqx_bridge/src/emqx_bridge_api.erl
+++ b/apps/emqx_bridge/src/emqx_bridge_api.erl
@@ -88,16 +88,18 @@ get_response_body_schema() ->
         bridge_info_examples(get)).
 
 param_path_operation() ->
-    path_param(operation, enum([start, stop, restart]), <<"start">>).
-
-param_path_id() ->
-    path_param(id, binary(), <<"http:my_http_bridge">>).
-
-path_param(Name, Type, Example) ->
-    {Name, mk(Type,
+    {operation, mk(enum([start, stop, restart]),
         #{ in => path
          , required => true
-         , example => Example
+         , example => <<"start">>
+         })}.
+
+param_path_id() ->
+    {id, mk(binary(),
+        #{ in => path
+         , required => true
+         , example => <<"http:my_http_bridge">>
+         , desc => <<"The bridge Id. Must be of format {type}:{name}">>
          })}.
 
 bridge_info_array_example(Method) ->
@@ -140,7 +142,6 @@ method_example(Type, Direction, get) ->
         _ -> "my_" ++ SDir ++ "_" ++ SType ++ "_bridge"
     end,
     #{
-        id => bin(SType ++ ":" ++ SName),
         type => bin(SType),
         name => bin(SName),
         metrics => ?METRICS(0, 0, 0, 0, 0, 0),
@@ -216,7 +217,7 @@ schema("/bridges") ->
         post => #{
             tags => [<<"bridges">>],
             summary => <<"Create Bridge">>,
-            description => <<"Create a new bridge">>,
+            description => <<"Create a new bridge by type and name">>,
             requestBody => emqx_dashboard_swagger:schema_with_examples(
                             emqx_bridge_schema:post_request(),
                             bridge_info_examples(post)),
@@ -243,7 +244,7 @@ schema("/bridges/:id") ->
         put => #{
             tags => [<<"bridges">>],
             summary => <<"Update Bridge">>,
-            description => <<"Update a bridge">>,
+            description => <<"Update a bridge by Id">>,
             parameters => [param_path_id()],
             requestBody => emqx_dashboard_swagger:schema_with_examples(
                             emqx_bridge_schema:put_request(),
@@ -257,7 +258,7 @@ schema("/bridges/:id") ->
         delete => #{
             tags => [<<"bridges">>],
             summary => <<"Delete Bridge">>,
-            description => <<"Delete a bridge">>,
+            description => <<"Delete a bridge by Id">>,
             parameters => [param_path_id()],
             responses => #{
                 204 => <<"Bridge deleted">>
@@ -271,7 +272,7 @@ schema("/bridges/:id/operation/:operation") ->
         post => #{
             tags => [<<"bridges">>],
             summary => <<"Start/Stop/Restart Bridge">>,
-            description => <<"Start/Stop/Restart bridges on a specific node">>,
+            description => <<"Start/Stop/Restart bridges on a specific node.">>,
             parameters => [
                 param_path_id(),
                 param_path_operation()
@@ -425,7 +426,6 @@ format_resp(#{id := Id, raw_config := RawConf,
     {Type, BridgeName} = emqx_bridge:parse_bridge_id(Id),
     IsConnected = fun(connected) -> connected; (_) -> disconnected end,
     RawConf#{
-        id => Id,
         type => Type,
         name => maps:get(<<"name">>, RawConf, BridgeName),
         node => node(),
diff --git a/apps/emqx_bridge/src/emqx_bridge_http_schema.erl b/apps/emqx_bridge/src/emqx_bridge_http_schema.erl
index ccf9c0939..1ebb12c0e 100644
--- a/apps/emqx_bridge/src/emqx_bridge_http_schema.erl
+++ b/apps/emqx_bridge/src/emqx_bridge_http_schema.erl
@@ -74,8 +74,7 @@ fields("put") ->
     fields("bridge");
 
 fields("get") ->
-    [ id_field()
-    ] ++ emqx_bridge_schema:metrics_status_fields() ++ fields("post").
+    emqx_bridge_schema:metrics_status_fields() ++ fields("post").
 
 basic_config() ->
     [ {enable,
@@ -96,8 +95,6 @@ basic_config() ->
     ++ proplists:delete(base_url, emqx_connector_http:fields(config)).
 
 %%======================================================================================
-id_field() ->
-    {id, mk(binary(), #{desc => "The Bridge ID", example => "http:my_http_bridge"})}.
 
 type_field() ->
     {type, mk(http, #{desc => "The Bridge Type"})}.
diff --git a/apps/emqx_bridge/src/emqx_bridge_mqtt_schema.erl b/apps/emqx_bridge/src/emqx_bridge_mqtt_schema.erl
index 9522b6120..923da3591 100644
--- a/apps/emqx_bridge/src/emqx_bridge_mqtt_schema.erl
+++ b/apps/emqx_bridge/src/emqx_bridge_mqtt_schema.erl
@@ -35,15 +35,10 @@ fields("put_egress") ->
     proplists:delete(enable, fields("egress"));
 
 fields("get_ingress") ->
-    [ id_field()
-    ] ++ emqx_bridge_schema:metrics_status_fields() ++ fields("post_ingress");
+    emqx_bridge_schema:metrics_status_fields() ++ fields("post_ingress");
 fields("get_egress") ->
-    [ id_field()
-    ] ++ emqx_bridge_schema:metrics_status_fields() ++ fields("post_egress").
+    emqx_bridge_schema:metrics_status_fields() ++ fields("post_egress").
 
 %%======================================================================================
-id_field() ->
-    {id, mk(binary(), #{desc => "The bridge ID", example => "mqtt:my_mqtt_bridge"})}.
-
 type_field() ->
     {type, mk(mqtt, #{desc => "The bridge type"})}.