Repository navigation
Conversation
The gateway serves OpenAI's video endpoints alongside chat completions and images, so add a Video section and an example to the aiGateway JSDoc, and point them at the new guide for the model list and request options. Video generation is asynchronous and has no `automatic` model, which is the part most likely to trip someone up, so both are called out in the summary rather than left to the guide. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Contributor
🚀 Package Preview Available!Install this PR's preview build with npm: npm i @base44-preview/sdk@0.8.52-pr.305.970f972Prefer not to change any import paths? Install using npm alias so your code still imports npm i "@base44/sdk@npm:@base44-preview/sdk@0.8.52-pr.305.970f972"Or add it to your {
"dependencies": {
"@base44/sdk": "npm:@base44-preview/sdk@0.8.52-pr.305.970f972"
}
}
Preview published to npm registry — try new features instantly! |
Codifies two style rules in the sdk-docs-writing skill and fixes the aiGateway JSDoc to follow them. Prose now uses periods and commas. Colons survive only on a line that introduces a list and in the `label: description` form of a definition bullet, semicolons are out entirely, and parentheses need a reason that a comma can't carry. Call syntax like `connection()` isn't a prose paren. A sentence also never opens with a lowercase backticked identifier. JSDoc is especially prone to it because the identifier being documented is top of mind, so the skill gives the recasts that read better. Fixes in ai-gateway.types.ts, which renders straight into the published reference: the asynchronous-video colon, the image-models colon, the service-role colon, two TypeSafe semicolons, and the two paragraphs that opened on `connection()`. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Every example calls `base44.asServiceRole.aiGateway.connection()` without saying why, which reads like needless privilege. It isn't. An app with `control_core_integrations` on rejects a user-token gateway call unless its visibility is `private_with_login` or `workspace_with_login`, and nothing populates `allowed_core_integrations` automatically. Apps created with the backend-functions capability get the restriction at creation, so a user-token call works in the builder and then 403s once the app is shared publicly. Spells that out in Authentication Modes, and adds the reassurance that matters alongside it: the mode picks the token and nothing more. The gateway runs a model and never reads app data, so entity access is governed by the `base44.entities` calls around it and should be chosen separately. Also unwraps a ragged line left by the earlier semicolon fix. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
wixysam
added a commit
that referenced
this pull request
Nov 3, 2026
…ole methods into it (#364) * docs(payments): review the payments reference and merge the service role methods into it Payments JSDoc: house-style fixes, a fuller overview, provider and authentication sections, method order that follows the checkout flow, cross-links between the user and service role methods, error code links, and new examples for the Stripe success page and confirming a purchase in a backend function. "Wix Payments" is now "Base44 Payments", the product name. Docs pipeline: - Append ServiceRolePaymentsModule onto the payments page as "Service role methods", and group PaymentsErrorCode under an Errors heading. - An appended module's section is headed with its interface name, so typesWithOwnMethods can rename it. The connectors and integrations special cases match the new headings. - Links back to the host module, or to an appended module by its slug, become same-page anchors. - A Returns section shows the method's @returns text and only falls back to the return type's description when there is none. - AiGatewayConnectionOptions, ConnectorApiRequest, and ConnectorApiResponse render inline and no longer get their own pages. Also brings in the AI Gateway video JSDoc from #305 and the prose fixes already published for that page, moves two return-type details into @returns so they still show, and adds skill rules for links, framework- neutral examples, and "the current user". Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * docs(connectors): review the metered connector and callApi() docs House-style fixes: no em dashes, prose semicolons or colon breaks, no status code in prose, contractions, and plain code names instead of {@link} on properties, where the pipeline drops the link. Says "credits" now that metered calls bill unified credits, counts the three tips correctly, and stops pointing callApi()'s integration type at the Available connectors table, which lists getConnection() connectors only. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * docs(platform): say the platform clients have one property per module The Returns rule now shows @returns instead of the return type's description, so carry the type's detail into @returns. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
Collaborator
Author
|
Superseded by #364, which includes this video JSDoc. |
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.
The AI Gateway serves OpenAI's video endpoints alongside chat completions and images, but the
aiGatewayJSDoc only described the first two.Adds a
## Videosection and a video@exampleto the module docs, pointing at a new guide for the model list and request options.Two things get called out in the summary rather than left to the guide, because they're the most likely to trip someone up:
POST /videosreturns a job and you pollGET /videos/{id}, which can take minutes.automaticmodel, unlike chat and images, somodelis required.The companion guide is in base44-dev/mintlify-docs#2363, which also carries the regenerated
ai-gateway.mdx. Merging this first keeps the source and the generated page in step, but either order works since the generated output is already committed there.Testing
npm run test:typespassesnpm run buildpassesnpm run create-docs-localrenders the Video section and the example correctlyComment-only change, no runtime or type surface is touched.
🤖 Generated with Claude Code