Skip to content

Make the SARIF example files valid JSON - #46096

Open
HardMax71 wants to merge 1 commit into
github:mainfrom
HardMax71:sarif-example-valid-json
Open

HardMax71 wants to merge 1 commit into
github:mainfrom
HardMax71:sarif-example-valid-json

Conversation

@HardMax71

Copy link
Copy Markdown

Why:

Closes: #46095

What's being changed (if available, include any code snippets, screenshots, or gifs):

In both examples under "SARIF output file examples", the rule object gets the missing comma after "id": "R01", loses the bare ... line, and drops the trailing comma after "security-severity" : "9.8". Nothing else changes. All three JSON blocks on the page now parse and validate against the SARIF 2.1.0 schema at https://json.schemastore.org/sarif-2.1.0.json.

Check off the following:

  • A subject matter expert (SME) has reviewed the technical accuracy of the content in this PR. In most cases, the author can be the SME. Open source contributions may require an SME review from GitHub staff.
  • The changes in this PR meet the docs fundamentals that are required for all content.
  • All CI checks are passing and the changes look good in the review environment.

Copilot AI balanced review requested due to automatic review settings September 27, 2026 09:42

Copilot AI 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.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@github-actions github-actions Bot added the triage Do not begin working on this issue until triaged by the team label Sep 27, 2026
@github-actions

Copy link
Copy Markdown
Contributor

How to review these changes 👓

Thank you for your contribution. To review these changes, choose one of the following options:

A Hubber will need to deploy your changes internally to review.

Table of review links

Note: Please update the URL for your staging server or codespace.

The table shows the files in the content directory that were changed in this pull request. This helps you review your changes on a staging server. Changes to the data directory are not included in this table.

Source Review Production What Changed
code-security/reference/code-scanning/sarif-files/sarif-support.md fpt
ghec
ghes@ 3.22 3.21 3.20 3.19 3.18 3.17
fpt
ghec
ghes@ 3.22 3.21 3.20 3.19 3.18 3.17

Key: fpt: Free, Pro, Team; ghec: GitHub Enterprise Cloud; ghes: GitHub Enterprise Server

🤖 This comment is automatically generated.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

triage Do not begin working on this issue until triaged by the team

Projects

None yet

Development

Successfully merging this pull request may close these issues.

SARIF example files on "SARIF support for code scanning" are not valid JSON

3 participants