Closed
Conversation
Add a comprehensive how-to guide for backend plugin developers on defining and registering custom backend functions using sdk.api.register(). The guide covers: - When and why to define custom backend functions - Type safety patterns with DefineAPI - Function registration and parameter handling - Error handling and async operations - Simple and advanced code examples - Best practices for backend function design - Cross-references to related guides Also reorganize the Backend Guides sidebar section to include a new "Custom Functions" subsection that groups function definition and calling guides together. Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
caidobot
temporarily deployed
to
main-382e18c10d6834cf - doc-developer PR #105
Render
Destroyed
Member
|
Already exists under a different article name. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Added a comprehensive how-to guide for backend SDK developers on how to define and register custom functions using the
sdk.api.register()method.What's new:
New guide:
src/guides/backend_functions.md— A complete how-to guide covering:Updated
src/guidessidebar configuration to organize custom functions guides under a "Custom Functions" subsection in Backend GuidesGap Addressed
This guide addresses a documentation gap identified in the SDK surface analysis (backend SDK → custom API functions). It enables backend plugin developers to understand and implement custom function registration, a core backend SDK feature.
Related Documentation
src/reference/sdks/backend/api/