chore: add comments to explain`/status` cant be found in swagger docs
This commit is contained in:
parent
7d7b05ae4e
commit
d43b680f14
|
@ -20,6 +20,13 @@
|
||||||
path/0
|
path/0
|
||||||
]).
|
]).
|
||||||
|
|
||||||
|
%% Note: Because swagger now requires an HTTP prefix (e.g. /api/v5),
|
||||||
|
%% but the `/status` does not require this fixed prefix.
|
||||||
|
%%
|
||||||
|
%% Changing the swagger framework was too big, so we implemented the `/status`
|
||||||
|
%% in a simple way first
|
||||||
|
%%
|
||||||
|
%% XXX: So the HTTP API docs generated by swagger can not find this API now
|
||||||
path() ->
|
path() ->
|
||||||
"/status".
|
"/status".
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue