[Docs]: Update Build Handler
section
#9209
Labels
documentation
Documentation needs to be added or changed
Build Handler
section
#9209
Short description of what should be added or improved
Changes in this PR allow to hide sensitive information in a query response. In order to make this possible, arguments that should be hidden need to be properly defined in handler files:
DB
handlers,connection_args
andconnection_args_example
should be placed in separate file from file with handler class (for example). Import ofconnection_args
andconnection_args_example
should be placed outside oftry/catch
block in__init__.py
(for example).connection_args
a new property has been added:secret
. When it set toTrue
, then this field will be replaced to******
in query responses (for example).creation
andusing
arguments should be described in same way and exported ascreation_args
andmodel_using_args
(names are not best, may be changed in future, example here and here)This is not mandatory for handlers, but when
connection_args
are separated from the handler class, they can be read even if the handler class is broken. Therefore, theconnection_args
of this handler can be used in a microservice architecture without having to import the dependencies of the handler. Additionally, if this handler were to fail (for example, if one of its dependencies were to update incorrectly), thesecret
would still be hidden, as we can still access theconnection_args
.Video or screenshots
No response
Anything else?
No response
The text was updated successfully, but these errors were encountered: