chore(swagger-schema): Delete the schema that is not reused

This commit is contained in:
Turtle 2021-08-24 21:39:34 +08:00 committed by turtleDeng
parent bf67fa1be1
commit 675d23111c
9 changed files with 47 additions and 62 deletions

View File

@ -50,8 +50,7 @@
-define(EMPTY(V), (V == undefined orelse V == <<>>)). -define(EMPTY(V), (V == undefined orelse V == <<>>)).
api_spec() -> api_spec() ->
{ {[ login_api()
[ login_api()
, logout_api() , logout_api()
, users_api() , users_api()
, user_api() , user_api()

View File

@ -26,14 +26,13 @@
, dropped]). , dropped]).
api_spec() -> api_spec() ->
{ {[ monitor_api()
[ monitor_api()
, monitor_nodes_api() , monitor_nodes_api()
, monitor_nodes_counters_api() , monitor_nodes_counters_api()
, monitor_counters_api() , monitor_counters_api()
, monitor_current_api()], , monitor_current_api()
[] ],
}. []}.
monitor_api() -> monitor_api() ->
Metadata = #{ Metadata = #{

View File

@ -36,10 +36,7 @@
]). ]).
api_spec() -> api_spec() ->
{ {[routes_api(), route_api()], []}.
[routes_api(), route_api()],
[]
}.
properties() -> properties() ->
properties([ properties([

View File

@ -29,9 +29,7 @@ status_api() ->
Metadata = #{ Metadata = #{
get => #{ get => #{
security => [], security => [],
responses => #{ responses => #{<<"200">> => #{description => <<"running">>}}
<<"200">> => #{description => <<"running">>}
}
} }
}, },
{Path, Metadata, running_status}. {Path, Metadata, running_status}.

View File

@ -49,11 +49,11 @@
api_spec() -> api_spec() ->
{ {
[status_api(), delayed_messages_api(), delayed_message_api()], [status_api(), delayed_messages_api(), delayed_message_api()],
schemas() []
}. }.
schemas() -> conf_schema() ->
[#{delayed => emqx_mgmt_api_configs:gen_schema(emqx:get_raw_config([delayed]))}]. emqx_mgmt_api_configs:gen_schema(emqx:get_raw_config([delayed])).
properties() -> properties() ->
PayloadDesc = io_lib:format("Payload, base64 encode. Payload will be ~p if length large than ~p", PayloadDesc = io_lib:format("Payload, base64 encode. Payload will be ~p if length large than ~p",
[?PAYLOAD_TOO_LARGE, ?MAX_PAYLOAD_LENGTH]), [?PAYLOAD_TOO_LARGE, ?MAX_PAYLOAD_LENGTH]),
@ -80,14 +80,14 @@ status_api() ->
get => #{ get => #{
description => <<"Get delayed status">>, description => <<"Get delayed status">>,
responses => #{ responses => #{
<<"200">> => schema(delayed)} <<"200">> => schema(conf_schema())}
}, },
put => #{ put => #{
description => <<"Enable or disable delayed, set max delayed messages">>, description => <<"Enable or disable delayed, set max delayed messages">>,
'requestBody' => schema(delayed), 'requestBody' => schema(conf_schema()),
responses => #{ responses => #{
<<"200">> => <<"200">> =>
schema(delayed, <<"Enable or disable delayed successfully">>), schema(conf_schema(), <<"Enable or disable delayed successfully">>),
<<"400">> => <<"400">> =>
error_schema(<<"Already disabled or enabled">>, [?ALREADY_ENABLED, ?ALREADY_DISABLED]) error_schema(<<"Already disabled or enabled">>, [?ALREADY_ENABLED, ?ALREADY_DISABLED])
} }

View File

@ -25,11 +25,10 @@
]). ]).
api_spec() -> api_spec() ->
{[event_message_api()], [event_message_schema()]}. {[event_message_api()], []}.
event_message_schema() -> conf_schema() ->
Conf = emqx:get_raw_config([event_message]), emqx_mgmt_api_configs:gen_schema(emqx:get_config([event_message])).
#{event_message => emqx_mgmt_api_configs:gen_schema(Conf)}.
event_message_api() -> event_message_api() ->
Path = "/mqtt/event_message", Path = "/mqtt/event_message",
@ -37,14 +36,14 @@ event_message_api() ->
get => #{ get => #{
description => <<"Event Message">>, description => <<"Event Message">>,
responses => #{ responses => #{
<<"200">> => schema(event_message) <<"200">> => schema(conf_schema())
} }
}, },
post => #{ post => #{
description => <<"Update Event Message">>, description => <<"Update Event Message">>,
'requestBody' => schema(event_message), 'requestBody' => schema(conf_schema()),
responses => #{ responses => #{
<<"200">> => schema(event_message) <<"200">> => schema(conf_schema())
} }
} }
}, },

View File

@ -29,21 +29,21 @@
]). ]).
api_spec() -> api_spec() ->
{[prometheus_api(), prometheus_data_api()], schemas()}. {[prometheus_api(), prometheus_data_api()], []}.
schemas() -> conf_schema() ->
[#{prometheus => emqx_mgmt_api_configs:gen_schema(emqx:get_raw_config([prometheus]))}]. emqx_mgmt_api_configs:gen_schema(emqx:get_raw_config([prometheus])).
prometheus_api() -> prometheus_api() ->
Metadata = #{ Metadata = #{
get => #{ get => #{
description => <<"Get Prometheus info">>, description => <<"Get Prometheus info">>,
responses => #{<<"200">> => schema(prometheus)} responses => #{<<"200">> => schema(conf_schema())}
}, },
put => #{ put => #{
description => <<"Update Prometheus">>, description => <<"Update Prometheus">>,
'requestBody' => schema(prometheus), 'requestBody' => schema(conf_schema()),
responses => #{<<"200">> => schema(prometheus)} responses => #{<<"200">> => schema(conf_schema())}
} }
}, },
{"/prometheus", Metadata, prometheus}. {"/prometheus", Metadata, prometheus}.

View File

@ -35,17 +35,10 @@
, properties/1]). , properties/1]).
api_spec() -> api_spec() ->
{ {[lookup_retained_api(), with_topic_api(), config_api()], []}.
[ lookup_retained_api()
, with_topic_api()
, config_api()
],
schemas()
}.
schemas() -> conf_schema() ->
MqttRetainer = gen_schema(emqx:get_raw_config([emqx_retainer])), gen_schema(emqx:get_raw_config([emqx_retainer])).
[#{emqx_retainer => MqttRetainer}].
message_props() -> message_props() ->
properties([ properties([
@ -107,15 +100,15 @@ config_api() ->
get => #{ get => #{
description => <<"get retainer config">>, description => <<"get retainer config">>,
responses => #{ responses => #{
<<"200">> => schema(mqtt_retainer, <<"Get configs successfully">>), <<"200">> => schema(conf_schema(), <<"Get configs successfully">>),
<<"404">> => error_schema(<<"Config not found">>, ['NOT_FOUND']) <<"404">> => error_schema(<<"Config not found">>, ['NOT_FOUND'])
} }
}, },
put => #{ put => #{
description => <<"Update retainer config">>, description => <<"Update retainer config">>,
'requestBody' => schema(mqtt_retainer), 'requestBody' => schema(conf_schema()),
responses => #{ responses => #{
<<"200">> => schema(mqtt_retainer, <<"Update configs successfully">>), <<"200">> => schema(conf_schema(), <<"Update configs successfully">>),
<<"400">> => error_schema(<<"Update configs failed">>, ['UPDATE_FAILED']) <<"400">> => error_schema(<<"Update configs failed">>, ['UPDATE_FAILED'])
} }
} }

View File

@ -29,22 +29,22 @@
]). ]).
api_spec() -> api_spec() ->
{statsd_api(), schemas()}. {statsd_api(), []}.
schemas() -> conf_schema() ->
[#{statsd => emqx_mgmt_api_configs:gen_schema(emqx:get_raw_config([statsd]))}]. emqx_mgmt_api_configs:gen_schema(emqx:get_raw_config([statsd])).
statsd_api() -> statsd_api() ->
Metadata = #{ Metadata = #{
get => #{ get => #{
description => <<"Get statsd info">>, description => <<"Get statsd info">>,
responses => #{<<"200">> => schema(statsd)} responses => #{<<"200">> => schema(conf_schema())}
}, },
put => #{ put => #{
description => <<"Update Statsd">>, description => <<"Update Statsd">>,
'requestBody' => schema(statsd), 'requestBody' => schema(conf_schema()),
responses => #{ responses => #{
<<"200">> => schema(statsd), <<"200">> => schema(conf_schema()),
<<"400">> => bad_request() <<"400">> => bad_request()
} }
} }