Skip to content
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.

Sign up for GitHub

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

Jump to bottom

docs(misconf): Add more info on how to use arbitrary JSON/YAML scan feat #7458

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(misconf): Add more info on how to use arbitrary JSON/YAML scan feat #7458

wants to merge 1 commit into from

Conversation

simar7
Copy link
Member

@simar7 simar7 commented Sep 7, 2024 •
edited
Loading

Description

Add more info on how to use arbitrary JSON/YAML scan feat

Related issues

Checklist

  • I've read the guidelines for contributing to this repository.
  • I've followed the conventions in the PR title.
  • I've added tests that prove my fix is effective or that my feature works.
  • I've updated the documentation with the relevant information (if needed).
  • I've added usage information (if the PR introduces new options)
  • I've included a "before" and "after" example to the description (if the PR is a user interface change).

@simar7 simar7 self-assigned this Sep 7, 2024
@simar7 simar7 changed the title chore(docs): Add more info on how to use arbitrary JSON/YAML scan feat docs(misconf): Add more info on how to use arbitrary JSON/YAML scan feat Sep 17, 2024
@simar7 simar7 marked this pull request as ready for review September 17, 2024 03:58
nikpivkin
nikpivkin reviewed Sep 17, 2024
View reviewed changes
docs/docs/scanner/misconfiguration/index.md

!!! tip
It is also possible to specify multiple input schemas with `--config-file-schema` flag as it can accept a comma seperated list of file paths or a directory as input. In the case of multiple schemas being specified, all of them will be evaluated against all the input files.

If the schema is specified in the check metadata and is in the directory specified in the `--config-check` argument, it will be automatically loaded as specified [here](./custom/schema.md#custom-checks-with-custom-schemas), and will only be used for type checking in Rego.
Copy link
Contributor

Choose a reason for hiding this comment

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

Is it worth lifting that paragraph above to link to the example?

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

@nikpivkin nikpivkin nikpivkin left review comments

At least 1 approving review is required to merge this pull request.

Assignees

@simar7 simar7

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

chore(docs): Better document how to scan arbitrary JSON/YAML inputs
2 participants
@simar7 @nikpivkin