Skip to content

Repair two rendering defects in the SDK reference #275

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.

Sign up for GitHub

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

Closed
daniellekorn wants to merge 1 commit into from
Closed

Repair two rendering defects in the SDK reference #275

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
fix(docs): repair two rendering defects in the SDK reference 
1. Four auth examples and two integrations examples lost their first line
of code. The pipeline promotes a leading // comment to the Mintlify
code-block title, and an example without one has its first real line
consumed instead. inviteUser, resetPasswordRequest, resetPassword and
changePassword each published a try block with no try, and an orphaned
closing brace. These six are live on the site today. Each now opens with a
comment that describes the example.

2. connectors.callApi() published its query parameter as
Record<string, ... | ... | ... | ... | ...>. TypeDoc truncates long inline
unions, so the union is given a name, ConnectorApiQueryValue, and appended
into the connectors page. It renders as Record<string,
ConnectorApiQueryValue> with the definition alongside the method.

Both fix the cause. Neither touches the post-processing pipeline.
  • Loading branch information
@daniellekorn
daniellekorn committed Sep 6, 2026
commit e3daa4526f3cf363ab7c9bef49e4d10606c04b53
5 changes: 4 additions & 1 deletion scripts/mintlify-post-processing/appended-articles.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,13 @@
"interfaces/ConnectorIntegrationTypeRegistry",
"interfaces/UserConnectorsModule",
"interfaces/ConnectorApiRequest",
"type-aliases/ConnectorApiQueryValue",
"interfaces/ConnectorApiResponse",
"type-aliases/ConnectorApiResponsePhase"
],
"interfaces/AppModule": ["interfaces/AppPublicSettingsResponse"],
"interfaces/AppModule": [
"interfaces/AppPublicSettingsResponse"
],
"type-aliases/EntitiesModule": [
"interfaces/EntityHandler",
"type-aliases/EntityRecord",
Expand Down
3 changes: 2 additions & 1 deletion scripts/mintlify-post-processing/types-to-expose.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,14 @@
"AppModule",
"AppPublicSettingsResponse",
"AuthModule",
"ConnectorApiQueryValue",
"ConnectorApiRequest",
"ConnectorApiResponse",
"ConnectorApiResponsePhase",
"ConnectorIntegrationType",
"ConnectorIntegrationTypeRegistry",
"ConnectorsModule",
"CoreIntegrations",
"CustomIntegrationsModule",
"DeleteManyResult",
"DeleteResult",
Expand All @@ -27,7 +29,6 @@
"FunctionsModule",
"ImportResult",
"IntegrationsModule",
"CoreIntegrations",
"SortField",
"SsoModule",
"UpdateManyResult"
Expand Down
4 changes: 4 additions & 0 deletions src/modules/auth.types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -357,6 +357,7 @@ export interface AuthModule {
*
* @example
* ```typescript
* // Invite a user and handle failure
* try {
* await base44.auth.inviteUser('newuser@example.com', 'user');
* console.log('Invitation sent successfully!');
Expand Down Expand Up @@ -491,6 +492,7 @@ export interface AuthModule {
*
* @example
* ```typescript
* // Request a password reset email
* try {
* await base44.auth.resetPasswordRequest('user@example.com');
* console.log('Password reset email sent!');
Expand All @@ -513,6 +515,7 @@ export interface AuthModule {
*
* @example
* ```typescript
* // Complete a password reset with the emailed token
* try {
* await base44.auth.resetPassword({
* resetToken: 'token-from-email',
Expand All @@ -538,6 +541,7 @@ export interface AuthModule {
*
* @example
* ```typescript
* // Change the password for a signed-in user
* try {
* await base44.auth.changePassword({
* userId: 'user-123',
Expand Down
9 changes: 8 additions & 1 deletion src/modules/connectors.types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,13 @@ export type ConnectorApiResponsePhase =
/**
* A request to forward to a metered connector's API through the Base44 proxy.
*/
/** A value acceptable as a query parameter on {@link ConnectorApiRequest.query}. */
export type ConnectorApiQueryValue =
| string
| number
| boolean
| Array<string | number>;

export interface ConnectorApiRequest {
/** HTTP method for the upstream request. Defaults to `'GET'`. */
method?: "GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "HEAD";
Expand All @@ -81,7 +88,7 @@ export interface ConnectorApiRequest {
*/
path: string;
/** Query parameters. Merged into the request URL alongside any already present in {@link path}. */
query?: Record<string, string | number | boolean | Array<string | number>>;
query?: Record<string, ConnectorApiQueryValue>;
/** Extra request headers. Only headers the connector explicitly allows are forwarded; the rest are dropped. */
headers?: Record<string, string>;
/** JSON request body. Ignored for `GET` and `HEAD`. */
Expand Down
2 changes: 2 additions & 0 deletions src/modules/integrations.types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -401,6 +401,7 @@ export type IntegrationsModule = {
*
* @example
* ```typescript
* // Summarise text with an LLM
* const response = await base44.integrations.Core.InvokeLLM({
* prompt: 'Explain quantum computing',
* model: 'gpt_5'
Expand All @@ -414,6 +415,7 @@ export type IntegrationsModule = {
*
* @example
* ```typescript
* // Call a custom integration endpoint
* const result = await base44.integrations.custom.call(
* 'github',
* 'get:/repos/{owner}/{repo}',
Expand Down
Loading