WebhookGateway
class¶
Warning
The current page still doesn't have a translation for this language.
But you can help translating it: Contributing.
This is the reference for the WebhookGateway
that contains all the parameters,
attributes and functions.
How to import¶
from esmerald import WebhookGateway
esmerald.WebhookGateway
¶
WebhookGateway(*, handler, name=None, include_in_schema=True, parent=None, deprecated=None, security=None, before_request=None, after_request=None, tags=None)
Bases: Path
, Dispatcher
, GatewayUtil
WebhookGateway
object class used by Esmerald routes.
The WebhookGateway act as a brigde between the webhook handlers and the main Esmerald routing system.
Read more about WebhookGateway and how to use it.
Note
This is used for OpenAPI documentation purposes only.
PARAMETER | DESCRIPTION |
---|---|
handler
|
An instance of handler.
TYPE:
|
name
|
The name for the WebhookGateway.
TYPE:
|
include_in_schema
|
Boolean flag indicating if it should be added to the OpenAPI docs.
TYPE:
|
parent
|
Who owns the Gateway. If not specified, the application automatically it assign it. This is directly related with the application levels.
TYPE:
|
deprecated
|
Boolean flag for indicating the deprecation of the Gateway and to display it in the OpenAPI documentation..
TYPE:
|
security
|
Used by OpenAPI definition, the security must be compliant with the norms. Esmerald offers some out of the box solutions where this is implemented. The Esmerald security is available to automatically used. The security can be applied also on a level basis. For custom security objects, you must subclass
TYPE:
|
before_request
|
A Read more about the events.
TYPE:
|
after_request
|
A Read more about the events.
TYPE:
|
tags
|
A list of strings tags to be applied to the path operation. It will be added to the generated OpenAPI documentation. Note almost everything in Esmerald can be done in levels, which means these tags on a Esmerald instance, means it will be added to every route even if those routes also contain tags.
TYPE:
|
Source code in esmerald/routing/gateways.py
815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 |
|