Re-add docs string to telemetry schema file #5775
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Proposed changes
This change re-adds the required docs string,
/** Data is the product telemetry data of NGINX Ingress Controller. */
, to thedata.avdl
file.When running the
make telemetry-schmea
command, this string is removed due to a bug in the generator.The bug is currently captured in the telemetry-exporter repository: nginx/telemetry-exporter#42
When this string is missing, the
validateSchemas
build test will fail as shown here: https://gitlab.com/f5/xcdf/code/app/df-schemas/-/jobs/7124238833#L299Checklist
Before creating a PR, run through this checklist and mark each as complete.