ossf / ossf/package-analysis

Provide json schema for `AnalysisResult` output

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

Nobody has claimed this yet.

enhancement
Dominant language
Go
Stars
912
Forks
74
PR merge metrics
No merged PRs in 30d

Description

This could also be versioned and validated(as is the case for package-feeds 'package' output) providing a reference for potential downstream consumers of the analysis results.

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 by locating the AnalysisResult output and compare its structure with package.schema.json from package-feeds. Define a versioned JSON schema, add validation for the analysis result output, and verify that downstream consumers can use the published schema.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
api
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.