MISP / MISP/PyMISP

Document attr behavior: type and value are required but category is set by default

Open
#727 6 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation T: enhancement T: support
Dominant language
Python
Stars
491
Forks
290
Avg merge
2d 8h
Merged PRs (30d)
3

Description

The PyMISP API should document somewhere that an attribute must have a type and a value, but if no category is supplied, a default value is set based on the type. I think this is only done at the server after calling add_attribute but not 100% certain. Maybe in the MISPAttribute class init method?

And if you don't mind educating me on one of the finer points here, please explain where those .type and .value fields are defined as valid. I checked classes in mispevent.py and abstract.py but could not find those field/attribute definitions, must be blind today.

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.

Research direction

Start by inspecting the MISPAttribute init method and the related classes in mispevent.py and abstract.py. Trace where type, value, and the default category are handled, then document the required fields, defaulting behavior, and where those attributes are defined as valid.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
api, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.