Add Execution Config ID to partial test plan run API payloads (DOC-1483)

[bharathk08]

Summary by CodeRabbit

• Documentation
  • Updated API examples for partial test plan runs and scheduled runs to include the saved configuration ID alongside the configuration name.
  • Added clearer guidance on providing the execution configuration ID, including how to find it in the app using browser developer tools.
  • Expanded the request body field descriptions to reflect both required values.

[coderabbitai]

📝 Walkthrough

Walkthrough

The partial test plan API docs now show executionConfig.id in execute and schedule payload examples. The instructions explain how to find the execution config ID in the app, and the executionConfig field description now requires both name and id.

Changes

Partial Test Plan API Docs

Layer / File(s)	Summary
Execution config ID guidance src/pages/docs/test-plans/partial-test-plan-run-via-api.md	Execute and schedule payload examples now include executionConfig.id, and the executionConfig field description and instructions specify both the favorite configuration name and id.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

I hopped through the docs with a twitchy nose,
Found executionConfig.id where the test plan goes.
Name and ID now bounce in a neat little pair,
Woo-hoo! said the bunny, “all set to share!” 🐰

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately summarizes the main doc change: adding execution config ID to partial test plan run API payloads.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch DOC-1483

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}

[coderabbitai]

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@src/pages/docs/test-plans/partial-test-plan-run-via-api.md`:
- Around line 78-82: The API payload examples for partial test plan runs use
inconsistent ID types, so update both examples in the docs to match the expected
JSON schema. In the examples near the executionId payloads, make the run and
schedule snippets use the same type for executionId (either both string or both
number, consistent with the API) and ensure executionConfig.id is also shown
with the correct JSON type instead of an unquoted placeholder. Keep the
placeholder values aligned across the examples so the documentation is
internally consistent.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: a73b52c8-7731-4cad-a98b-9847d02eb4f5

📥 Commits

Reviewing files that changed from the base of the PR and between 55aff93 and a275d79.

📒 Files selected for processing (1)

• src/pages/docs/test-plans/partial-test-plan-run-via-api.md

[coderabbitai]

🎯 Functional Correctness | 🟡 Minor

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
set -euo pipefail
rg -n --hidden -S 'executionId|executionConfig\.id|config_id' src/pages/docs/test-plans

Repository: testsigmahq/testsigma-docs

Length of output: 1207

---

🏁 Script executed:

cat -n src/pages/docs/test-plans/partial-test-plan-run-via-api.md | sed -n '78,85p;148,168p'

Repository: testsigmahq/testsigma-docs

Length of output: 2719

---

Align ID types in API payload examples

The two payload examples currently use inconsistent formats for executionId:

• The run example uses a string: "3857"
• The schedule example uses a number: 3857

Both examples also use the unquoted placeholder config_id for executionConfig.id. Ensure both examples match the API's expected JSON type (string vs. number) for consistency and correctness.

Current Inconsistencies

Lines 78 vs 151:

// Current state - Run example
"executionId": "3857",
"executionConfig": { ... "id": config_id }

// Current state - Schedule example
"executionId": 3857,
"executionConfig": { ... "id": config_id }

🤖 Prompt for AI Agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@src/pages/docs/test-plans/partial-test-plan-run-via-api.md` around lines 78 -
82, The API payload examples for partial test plan runs use inconsistent ID
types, so update both examples in the docs to match the expected JSON schema. In
the examples near the executionId payloads, make the run and schedule snippets
use the same type for executionId (either both string or both number, consistent
with the API) and ensure executionConfig.id is also shown with the correct JSON
type instead of an unquoted placeholder. Keep the placeholder values aligned
across the examples so the documentation is internally consistent.