Skip to content

Add explicit callout for registering function in function factory #216

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Apr 29, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions fern/docs/pages/references/functions.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ Using functions, you can provide custom code and link it to your event sources,

In order to create a snap-in version, functions must be defined as shown in the [code samples](/snapin-development/code-samples). Functions are packaged and provided as an artifact at the time of snap-in version creation and then used to deploy functions to snap-in versions. An artifact may contain multiple function definitions. The artifact is a zip file containing the following files:


```bash
/
├── src/
Expand All @@ -26,4 +27,9 @@ functions:
- `name`: It is the function name that should match the corresponding function name in the folder.
- `description`: It describes the function.


<Callout intent="note">
Each function should be registered in `src/function-factory.ts` to be available for execution.
</Callout>

Refer to the [function invocation](/snapin-development/references/function-invocation) for details about the exact payload of the function.
Loading