allure-framework / allure-framework/allure3

[docs] Indicate which fields are optional in the model

Open Beginner friendly
#945 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
HTML
Stars
401
Forks
58
Avg merge
2d 20h
Merged PRs (30d)
34

Description

### What happened?

The documentation does not indicate which fields are optional and which are required: https://allurereport.org/docs/how-it-works-test-result-file/

to find this information, I had to go to the [js source code](https://github.com/allure-framework/allure3/blob/main/packages/core-api/src/model.ts)
This information is not even represented documented in some of the modules, like the java module, though that is an issue for the respective modules.

### How can we reproduce it?

N/A

### What did you expect?

which fields are optional and which are required to be documented.

### Environment

N/A

### Additional context

_No response_

Contributor guide

Open the contributing guide

Research direction

Start with the test-result-file documentation page and compare its model fields with packages/core-api/src/model.ts, which the issue identifies as the source of the optionality information. Check the relevant module documentation, including the Java module context, and update the field descriptions so required and optional fields are distinguishable. Done means the documentation explicitly records this information for the documented model.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, typescript
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Active
Clarity
Clearly specified
Newbie friendliness
84/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.