docs(calling): add ai-docs specifications for CallHistory module#4933
docs(calling): add ai-docs specifications for CallHistory module#4933Kesari3008 wants to merge 3 commits intowebex:nextfrom
Conversation
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
|
This pull request is automatically being deployed by Amplify Hosting (learn more). |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: c3b31cb98a
ℹ️ About Codex in GitHub
Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".
|
|
||
| | Method | Signature | Description | | ||
| | ------ | --------- | ----------- | | ||
| | `getCallHistoryData` | `(days?: number, limit?: number, sort?: SORT, sortBy?: SORT_BY): Promise<JanusResponseEvent>` | Fetches call history records from Janus | |
There was a problem hiding this comment.
Fix
getCallHistoryData signature in API table
The docs state that getCallHistoryData takes optional parameters (days?, limit?, sort?, sortBy?), but ICallHistory currently defines all four parameters as required in packages/calling/src/CallHistory/types.ts. This mismatch will cause TypeScript consumers to hit compile-time errors when they follow the documented interface, so the table should match the actual public type contract (or the interface should be updated to optional if that is intended).
Useful? React with 👍 / 👎.
There was a problem hiding this comment.
They are shown as optional only, re-consider this comment
COMPLETES #https://jira-eng-gpk2.cisco.com/jira/browse/SPARK-807303
This pull request addresses
Specs for Call History module within Calling SDK
by making the following changes
Added AGENTS.md and ARCHITECTUIRE.md within CallHistory module
Change Type
The following scenarios were tested
< ENUMERATE TESTS PERFORMED, WHETHER MANUAL OR AUTOMATED >
The GAI Coding Policy And Copyright Annotation Best Practices
I certified that
Make sure to have followed the contributing guidelines before submitting.