OBJECT
ApiAuthenticatorFunction
A managed Function used in API-based Nodes (e.g. - WebhookNode).
link GraphQL Schema definition
- type ApiAuthenticatorFunction implements Function {
- # A Python code string that contains a single top-level function definition.
- #
- # This function is used as a template when creating authentication in WebhookNodes
- #
- # that use this MessageType. This function must have the signature
- #
- # (*, context, conn, **kwargs) where context is an EchoStream Context and conn
- #
- # is a fastapi.Request and returns a tuple containing a
- #
- # starlette.authentication.AuthCredentials and starlette.authentication.BaseUser
- # (or subclasses).
- #
- #
- # This function should throw fastapi.HTTPException when authentication fails.
- String! :
- # When and who created.
- AtBy! :
- # A human-readable description.
- String! :
- # True if this is used by other resources.
- Boolean! :
- # When and who modified.
- AtBy! :
- # The name.
- String! :
- # README in MarkDown format.
- String :
- # The list of Python requirements, in pip format.
- String!] : [
- # True if this is an EchoStream system resource.
- Boolean :
- # The Tenant.
- Tenant :
- # Deletes this.
- Boolean! :
- # Lists the changes.
- #
- # Arguments
- # endDateTime: The end date/time (inclusive) to list changes for
- # in ISO8601 format. Defaults to now.
- # exclusiveStartKey: The lastEvaluatedKey from a previous
- # ChangeResult. Used when paginating.
- # limit: Used for limiting the number of results when paginating.
- # Defaults to "all".
- # sortAscending: True for ascending results, False for descending
- # result. Defaults to True.
- # startDateTime: The start date/time (inclusive) to list changes
- # for in ISO8601 format. Defaults to the beginning of time.
- (
- AWSDateTime, :
- AWSJSON, :
- Int, :
- Boolean, :
- AWSDateTime :
- ): ChangeResult!
- # Updates the Function. Note that all Nodes that use this Function may also be
- # updated - see blow.
- #
- # Arguments
- # code: A Python code string that contains a single top-level
- # function definition.
- # This function is used as a template when creating custom processing in
- # ProcessorNodes
- # that use this MessageType. This function must have the signature
- # (*, context, message, source, **kwargs) and return None, a string or a list of
- # strings.
- # description: The description. Null is ignored.
- # readme: The README. Must be in MarkDown format. Null removes
- # the readme.
- # The README in MarkDown format.
- # requirements: The requirements. Each element must be in pip
- # requirement format. Null or an empty list removes all requirements.
- (
- String, :
- String, :
- String, :
- String!] : [
- ): ApiAuthenticatorFunction!
- # Validates the supplied code against the supplied message.
- #
- # Arguments
- # code: The code to validate.
- # request: The request to use for validation. This is a JSON
- # representation of a starlette Request object.
- # loggingLevel: The loggingLevel to use during the validation.
- # Defaults to INFO.
- String!, : AWSJSON!, : LogLevel): ValidationResult! ( :
- }
link Require by
- ApiAuthenticatorFunctionA managed Function used in API-based Nodes (e.g. - WebhookNode).
- EchoA union of all EchoStream object types
- MutationRoot Mutation
- WebhookNodeWebhookNodes allow for receiving of WebHooks from external senders in any JSON mime type. These messages are emitted as-is by the WebHookNode for further processing.
- WebSubHubNodeWebSubHubNodes implement the W3C WebSub Hub feature. They accept echo.websub messages that contain content that requires publishing to subscribers.