Skip to content

docs(json-specs): improve descriptions and examples #20878

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

Yqnn
Copy link
Contributor

@Yqnn Yqnn commented Jul 29, 2025

What does this PR do?

Fix minor issues in spec files:

  • 9848cc8
    • Make the descriptions of the following fields compatible with markdown:
      • custom_queries
      • auth_type
      • metrics (openmetrics)
      • extra_metrics (openmetrics)
      • share_labels (openmetrics)
      • custom_queries (elastic)
    • Add an example on the following fields:
      • metrics (openmetrics)
      • share_labels (openmetrics)
      • custom_queries (elastic)
      • expected_mode (zk)
  • 409d469 regenerate examples
  • b8c45c2 add changelogs

Impact of the changes on the integration configuration UI:

BeforeAfter
Screenshot 2025-07-29 at 15 57 24 Screenshot 2025-07-29 at 15 57 11
Screenshot 2025-07-29 at 16 07 48 Screenshot 2025-07-29 at 16 07 35
image Screenshot 2025-07-29 at 16 33 02
image Screenshot 2025-07-29 at 16 45 00

Motivation

https://datadoghq.atlassian.net/browse/FA-1028

Review checklist (to be filled by reviewers)

  • Feature or bugfix MUST have appropriate tests (unit, integration, e2e)
  • Add the qa/skip-qa label if the PR doesn't need to be tested during QA.
  • If you need to backport this PR to another branch, you can add the backport/<branch-name> label to the PR and it will automatically open a backport PR once this one is merged

Copy link

codecov bot commented Jul 29, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 90.23%. Comparing base (7ff5122) to head (b8c45c2).
⚠️ Report is 16 commits behind head on master.

Additional details and impacted files
Flag Coverage Δ
cassandra ?
confluent_platform ?
elastic 93.92% <ø> (ø)
hive ?
hudi ?
ignite ?
jboss_wildfly ?
kafka ?
presto ?
solr ?
tomcat ?
weblogic ?
zk 82.30% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Copy link

⚠️ Major version bump
The changelog type changed or removed was used in this Pull Request, so the next release will bump major version. Please make sure this is a breaking change, or use the fixed or added type instead.

@Yqnn Yqnn force-pushed the yann.armelin/fix-json-schemas2 branch from 9bd7631 to 7168651 Compare July 29, 2025 15:59
@Yqnn Yqnn marked this pull request as ready for review July 30, 2025 08:05
@Yqnn Yqnn requested review from a team as code owners July 30, 2025 08:05
## extra_metrics:
## - <METRIC_1>
## - <METRIC_2>
## ```
Copy link
Contributor

Choose a reason for hiding this comment

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

Non blocking, but just noticed that these don't line up.

Suggested change
## ```
## ```

Copy link
Contributor

@estherk15 estherk15 left a comment

Choose a reason for hiding this comment

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

This is not a blocker, but noticed that the backticks aren't aligned for this field:

    ##     ```
    ##      extra_metrics:
    ##      - <METRIC_1>
    ##      - <METRIC_2>
    ##      ```

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

Successfully merging this pull request may close these issues.

2 participants