Skip to content

docs: update operation ID examples to method:path format #80

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

Merged
natansil merged 1 commit into from
Jan 15, 2026
Merged

docs: update operation ID examples to method:path format #80

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
8 changes: 4 additions & 4 deletions src/modules/custom-integrations.types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,8 +61,8 @@ export interface CustomIntegrationCallResponse {
* ```typescript
* // Call a custom GitHub integration
* const response = await base44.integrations.custom.call(
* "github", // integration slug (defined by workspace admin)
* "listIssues", // operation ID from the OpenAPI spec
* "github", // integration slug (defined by workspace admin)
* "get:/repos/{owner}/{repo}/issues", // endpoint in method:path format
* {
* pathParams: { owner: "myorg", repo: "myrepo" },
* queryParams: { state: "open", per_page: 100 }
Expand All @@ -81,7 +81,7 @@ export interface CustomIntegrationCallResponse {
* // Call with request body payload
* const response = await base44.integrations.custom.call(
* "github",
* "createIssue",
* "post:/repos/{owner}/{repo}/issues",
* {
* pathParams: { owner: "myorg", repo: "myrepo" },
* payload: {
Expand All @@ -98,7 +98,7 @@ export interface CustomIntegrationsModule {
* Call a custom integration endpoint.
*
* @param slug - The integration's unique identifier (slug), as defined by the workspace admin.
* @param operationId - The operation ID from the OpenAPI spec (e.g., "listIssues", "getUser").
* @param operationId - The endpoint identifier in method:path format (e.g., "get:/repos/{owner}/{repo}/issues", "get:/users/{username}").
* @param params - Optional parameters including payload, pathParams, queryParams, and headers.
* @returns Promise resolving to the integration call response.
*
Expand Down
4 changes: 2 additions & 2 deletions src/modules/integrations.types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -383,8 +383,8 @@ export type IntegrationsModule = {
* @example
* ```typescript
* const response = await base44.integrations.custom.call(
* "github", // integration slug
* "listIssues", // operation ID
* "github", // integration slug
* "get:/repos/{owner}/{repo}/issues", // endpoint in method:path format
* {
* pathParams: { owner: "myorg", repo: "myrepo" },
* queryParams: { state: "open" }
Expand Down
24 changes: 14 additions & 10 deletions tests/unit/custom-integrations.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ describe('Custom Integrations Module', () => {

test('custom.call() should convert camelCase params to snake_case for backend', async () => {
const slug = 'github';
const operationId = 'listIssues';
const operationId = 'get:/repos/{owner}/{repo}/issues';

// SDK call uses camelCase (JS convention)
const sdkParams = {
Expand All @@ -48,9 +48,10 @@ describe('Custom Integrations Module', () => {
data: { issues: [{ id: 1, title: 'Test Issue' }] },
};

// Mock expects snake_case body
// Mock expects snake_case body (curly braces in operationId must be URL-encoded for nock matching)
const encodedOperationId = operationId.replace(/{/g, '%7B').replace(/}/g, '%7D');
scope
.post(`/api/apps/${appId}/integrations/custom/${slug}/${operationId}`, expectedBody)
.post(`/api/apps/${appId}/integrations/custom/${slug}/${encodedOperationId}`, expectedBody)
.reply(200, mockResponse);

// SDK call uses camelCase
Expand Down Expand Up @@ -135,11 +136,12 @@ describe('Custom Integrations Module', () => {

test('custom.call() should handle 502 error from external API', async () => {
const slug = 'github';
const operationId = 'listIssues';
const operationId = 'get:/repos/{owner}/{repo}/issues';

// Mock a 502 error response (external API failure)
// Mock a 502 error response (external API failure) - curly braces in operationId must be URL-encoded
const encodedOperationId = operationId.replace(/{/g, '%7B').replace(/}/g, '%7D');
scope
.post(`/api/apps/${appId}/integrations/custom/${slug}/${operationId}`, {})
.post(`/api/apps/${appId}/integrations/custom/${slug}/${encodedOperationId}`, {})
.reply(502, {
detail: 'Failed to connect to external API: Connection refused',
});
Expand Down Expand Up @@ -169,13 +171,13 @@ describe('Custom Integrations Module', () => {
});

test('custom.call() should throw error when slug is empty string', async () => {
await expect(base44.integrations.custom.call('', 'listIssues')).rejects.toThrow(
await expect(base44.integrations.custom.call('', 'get:/repos/{owner}/{repo}/issues')).rejects.toThrow(
'Integration slug is required and cannot be empty'
);
});

test('custom.call() should throw error when slug is whitespace only', async () => {
await expect(base44.integrations.custom.call(' ', 'listIssues')).rejects.toThrow(
await expect(base44.integrations.custom.call(' ', 'get:/repos/{owner}/{repo}/issues')).rejects.toThrow(
'Integration slug is required and cannot be empty'
);
});
Expand Down Expand Up @@ -294,7 +296,7 @@ describe('Custom Integrations Module', () => {

test('custom.call() should only include defined params in body', async () => {
const slug = 'github';
const operationId = 'getUser';
const operationId = 'get:/users/{username}';

// SDK call with only pathParams
const sdkParams = {
Expand All @@ -312,8 +314,10 @@ describe('Custom Integrations Module', () => {
data: { login: 'octocat' },
};

// Curly braces in operationId must be URL-encoded for nock matching
const encodedOperationId = operationId.replace(/{/g, '%7B').replace(/}/g, '%7D');
scope
.post(`/api/apps/${appId}/integrations/custom/${slug}/${operationId}`, expectedBody)
.post(`/api/apps/${appId}/integrations/custom/${slug}/${encodedOperationId}`, expectedBody)
.reply(200, mockResponse);

const result = await base44.integrations.custom.call(slug, operationId, sdkParams);
Expand Down