Skip to content

Refactor API documentation for test executions and metrics#633

Open
sarthakFuture wants to merge 1 commit intodevfrom
feature/callexec-apis
Open

Refactor API documentation for test executions and metrics#633
sarthakFuture wants to merge 1 commit intodevfrom
feature/callexec-apis

Conversation

@sarthakFuture
Copy link
Copy Markdown
Contributor

  • Removed the "Call Executions" card from the API index page.
  • Updated request and response body parameters in the "Delete Test Executions" documentation to use snake_case.
  • Removed unnecessary request body section in the "Cancel Execution" documentation.
  • Added new documentation for "Get Call Execution Details" API endpoint.
  • Deleted outdated "Get Eval Explanation Summary" documentation.
  • Updated KPI metrics in "Get KPIs" documentation to use snake_case.
  • Enhanced "Get Test Execution Details" documentation to include pagination and column configuration.
  • Updated request and response parameters in "Rerun Calls" documentation to use snake_case and clarified descriptions.

Pull Request

Description

Describe the changes in this pull request:

  • What feature/bug does this PR address?
  • Provide any relevant links or screenshots.

Checklist

  • Code compiles correctly.
  • Created/updated tests.
  • Linting and formatting applied.
  • Documentation updated.

##Linear
Fixes TH-4580

Related Issues

Closes #<issue_number>

- Removed the "Call Executions" card from the API index page.
- Updated request and response body parameters in the "Delete Test Executions" documentation to use snake_case.
- Removed unnecessary request body section in the "Cancel Execution" documentation.
- Added new documentation for "Get Call Execution Details" API endpoint.
- Deleted outdated "Get Eval Explanation Summary" documentation.
- Updated KPI metrics in "Get KPIs" documentation to use snake_case.
- Enhanced "Get Test Execution Details" documentation to include pagination and column configuration.
- Updated request and response parameters in "Rerun Calls" documentation to use snake_case and clarified descriptions.
@sarthakFuture sarthakFuture requested review from hadarishav and nik13 May 5, 2026 08:34
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.

1 participant