Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated environment and playbook fields #19

Merged
merged 4 commits into from
Jun 3, 2024
Merged

Updated environment and playbook fields #19

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3308054
Added compatible playbooks
asa1997 May 27, 2024
5910508
Updated title
asa1997 May 27, 2024
57fad27
Merge branch 'main' of https://github.com/asa1997/bes-schema
asa1997 May 29, 2024
b6398a8
Updated playbook and environment field
asa1997 May 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 36 additions & 5 deletions docs/assessment-report-schema.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,15 +50,21 @@ A sample json for your understanding is available
"name": string,
"version": string,
"url": string,
"environment": string
"environment": {
"name": string,
"version": string
}
},
"assessments": [
{
"tool": {
"name": string,
"type": string,
"version": string,
"playbook": string
"playbook": {
"name": string,
"version": string
}
},
"execution": {
"type": string,
Expand Down Expand Up @@ -113,7 +119,11 @@ identifying as schema version 1.3.0 by ignoring any unexpected fields.
"type": string,
"name": string,
"version": string,
"url": string
"url": string,
"environment": {
"name": string,
"version": string
}
}
```

Expand Down Expand Up @@ -151,6 +161,18 @@ Details about the open source asset that was assessed.
Project source code URL or the ML model card URL
</td>
</tr>
<tr>
<td><code>environment.name</code></td>
<td>
Name of the environment used.
</td>
</tr>
<tr>
<td><code>environment.version</code></td>
<td>
Version of the environment used.
</td>
</tr>
</tbody>
</table>

Expand All @@ -161,7 +183,10 @@ Details about the open source asset that was assessed.
"name": string,
"type": string,
"version": string,
"playbook": string
"playbook": {
"name": string,
"version": string
}
}
```

Expand Down Expand Up @@ -194,11 +219,17 @@ Details about the tool used for assessment. "assessments" is an array and it sho
</td>
</tr>
<tr>
<td><code>playbook</code></td>
<td><code>playbook.name</code></td>
<td>
Assessment tool playbook name
</td>
</tr>
<tr>
<td><code>playbook.version</code></td>
<td>
Assessment tool playbook version
</td>
</tr>
</tbody>
</table>

Expand Down
Loading