Sfoglia il codice sorgente

fix(authn): api description using binary string

JimMoen 4 anni fa
parent
commit
a399ac20e9
1 ha cambiato i file con 50 aggiunte e 50 eliminazioni
  1. 50 50
      apps/emqx_authn/src/emqx_authn_api.erl

+ 50 - 50
apps/emqx_authn/src/emqx_authn_api.erl

@@ -250,7 +250,7 @@ users4_api() ->
 
 
 create_authenticator_api_spec() ->
 create_authenticator_api_spec() ->
     #{
     #{
-        description => "Create a authenticator for global authentication",
+        description => <<"Create a authenticator for global authentication">>,
         requestBody => #{
         requestBody => #{
             content => #{
             content => #{
                 'application/json' => #{
                 'application/json' => #{
@@ -319,7 +319,7 @@ create_authenticator_api_spec() ->
 create_authenticator_api_spec2() ->
 create_authenticator_api_spec2() ->
     Spec = create_authenticator_api_spec(),
     Spec = create_authenticator_api_spec(),
     Spec#{
     Spec#{
-        description => "Create a authenticator for listener",
+        description => <<"Create a authenticator for listener">>,
         parameters => [
         parameters => [
             #{
             #{
                 name => listener_id,
                 name => listener_id,
@@ -334,7 +334,7 @@ create_authenticator_api_spec2() ->
 
 
 list_authenticators_api_spec() ->
 list_authenticators_api_spec() ->
     #{
     #{
-        description => "List authenticators for global authentication",
+        description => <<"List authenticators for global authentication">>,
         responses => #{
         responses => #{
             <<"200">> => #{
             <<"200">> => #{
                 description => <<"OK">>,
                 description => <<"OK">>,
@@ -357,7 +357,7 @@ list_authenticators_api_spec() ->
 list_authenticators_api_spec2() ->
 list_authenticators_api_spec2() ->
     Spec = list_authenticators_api_spec(),
     Spec = list_authenticators_api_spec(),
     Spec#{
     Spec#{
-        description => "List authenticators for listener",
+        description => <<"List authenticators for listener">>,
         parameters => [
         parameters => [
             #{
             #{
                 name => listener_id,
                 name => listener_id,
@@ -372,12 +372,12 @@ list_authenticators_api_spec2() ->
 
 
 find_authenticator_api_spec() ->
 find_authenticator_api_spec() ->
     #{
     #{
-        description => "Get authenticator by id",
+        description => <<"Get authenticator by id">>,
         parameters => [
         parameters => [
             #{
             #{
                 name => id,
                 name => id,
                 in => path,
                 in => path,
-                description => "Authenticator id",
+                description => <<"Authenticator id">>,
                 schema => #{
                 schema => #{
                     type => string
                     type => string
                 },
                 },
@@ -426,7 +426,7 @@ find_authenticator_api_spec2() ->
             #{
             #{
                 name => listener_id,
                 name => listener_id,
                 in => path,
                 in => path,
-                description => "Listener id",
+                description => <<"Listener id">>,
                 schema => #{
                 schema => #{
                     type => string
                     type => string
                 },
                 },
@@ -435,7 +435,7 @@ find_authenticator_api_spec2() ->
             #{
             #{
                 name => id,
                 name => id,
                 in => path,
                 in => path,
-                description => "Authenticator id",
+                description => <<"Authenticator id">>,
                 schema => #{
                 schema => #{
                     type => string
                     type => string
                 },
                 },
@@ -446,12 +446,12 @@ find_authenticator_api_spec2() ->
 
 
 update_authenticator_api_spec() ->
 update_authenticator_api_spec() ->
     #{
     #{
-        description => "Update authenticator",
+        description => <<"Update authenticator">>,
         parameters => [
         parameters => [
             #{
             #{
                 name => id,
                 name => id,
                 in => path,
                 in => path,
-                description => "Authenticator id",
+                description => <<"Authenticator id">>,
                 schema => #{
                 schema => #{
                     type => string
                     type => string
                 },
                 },
@@ -531,7 +531,7 @@ update_authenticator_api_spec2() ->
             #{
             #{
                 name => listener_id,
                 name => listener_id,
                 in => path,
                 in => path,
-                description => "Listener id",
+                description => <<"Listener id">>,
                 schema => #{
                 schema => #{
                     type => string
                     type => string
                 },
                 },
@@ -540,7 +540,7 @@ update_authenticator_api_spec2() ->
             #{
             #{
                 name => id,
                 name => id,
                 in => path,
                 in => path,
-                description => "Authenticator id",
+                description => <<"Authenticator id">>,
                 schema => #{
                 schema => #{
                     type => string
                     type => string
                 },
                 },
@@ -551,12 +551,12 @@ update_authenticator_api_spec2() ->
 
 
 delete_authenticator_api_spec() ->
 delete_authenticator_api_spec() ->
     #{
     #{
-        description => "Delete authenticator",
+        description => <<"Delete authenticator">>,
         parameters => [
         parameters => [
             #{
             #{
                 name => id,
                 name => id,
                 in => path,
                 in => path,
-                description => "Authenticator id",
+                description => <<"Authenticator id">>,
                 schema => #{
                 schema => #{
                     type => string
                     type => string
                 },
                 },
@@ -578,7 +578,7 @@ delete_authenticator_api_spec2() ->
             #{
             #{
                 name => listener_id,
                 name => listener_id,
                 in => path,
                 in => path,
-                description => "Listener id",
+                description => <<"Listener id">>,
                 schema => #{
                 schema => #{
                     type => string
                     type => string
                 },
                 },
@@ -587,7 +587,7 @@ delete_authenticator_api_spec2() ->
             #{
             #{
                 name => id,
                 name => id,
                 in => path,
                 in => path,
-                description => "Authenticator id",
+                description => <<"Authenticator id">>,
                 schema => #{
                 schema => #{
                     type => string
                     type => string
                 },
                 },
@@ -598,12 +598,12 @@ delete_authenticator_api_spec2() ->
 
 
 move_authenticator_api_spec() ->
 move_authenticator_api_spec() ->
     #{
     #{
-        description => "Move authenticator",
+        description => <<"Move authenticator">>,
         parameters => [
         parameters => [
             #{
             #{
                 name => id,
                 name => id,
                 in => path,
                 in => path,
-                description => "Authenticator id",
+                description => <<"Authenticator id">>,
                 schema => #{
                 schema => #{
                     type => string
                     type => string
                 },
                 },
@@ -658,7 +658,7 @@ move_authenticator_api_spec2() ->
             #{
             #{
                 name => listener_id,
                 name => listener_id,
                 in => path,
                 in => path,
-                description => "Listener id",
+                description => <<"Listener id">>,
                 schema => #{
                 schema => #{
                     type => string
                     type => string
                 },
                 },
@@ -667,7 +667,7 @@ move_authenticator_api_spec2() ->
             #{
             #{
                 name => id,
                 name => id,
                 in => path,
                 in => path,
-                description => "Authenticator id",
+                description => <<"Authenticator id">>,
                 schema => #{
                 schema => #{
                     type => string
                     type => string
                 },
                 },
@@ -678,12 +678,12 @@ move_authenticator_api_spec2() ->
 
 
 import_users_api_spec() ->
 import_users_api_spec() ->
     #{
     #{
-        description => "Import users from json/csv file",
+        description => <<"Import users from json/csv file">>,
         parameters => [
         parameters => [
             #{
             #{
                 name => id,
                 name => id,
                 in => path,
                 in => path,
-                description => "Authenticator id",
+                description => <<"Authenticator id">>,
                 schema => #{
                 schema => #{
                     type => string
                     type => string
                 },
                 },
@@ -721,7 +721,7 @@ import_users_api_spec2() ->
             #{
             #{
                 name => listener_id,
                 name => listener_id,
                 in => path,
                 in => path,
-                description => "Listener id",
+                description => <<"Listener id">>,
                 schema => #{
                 schema => #{
                     type => string
                     type => string
                 },
                 },
@@ -730,7 +730,7 @@ import_users_api_spec2() ->
             #{
             #{
                 name => id,
                 name => id,
                 in => path,
                 in => path,
-                description => "Authenticator id",
+                description => <<"Authenticator id">>,
                 schema => #{
                 schema => #{
                     type => string
                     type => string
                 },
                 },
@@ -741,12 +741,12 @@ import_users_api_spec2() ->
 
 
 create_user_api_spec() ->
 create_user_api_spec() ->
     #{
     #{
-        description => "Add user",
+        description => <<"Add user">>,
         parameters => [
         parameters => [
             #{
             #{
                 name => id,
                 name => id,
                 in => path,
                 in => path,
-                description => "Authenticator id",
+                description => <<"Authenticator id">>,
                 schema => #{
                 schema => #{
                     type => string
                     type => string
                 },
                 },
@@ -806,7 +806,7 @@ create_user_api_spec2() ->
             #{
             #{
                 name => listener_id,
                 name => listener_id,
                 in => path,
                 in => path,
-                description => "Listener id",
+                description => <<"Listener id">>,
                 schema => #{
                 schema => #{
                     type => string
                     type => string
                 },
                 },
@@ -815,7 +815,7 @@ create_user_api_spec2() ->
             #{
             #{
                 name => id,
                 name => id,
                 in => path,
                 in => path,
-                description => "Authenticator id",
+                description => <<"Authenticator id">>,
                 schema => #{
                 schema => #{
                     type => string
                     type => string
                 },
                 },
@@ -826,12 +826,12 @@ create_user_api_spec2() ->
 
 
 list_users_api_spec() ->
 list_users_api_spec() ->
     #{
     #{
-        description => "List users",
+        description => <<"List users">>,
         parameters => [
         parameters => [
             #{
             #{
                 name => id,
                 name => id,
                 in => path,
                 in => path,
-                description => "Authenticator id",
+                description => <<"Authenticator id">>,
                 schema => #{
                 schema => #{
                     type => string
                     type => string
                 },
                 },
@@ -871,7 +871,7 @@ list_users_api_spec2() ->
             #{
             #{
                 name => listener_id,
                 name => listener_id,
                 in => path,
                 in => path,
-                description => "Listener id",
+                description => <<"Listener id">>,
                 schema => #{
                 schema => #{
                     type => string
                     type => string
                 },
                 },
@@ -880,7 +880,7 @@ list_users_api_spec2() ->
             #{
             #{
                 name => id,
                 name => id,
                 in => path,
                 in => path,
-                description => "Authenticator id",
+                description => <<"Authenticator id">>,
                 schema => #{
                 schema => #{
                     type => string
                     type => string
                 },
                 },
@@ -891,12 +891,12 @@ list_users_api_spec2() ->
 
 
 update_user_api_spec() ->
 update_user_api_spec() ->
     #{
     #{
-        description => "Update user",
+        description => <<"Update user">>,
         parameters => [
         parameters => [
             #{
             #{
                 name => id,
                 name => id,
                 in => path,
                 in => path,
-                description => "Authenticator id",
+                description => <<"Authenticator id">>,
                 schema => #{
                 schema => #{
                     type => string
                     type => string
                 },
                 },
@@ -905,7 +905,7 @@ update_user_api_spec() ->
             #{
             #{
                 name => user_id,
                 name => user_id,
                 in => path,
                 in => path,
-                description => "User id",
+                description => <<"User id">>,
                 schema => #{
                 schema => #{
                     type => string
                     type => string
                 },
                 },
@@ -963,7 +963,7 @@ update_user_api_spec2() ->
             #{
             #{
                 name => listener_id,
                 name => listener_id,
                 in => path,
                 in => path,
-                description => "Listener id",
+                description => <<"Listener id">>,
                 schema => #{
                 schema => #{
                     type => string
                     type => string
                 },
                 },
@@ -972,7 +972,7 @@ update_user_api_spec2() ->
             #{
             #{
                 name => id,
                 name => id,
                 in => path,
                 in => path,
-                description => "Authenticator id",
+                description => <<"Authenticator id">>,
                 schema => #{
                 schema => #{
                     type => string
                     type => string
                 },
                 },
@@ -981,7 +981,7 @@ update_user_api_spec2() ->
             #{
             #{
                 name => user_id,
                 name => user_id,
                 in => path,
                 in => path,
-                description => "User id",
+                description => <<"User id">>,
                 schema => #{
                 schema => #{
                     type => string
                     type => string
                 },
                 },
@@ -992,12 +992,12 @@ update_user_api_spec2() ->
 
 
 find_user_api_spec() ->
 find_user_api_spec() ->
     #{
     #{
-        description => "Get user info",
+        description => <<"Get user info">>,
         parameters => [
         parameters => [
             #{
             #{
                 name => id,
                 name => id,
                 in => path,
                 in => path,
-                description => "Authenticator id",
+                description => <<"Authenticator id">>,
                 schema => #{
                 schema => #{
                     type => string
                     type => string
                 },
                 },
@@ -1006,7 +1006,7 @@ find_user_api_spec() ->
             #{
             #{
                 name => user_id,
                 name => user_id,
                 in => path,
                 in => path,
-                description => "User id",
+                description => <<"User id">>,
                 schema => #{
                 schema => #{
                     type => string
                     type => string
                 },
                 },
@@ -1046,7 +1046,7 @@ find_user_api_spec2() ->
             #{
             #{
                 name => listener_id,
                 name => listener_id,
                 in => path,
                 in => path,
-                description => "Listener id",
+                description => <<"Listener id">>,
                 schema => #{
                 schema => #{
                     type => string
                     type => string
                 },
                 },
@@ -1055,7 +1055,7 @@ find_user_api_spec2() ->
             #{
             #{
                 name => id,
                 name => id,
                 in => path,
                 in => path,
-                description => "Authenticator id",
+                description => <<"Authenticator id">>,
                 schema => #{
                 schema => #{
                     type => string
                     type => string
                 },
                 },
@@ -1064,7 +1064,7 @@ find_user_api_spec2() ->
             #{
             #{
                 name => user_id,
                 name => user_id,
                 in => path,
                 in => path,
-                description => "User id",
+                description => <<"User id">>,
                 schema => #{
                 schema => #{
                     type => string
                     type => string
                 },
                 },
@@ -1075,12 +1075,12 @@ find_user_api_spec2() ->
 
 
 delete_user_api_spec() ->
 delete_user_api_spec() ->
     #{
     #{
-        description => "Delete user",
+        description => <<"Delete user">>,
         parameters => [
         parameters => [
             #{
             #{
                 name => id,
                 name => id,
                 in => path,
                 in => path,
-                description => "Authenticator id",
+                description => <<"Authenticator id">>,
                 schema => #{
                 schema => #{
                     type => string
                     type => string
                 },
                 },
@@ -1089,7 +1089,7 @@ delete_user_api_spec() ->
             #{
             #{
                 name => user_id,
                 name => user_id,
                 in => path,
                 in => path,
-                description => "User id",
+                description => <<"User id">>,
                 schema => #{
                 schema => #{
                     type => string
                     type => string
                 },
                 },
@@ -1111,7 +1111,7 @@ delete_user_api_spec2() ->
             #{
             #{
                 name => listener_id,
                 name => listener_id,
                 in => path,
                 in => path,
-                description => "Listener id",
+                description => <<"Listener id">>,
                 schema => #{
                 schema => #{
                     type => string
                     type => string
                 },
                 },
@@ -1120,7 +1120,7 @@ delete_user_api_spec2() ->
             #{
             #{
                 name => id,
                 name => id,
                 in => path,
                 in => path,
-                description => "Authenticator id",
+                description => <<"Authenticator id">>,
                 schema => #{
                 schema => #{
                     type => string
                     type => string
                 },
                 },
@@ -1129,7 +1129,7 @@ delete_user_api_spec2() ->
             #{
             #{
                 name => user_id,
                 name => user_id,
                 in => path,
                 in => path,
-                description => "User id",
+                description => <<"User id">>,
                 schema => #{
                 schema => #{
                     type => string
                     type => string
                 },
                 },