Add Functions API documentation for the commit flow#380
Open
c1-dev-bot[bot] wants to merge 1 commit into
Open
Conversation
Document the working three-step commit flow for editing function code via the REST API (CreateInitialCommit -> upload -> CreateFinalCommit), which is currently undocumented. Also covers creating, publishing, listing, deleting, invoking, and testing functions via API.
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
sathyasaravanamuthu
approved these changes
Jul 7, 2026
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
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
Add a new documentation page (
product/admin/functions-api.mdx) that documents how to manage functions programmatically via the C1 REST API.The existing Functions docs cover only the web UI workflow. This page documents:
initialContentpublishedCommitIdWhy
The API reference (auto-generated from the OpenAPI spec) advertises a
contentfield on the commit endpoint that the server does not accept (HTTP 400). Without documentation of the working three-step flow, API users are forced to delete and recreate functions to update code — which generates new function IDs and breaks bound hooks, vault secrets, egress allowlists, and saved references.Fixes: FN-524
Automated PR Notice
This PR was automatically created by c1-dev-bot as a potential implementation.
This code requires: