docs: add namespace to authn and authz schema

This commit is contained in:
Zaiming (Stone) Shi 2023-11-08 10:47:16 +01:00
parent 5aeb1feada
commit 3d20e566d8
14 changed files with 50 additions and 8 deletions

View File

@ -27,7 +27,8 @@
validations/0, validations/0,
desc/1, desc/1,
refs/0, refs/0,
select_union_member/1 select_union_member/1,
namespace/0
]). ]).
-define(NOT_EMPTY(MSG), emqx_resource_validator:not_empty(MSG)). -define(NOT_EMPTY(MSG), emqx_resource_validator:not_empty(MSG)).
@ -38,6 +39,8 @@
}) })
). ).
namespace() -> "authn".
refs() -> refs() ->
[?R_REF(http_get), ?R_REF(http_post)]. [?R_REF(http_get), ?R_REF(http_post)].

View File

@ -26,7 +26,8 @@
fields/1, fields/1,
desc/1, desc/1,
source_refs/0, source_refs/0,
select_union_member/1 select_union_member/1,
namespace/0
]). ]).
-export([ -export([
@ -38,6 +39,8 @@
-import(emqx_schema, [mk_duration/2]). -import(emqx_schema, [mk_duration/2]).
namespace() -> "authz".
type() -> ?AUTHZ_TYPE. type() -> ?AUTHZ_TYPE.
source_refs() -> source_refs() ->

View File

@ -25,9 +25,12 @@
fields/1, fields/1,
desc/1, desc/1,
refs/0, refs/0,
select_union_member/1 select_union_member/1,
namespace/0
]). ]).
namespace() -> "authn".
refs() -> refs() ->
[?R_REF(ldap_bind)]. [?R_REF(ldap_bind)].

View File

@ -26,9 +26,12 @@
fields/1, fields/1,
desc/1, desc/1,
source_refs/0, source_refs/0,
select_union_member/1 select_union_member/1,
namespace/0
]). ]).
namespace() -> "authz".
type() -> ?AUTHZ_TYPE. type() -> ?AUTHZ_TYPE.
fields(ldap) -> fields(ldap) ->

View File

@ -25,9 +25,12 @@
fields/1, fields/1,
desc/1, desc/1,
refs/1, refs/1,
select_union_member/2 select_union_member/2,
namespace/0
]). ]).
namespace() -> "authn".
refs(api_write) -> refs(api_write) ->
[?R_REF(builtin_db_api)]; [?R_REF(builtin_db_api)];
refs(_) -> refs(_) ->

View File

@ -26,9 +26,12 @@
fields/1, fields/1,
desc/1, desc/1,
source_refs/0, source_refs/0,
select_union_member/1 select_union_member/1,
namespace/0
]). ]).
namespace() -> "authz".
type() -> ?AUTHZ_TYPE. type() -> ?AUTHZ_TYPE.
fields(builtin_db) -> fields(builtin_db) ->

View File

@ -25,9 +25,12 @@
fields/1, fields/1,
desc/1, desc/1,
refs/0, refs/0,
select_union_member/1 select_union_member/1,
namespace/0
]). ]).
namespace() -> "authn".
refs() -> refs() ->
[ [
?R_REF(mongo_single), ?R_REF(mongo_single),

View File

@ -24,9 +24,12 @@
fields/1, fields/1,
desc/1, desc/1,
source_refs/0, source_refs/0,
select_union_member/1 select_union_member/1,
namespace/0
]). ]).
namespace() -> "authz".
type() -> ?AUTHZ_TYPE. type() -> ?AUTHZ_TYPE.
source_refs() -> source_refs() ->

View File

@ -22,12 +22,15 @@
-behaviour(emqx_authn_schema). -behaviour(emqx_authn_schema).
-export([ -export([
namespace/0,
fields/1, fields/1,
desc/1, desc/1,
refs/0, refs/0,
select_union_member/1 select_union_member/1
]). ]).
namespace() -> "authn".
refs() -> refs() ->
[?R_REF(mysql)]. [?R_REF(mysql)].

View File

@ -22,6 +22,7 @@
-behaviour(emqx_authz_schema). -behaviour(emqx_authz_schema).
-export([ -export([
namespace/0,
type/0, type/0,
fields/1, fields/1,
desc/1, desc/1,
@ -29,6 +30,8 @@
select_union_member/1 select_union_member/1
]). ]).
namespace() -> "authz".
type() -> ?AUTHZ_TYPE. type() -> ?AUTHZ_TYPE.
fields(mysql) -> fields(mysql) ->

View File

@ -22,12 +22,15 @@
-behaviour(emqx_authn_schema). -behaviour(emqx_authn_schema).
-export([ -export([
namespace/0,
fields/1, fields/1,
desc/1, desc/1,
refs/0, refs/0,
select_union_member/1 select_union_member/1
]). ]).
namespace() -> "authn".
select_union_member( select_union_member(
#{ #{
<<"mechanism">> := ?AUTHN_MECHANISM_BIN, <<"backend">> := ?AUTHN_BACKEND_BIN <<"mechanism">> := ?AUTHN_MECHANISM_BIN, <<"backend">> := ?AUTHN_BACKEND_BIN

View File

@ -22,6 +22,7 @@
-behaviour(emqx_authz_schema). -behaviour(emqx_authz_schema).
-export([ -export([
namespace/0,
type/0, type/0,
fields/1, fields/1,
desc/1, desc/1,
@ -29,6 +30,8 @@
select_union_member/1 select_union_member/1
]). ]).
namespace() -> "authz".
type() -> ?AUTHZ_TYPE. type() -> ?AUTHZ_TYPE.
fields(postgresql) -> fields(postgresql) ->

View File

@ -22,12 +22,15 @@
-behaviour(emqx_authn_schema). -behaviour(emqx_authn_schema).
-export([ -export([
namespace/0,
fields/1, fields/1,
desc/1, desc/1,
refs/0, refs/0,
select_union_member/1 select_union_member/1
]). ]).
namespace() -> "authn".
refs() -> refs() ->
[ [
?R_REF(redis_single), ?R_REF(redis_single),

View File

@ -22,6 +22,7 @@
-behaviour(emqx_authz_schema). -behaviour(emqx_authz_schema).
-export([ -export([
namespace/0,
type/0, type/0,
fields/1, fields/1,
desc/1, desc/1,
@ -29,6 +30,8 @@
select_union_member/1 select_union_member/1
]). ]).
namespace() -> "authz".
type() -> ?AUTHZ_TYPE. type() -> ?AUTHZ_TYPE.
fields(redis_single) -> fields(redis_single) ->