Skip to content

docs(calling): add ai-docs specifications for CallHistory module#4933

Open
Kesari3008 wants to merge 3 commits intowebex:nextfrom
Kesari3008:Call-History-Specs
Open

docs(calling): add ai-docs specifications for CallHistory module#4933
Kesari3008 wants to merge 3 commits intowebex:nextfrom
Kesari3008:Call-History-Specs

Conversation

@Kesari3008
Copy link
Copy Markdown
Contributor

@Kesari3008 Kesari3008 commented Apr 29, 2026

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

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation update
  • Tooling change
  • Internal code refactor

The following scenarios were tested

< ENUMERATE TESTS PERFORMED, WHETHER MANUAL OR AUTOMATED >

The GAI Coding Policy And Copyright Annotation Best Practices

  • GAI was not used (or, no additional notation is required)
  • Code was generated entirely by GAI
  • GAI was used to create a draft that was subsequently customized or modified
  • Coder created a draft manually that was non-substantively modified by GAI (e.g., refactoring was performed by GAI on manually written code)
  • Tool used for AI assistance (GitHub Copilot / Other - specify)
    • Github Copilot
    • Other - Please Specify
  • This PR is related to
    • Feature
    • Defect fix
    • Tech Debt
    • Automation

I certified that

  • I have read and followed contributing guidelines
  • I discussed changes with code owners prior to submitting this pull request
  • I have not skipped any automated checks
  • All existing and new tests passed
  • I have updated the documentation accordingly

Make sure to have followed the contributing guidelines before submitting.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@aws-amplify-us-east-2
Copy link
Copy Markdown

This pull request is automatically being deployed by Amplify Hosting (learn more).

Access this pull request here: https://pr-4933.d3m3l2kee0btzx.amplifyapp.com

@Kesari3008 Kesari3008 added the validated If the pull request is validated for automation. label May 5, 2026
@Kesari3008 Kesari3008 marked this pull request as ready for review May 5, 2026 18:49
@Kesari3008 Kesari3008 requested a review from a team as a code owner May 5, 2026 18:49
Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 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 |
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge 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 👍 / 👎.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

They are shown as optional only, re-consider this comment

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

validated If the pull request is validated for automation.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant