[doc] Documentation for parse JSON output #3519
Merged
Conversation
This file contains 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
This was referenced Nov 25, 2021
bruntib
requested changes
Nov 30, 2021
docs/analyzer/user_guide.md
Outdated
| - `checker_name` (str): identifier of the rule (checker) that was evaluated | ||
| to produce the result. | ||
| - `severity` (str | null): CodeChecker severity level (optional). | ||
| - `report_hash` (str | null): unique report identifier (optional). |
There was a problem hiding this comment.
Suggested change
| - `report_hash` (str | null): unique report identifier (optional). | |
| - `report_hash` (str | null): bug identifier hash (optional). |
I think we should use the word "report" to an entity which belongs an entry in the "reports" table. In this sense multiple reports can have the same report_hash. So I think this hash doesn't identify a report, but the bug uniquely. This distinction may not be important for a user who is browsing the findings, but can be important for someone who consumes a JSON output in order to see that multiple reports may have the same hash.
csordasmarton
force-pushed
the
parse_json_output
branch
from
7130f09 to
141e1eb
Compare
bruntib
approved these changes
Dec 6, 2021
jimis
reviewed
Feb 23, 2022
| - `message` (str): message reported by the checker. | ||
| - `checker_name` (str): identifier of the rule (checker) that was evaluated | ||
| to produce the result. | ||
| - `severity` (str | null): CodeChecker severity level (optional). |
There was a problem hiding this comment.
Can you list in the docs, what are the possible values of severity? It's useful in order to filter severities > LOW for example. That was trivial when severity was numeric.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
No description provided.