Skip to content

Conversation

@natansil
Copy link
Collaborator

Update documentation and tests to reflect the new operation ID format (method:path instead of operationId names like "listIssues").

Examples now use format like "get:/repos/{owner}/{repo}/issues" instead of "listIssues" to match how the OpenAPI parser generates operation IDs.

  • Update JSDoc examples in custom-integrations.types.ts
  • Update JSDoc examples in integrations.types.ts
  • Update test operation IDs and add URL encoding for nock matching

Update documentation and tests to reflect the new operation ID format
(method:path instead of operationId names like "listIssues").

Examples now use format like "get:/repos/{owner}/{repo}/issues" instead
of "listIssues" to match how the OpenAPI parser generates operation IDs.

- Update JSDoc examples in custom-integrations.types.ts
- Update JSDoc examples in integrations.types.ts
- Update test operation IDs and add URL encoding for nock matching
@claude
Copy link

claude bot commented Jan 15, 2026

Claude finished @natansil's task —— View job


Code Review Summary

I've reviewed the changes in this PR that update the operation ID format from named operations (e.g., "listIssues") to method:path format (e.g., "get:/repos/{owner}/{repo}/issues"). Here's my feedback:

✅ Code Quality and Best Practices

The changes are well-implemented and follow good practices:

  • Consistent updates across documentation: JSDoc examples in both type files have been updated to reflect the new format
  • Proper URL encoding in tests: The test updates correctly handle URL encoding of curly braces when matching nock requests
  • Clear and descriptive format: The method:path format (e.g., "get:/repos/{owner}/{repo}/issues") is more explicit about the HTTP method and endpoint being called

✅ No Potential Bugs Found

The implementation appears solid:

  • All test cases that use operation IDs have been updated
  • URL encoding is properly applied for nock matching (replacing { with %7B and } with %7D)
  • The changes maintain backward compatibility in the API structure

✅ Performance Considerations

No performance concerns - these are documentation and test changes only, with no impact on runtime performance.

✅ Security Concerns

No security issues identified - the changes only affect documentation strings and test values.

✅ Test Coverage

Good test coverage maintained:

  • All relevant test cases updated to use the new format
  • Tests still verify the same functionality with the new operation ID format
  • Edge cases (empty params, errors, large payloads) remain properly tested

💡 Minor Suggestions

  1. Consider adding a comment about the format: It might be helpful to add a brief comment in the type definitions explaining why this format is used (e.g., "Format matches OpenAPI parser output")

  2. Documentation consistency: The changes look complete, but it would be good to verify if there are any other documentation files or README examples that might need updating to maintain consistency across the entire project

Overall, this is a clean and well-executed update that improves clarity by using a more explicit operation ID format. The changes are thorough and maintain the existing functionality while improving documentation accuracy.

@github-actions
Copy link

🚀 Package Preview Available!


Install this PR's preview build with npm:

npm i @base44-preview/[email protected]

Prefer not to change any import paths? Install using npm alias so your code still imports @base44/sdk:

npm i "@base44/sdk@npm:@base44-preview/[email protected]"

Or add it to your package.json dependencies:

{
  "dependencies": {
    "@base44/sdk": "npm:@base44-preview/[email protected]"
  }
}

Preview published to npm registry — try new features instantly!

@natansil natansil merged commit 3c234f1 into main Jan 15, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants