docs: update operation ID examples to method:path format#80
Conversation
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 finished @natansil's task —— View job Code Review SummaryI'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 PracticesThe changes are well-implemented and follow good practices:
✅ No Potential Bugs FoundThe implementation appears solid:
✅ Performance ConsiderationsNo performance concerns - these are documentation and test changes only, with no impact on runtime performance. ✅ Security ConcernsNo security issues identified - the changes only affect documentation strings and test values. ✅ Test CoverageGood test coverage maintained:
💡 Minor Suggestions
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. |
🚀 Package Preview Available!Install this PR's preview build with npm: npm i @base44-preview/sdk@0.8.18-pr.80.7c5f728Prefer 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.18-pr.80.7c5f728"Or add it to your {
"dependencies": {
"@base44/sdk": "npm:@base44-preview/sdk@0.8.18-pr.80.7c5f728"
}
}
Preview published to npm registry — try new features instantly! |
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.