Skip to content

Joseph.borkowski/syn 5024#37829

Open
mesmericbaleen wants to merge 3 commits into
masterfrom
joseph.borkowski/SYN-5024
Open

Joseph.borkowski/syn 5024#37829
mesmericbaleen wants to merge 3 commits into
masterfrom
joseph.borkowski/SYN-5024

Conversation

@mesmericbaleen

Copy link
Copy Markdown

What does this PR do?

  • Removes step_details section from API tests where it doesn't apply
  • Corrects notification template variable names (e.g. synthetics.attributes.variables.extracted.ping.latency.avg -> synthetics.attributes.result.ping.latency.avg

What is the motivation?

Our current documentation for API tests is incorrect and gives customers the wrong variable paths to use in their monitor notifications.

Merge readiness

  • Ready for merge

For Datadog employees:

  • ⚠️ Your branch name MUST follow the <name>/<description> convention and include the forward slash (/). If you've already created your PR with an incorrect branch name, please rename your branch and open a fresh PR.
  • 🤖 New: Comment with /review to run an automated check that catches common issues before a Documentation team member reviews your PR.

AI assistance

Additional notes

@mesmericbaleen mesmericbaleen requested review from a team as code owners June 29, 2026 19:41
@github-actions github-actions Bot added the cdocs label Jun 29, 2026
@github-actions

Copy link
Copy Markdown
Contributor

Preview links (active after the build_preview check completes)

Modified Files

@mesmericbaleen

Copy link
Copy Markdown
Author

/review

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🤖 Automated review by Claude. AI-generated; verify before acting.

This PR is a clean rename from synthetics.attributes.variables.extracted.* to synthetics.attributes.result.* across the API testing template variables page, plus removal of the step-details section (which doesn't apply to API tests) and a new dedicated synthetics_variables_api_options group.

A few small nits below — nothing blocking. Worth noting that the Browser, Mobile, and Multistep template-variable pages still use the old synthetics.attributes.variables.extracted.* paths; this PR is scoped to API tests, so that asymmetry is presumably intentional, but flagging it in case a follow-up sweep is planned.

Reviewed e83ddb7d86b414dba028c2fbd90839c8e263fff1workflow run


{% /if %}
<!-- END Step details variables -->

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Style: Removing the <!-- Step details variables --> block left an extra blank line here. There are now two consecutive blank lines between <!-- END Test info variables --> and <!-- Variables --> — collapse to one for consistency with the other section separators in this file.

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

@DataDog fix this

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I can only run on private repositories.

Comment thread customization_config/en/option_groups/synthetics.yaml
- id: test_results
default: true
- id: test_info
- id: local_and_global No newline at end of file

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Style: Missing trailing newline at end of file (\ No newline at end of file in the diff). Add a final newline to satisfy POSIX/YAML conventions and avoid noisy diffs in future edits.

@maycmlee

maycmlee commented Jun 29, 2026

Copy link
Copy Markdown
Contributor

Created DOCS-14987 for review.

@maycmlee maycmlee added the editorial review Waiting on a more in-depth review label Jun 29, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cdocs editorial review Waiting on a more in-depth review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants