JSON Schema / Spec / Docs for the Malware filter list data provider API

Open Beginner friendly
#1,849 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
75/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Active
Tech stack
php
Domain
api, documentation

Research direction

Start by reading src/FilterList/List/AikidoMalwareFilterList.php to identify the currently supported package malware report format. Document that format as a public specification, including a JSON Schema if appropriate, and ensure the resulting documentation matches the implementation.

Written by the indexing model from the issue text.

Description

There should be a specification publicly available for the format we support for ingesting package malware reports, as currently implemented in https://github.com/composer/packagist/blob/main/src/FilterList/List/AikidoMalwareFilterList.php.

Dominant language
PHP
Stars
1.8k
Forks
490
Avg merge
3d 10m
Merged PRs (30d)
40

Contributor guide

No contributing guide indexed for this repository

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.

More from composer/packagist

All issues in composer/packagist

Similar issues

More PHP issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.