jfrog / jfrog/jfrog-cli-security

jf audit - missing JSON format documentation

Open
#344 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug
Dominant language
Go
Stars
13
Forks
50
Avg merge
3d 48m
Merged PRs (30d)
26

Description

Describe the bug

There used to be a JSON format example in the documentation, but it is now gone (and there were changes in the format recently).

Current behavior

JSON Format (example or explanation) in the confluence page: https://jfrog.com/help/r/jfrog-cli/scanning-project-dependencies

Reproduction steps

N/A

Expected behavior

A minimalistic JSON Tree showing the data format of the output

JFrog CLI version

2.39.1

Operating system type and version

N/A

JFrog Artifactory version

No response

JFrog Xray version

No response

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the linked Confluence page for scanning project dependencies and review the current JSON format documentation. Add a minimal JSON tree example or explanation reflecting the current output format, then verify that the page clearly documents the expected structure.

Written by the indexing model from the issue text.

Assessment

Domain
cli, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.