Repository navigation
NOISSUE - Fix alarm severity range and reports metrics type name - #190
Merged
Merged
Conversation
Docs described alarm severity as a 1-5 scale; the actual field is a uint8 capped at 100 (alarms.SeverityMax, ErrInvalidSeverity above that), verified against alarms/alarms.go and its tests. Also corrected the ReportConfig struct snippet's Metrics field type from the illustrative []Metric to the real []ReqMetric. Found while cross-checking magistrala-ee docs against current code.
Deploying with
|
| Status | Name | Latest Commit | Preview URL | Updated (UTC) |
|---|---|---|---|---|
| ✅ Deployment successful! View logs |
magistrala-docs | 89cf63b | Commit Preview URL Branch Preview URL |
Sep 02 2026, 12:18 PM |
ianmuchyri
approved these changes
Sep 2, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
What type of PR is this?
This is a bug fix because it corrects factually wrong documentation about the alarm severity range.
What does this do?
Docs described alarm severity as a 1-5 scale; the actual field is a
uint8capped at 100 (alarms.SeverityMax,ErrInvalidSeverityabove that), verified againstalarms/alarms.goand its tests. Fixed in both the dev-guide API reference and the user-guide info callout.Also corrected the
ReportConfigstruct snippet'sMetricsfield type from the illustrative[]Metricto the real[]ReqMetric, verified againstreports/reports.go.Found while cross-checking magistrala-ee docs against current code.
Which issue(s) does this PR fix/relate to?
N/A
Have you included tests for your changes?
No automated tests apply to doc-text fixes. Verified both corrections directly against the current Go source (
alarms/alarms.go,reports/reports.go) and their tests before changing anything.Did you document any new/modified features?
No — this only corrects existing documentation to match current behavior, no content/behavior changes.
Notes
Text-only change, 3 files, no link/structure changes.