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

publish docs for New Asset Sim filter api for spot security #712

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
+863 −0
Open

publish docs for New Asset Sim filter api for spot security #712

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
22fc02c
added changes for asset simfilter api
Jan 3, 2025
883d7d0
removed unused files
Jan 6, 2025
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
34 changes: 34 additions & 0 deletions api/services/security/v1/parameters/affectedAssetsCount_query.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
description: "The number of neighboring assets affected by the finding.\n <br>\n
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what's neighboring?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

change this to related assets

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The number of related assets affected by the finding.

\ Enter either a number or prefix it with one of the following operators.\n
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

as we discussed the last time, all the following operators. >> these operators:.

this needs to be done for all instances of this text in all files.

\ <table>\n <tr>\n <th>Operator</th>\n <th>Notation</th>\n
\ <th>Example</th>\n </tr>\n <tr>\n <td>Equals</td>\n
\ <td>No prefix or optionally \\~eq\\~</td>\n <td>10 or \\~eq\\~10</td>\n
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

for all instances of optionally in all files, change it to:
No prefix or \eq\

\ </tr>\n <tr>\n <td>Not equals</td>\n <td>\\~neq\\~</td>\n
\ <td>\\~neq\\~10</td>\n </tr>\n <tr>\n <td>Greater than</td>\n
\ <td>\\~gt\\~</td>\n <td>\\~gt\\~10</td>\n </tr>\n <tr>\n
\ <td>Greater than equals</td>\n <td>\\~gte\\~</td>\n <td>\\~gte\\~10</td>\n
\ </tr>\n <tr>\n <td>Less than</td>\n <td>\\~lt\\~</td>\n
\ <td>\\~lt\\~10</td>\n </tr>\n <tr>\n <td>Less than
equals</td>\n <td>\\~lte\\~</td>\n <td>\\~lte\\~10</td>\n </tr>\n
\ <tr>\n <td>Between two ranges</td>\n <td>\\~bt\\~</td>\n <td>\\~bt\\~10,20</td>\n
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

in all instances in all files, change: Between two ranges >> Between two numbers

\ </tr>\n </table>\n "
in: query
name: affectedAssetsCount
required: false
schema:
description: "The number of neighboring assets affected by the finding.\n <br>\n
\ Enter either a number or prefix it with one of the following operators.\n
\ <table>\n <tr>\n <th>Operator</th>\n <th>Notation</th>\n
\ <th>Example</th>\n </tr>\n <tr>\n <td>Equals</td>\n
\ <td>No prefix or optionally \\~eq\\~</td>\n <td>10 or \\~eq\\~10</td>\n
\ </tr>\n <tr>\n <td>Not equals</td>\n <td>\\~neq\\~</td>\n
\ <td>\\~neq\\~10</td>\n </tr>\n <tr>\n <td>Greater
than</td>\n <td>\\~gt\\~</td>\n <td>\\~gt\\~10</td>\n </tr>\n
\ <tr>\n <td>Greater than equals</td>\n <td>\\~gte\\~</td>\n
\ <td>\\~gte\\~10</td>\n </tr>\n <tr>\n <td>Less than</td>\n
\ <td>\\~lt\\~</td>\n <td>\\~lt\\~10</td>\n </tr>\n <tr>\n
\ <td>Less than equals</td>\n <td>\\~lte\\~</td>\n <td>\\~lte\\~10</td>\n
\ </tr>\n <tr>\n <td>Between two ranges</td>\n <td>\\~bt\\~</td>\n
\ <td>\\~bt\\~10,20</td>\n </tr>\n </table>\n "
title: Affectedassetscount
type: string
34 changes: 34 additions & 0 deletions api/services/security/v1/parameters/allAnomaliesCount_query.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
description: "The total number of anomalies found for the asset.\n <br>\n Enter
either a number or prefix it with one of the following operators.\n <table>\n
\ <tr>\n <th>Operator</th>\n <th>Notation</th>\n <th>Example</th>\n
\ </tr>\n <tr>\n <td>Equals</td>\n <td>No prefix or optionally
\\~eq\\~</td>\n <td>10 or \\~eq\\~10</td>\n </tr>\n <tr>\n
\ <td>Not equals</td>\n <td>\\~neq\\~</td>\n <td>\\~neq\\~10</td>\n
\ </tr>\n <tr>\n <td>Greater than</td>\n <td>\\~gt\\~</td>\n
\ <td>\\~gt\\~10</td>\n </tr>\n <tr>\n <td>Greater than
equals</td>\n <td>\\~gte\\~</td>\n <td>\\~gte\\~10</td>\n </tr>\n
\ <tr>\n <td>Less than</td>\n <td>\\~lt\\~</td>\n <td>\\~lt\\~10</td>\n
\ </tr>\n <tr>\n <td>Less than equals</td>\n <td>\\~lte\\~</td>\n
\ <td>\\~lte\\~10</td>\n </tr>\n <tr>\n <td>Between two
ranges</td>\n <td>\\~bt\\~</td>\n <td>\\~bt\\~10,20</td>\n </tr>\n
\ </table>\n "
in: query
name: allAnomaliesCount
required: false
schema:
description: "The total number of anomalies found for the asset.\n <br>\n
\ Enter either a number or prefix it with one of the following operators.\n
\ <table>\n <tr>\n <th>Operator</th>\n <th>Notation</th>\n
\ <th>Example</th>\n </tr>\n <tr>\n <td>Equals</td>\n
\ <td>No prefix or optionally \\~eq\\~</td>\n <td>10 or \\~eq\\~10</td>\n
\ </tr>\n <tr>\n <td>Not equals</td>\n <td>\\~neq\\~</td>\n
\ <td>\\~neq\\~10</td>\n </tr>\n <tr>\n <td>Greater
than</td>\n <td>\\~gt\\~</td>\n <td>\\~gt\\~10</td>\n </tr>\n
\ <tr>\n <td>Greater than equals</td>\n <td>\\~gte\\~</td>\n
\ <td>\\~gte\\~10</td>\n </tr>\n <tr>\n <td>Less than</td>\n
\ <td>\\~lt\\~</td>\n <td>\\~lt\\~10</td>\n </tr>\n <tr>\n
\ <td>Less than equals</td>\n <td>\\~lte\\~</td>\n <td>\\~lte\\~10</td>\n
\ </tr>\n <tr>\n <td>Between two ranges</td>\n <td>\\~bt\\~</td>\n
\ <td>\\~bt\\~10,20</td>\n </tr>\n </table>\n "
title: Allanomaliescount
type: string
34 changes: 34 additions & 0 deletions api/services/security/v1/parameters/allEventsCount_query.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
description: "The total number of events found for the asset.\n <br>\n Enter
either a number or prefix it with one of the following operators.\n <table>\n
\ <tr>\n <th>Operator</th>\n <th>Notation</th>\n <th>Example</th>\n
\ </tr>\n <tr>\n <td>Equals</td>\n <td>No prefix or optionally
\\~eq\\~</td>\n <td>10 or \\~eq\\~10</td>\n </tr>\n <tr>\n
\ <td>Not equals</td>\n <td>\\~neq\\~</td>\n <td>\\~neq\\~10</td>\n
\ </tr>\n <tr>\n <td>Greater than</td>\n <td>\\~gt\\~</td>\n
\ <td>\\~gt\\~10</td>\n </tr>\n <tr>\n <td>Greater than
equals</td>\n <td>\\~gte\\~</td>\n <td>\\~gte\\~10</td>\n </tr>\n
\ <tr>\n <td>Less than</td>\n <td>\\~lt\\~</td>\n <td>\\~lt\\~10</td>\n
\ </tr>\n <tr>\n <td>Less than equals</td>\n <td>\\~lte\\~</td>\n
\ <td>\\~lte\\~10</td>\n </tr>\n <tr>\n <td>Between two
ranges</td>\n <td>\\~bt\\~</td>\n <td>\\~bt\\~10,20</td>\n </tr>\n
\ </table>\n "
in: query
name: allEventsCount
required: false
schema:
description: "The total number of events found for the asset.\n <br>\n Enter
either a number or prefix it with one of the following operators.\n <table>\n
\ <tr>\n <th>Operator</th>\n <th>Notation</th>\n <th>Example</th>\n
\ </tr>\n <tr>\n <td>Equals</td>\n <td>No prefix or
optionally \\~eq\\~</td>\n <td>10 or \\~eq\\~10</td>\n </tr>\n <tr>\n
\ <td>Not equals</td>\n <td>\\~neq\\~</td>\n <td>\\~neq\\~10</td>\n
\ </tr>\n <tr>\n <td>Greater than</td>\n <td>\\~gt\\~</td>\n
\ <td>\\~gt\\~10</td>\n </tr>\n <tr>\n <td>Greater
than equals</td>\n <td>\\~gte\\~</td>\n <td>\\~gte\\~10</td>\n </tr>\n
\ <tr>\n <td>Less than</td>\n <td>\\~lt\\~</td>\n <td>\\~lt\\~10</td>\n
\ </tr>\n <tr>\n <td>Less than equals</td>\n <td>\\~lte\\~</td>\n
\ <td>\\~lte\\~10</td>\n </tr>\n <tr>\n <td>Between
two ranges</td>\n <td>\\~bt\\~</td>\n <td>\\~bt\\~10,20</td>\n </tr>\n
\ </table>\n "
title: Alleventscount
type: string
34 changes: 34 additions & 0 deletions api/services/security/v1/parameters/allFindingsCount_query.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
description: "Sum of vulnerabilities, misconfigurations, threats and anomalies\n <br>\n
Copy link
Collaborator

@RachelHooley RachelHooley Jan 5, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sum of all vulnerabilities, misconfigurations, threats, and anomalies.
add:
, before and
all
period at end of sentence

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sum of all vulnerabilities, misconfigurations, threats, and anomalies for today's date.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sum of all vulnerabilities, misconfigurations, threats, and anomalies for today's date.

\ Enter either a number or prefix it with one of the following operators.\n
\ <table>\n <tr>\n <th>Operator</th>\n <th>Notation</th>\n
\ <th>Example</th>\n </tr>\n <tr>\n <td>Equals</td>\n
\ <td>No prefix or optionally \\~eq\\~</td>\n <td>10 or \\~eq\\~10</td>\n
\ </tr>\n <tr>\n <td>Not equals</td>\n <td>\\~neq\\~</td>\n
\ <td>\\~neq\\~10</td>\n </tr>\n <tr>\n <td>Greater than</td>\n
\ <td>\\~gt\\~</td>\n <td>\\~gt\\~10</td>\n </tr>\n <tr>\n
\ <td>Greater than equals</td>\n <td>\\~gte\\~</td>\n <td>\\~gte\\~10</td>\n
\ </tr>\n <tr>\n <td>Less than</td>\n <td>\\~lt\\~</td>\n
\ <td>\\~lt\\~10</td>\n </tr>\n <tr>\n <td>Less than
equals</td>\n <td>\\~lte\\~</td>\n <td>\\~lte\\~10</td>\n </tr>\n
\ <tr>\n <td>Between two ranges</td>\n <td>\\~bt\\~</td>\n <td>\\~bt\\~10,20</td>\n
\ </tr>\n </table>\n "
in: query
name: allFindingsCount
required: false
schema:
description: "Sum of vulnerabilities, misconfigurations, threats and anomalies\n
\ <br>\n Enter either a number or prefix it with one of the following
operators.\n <table>\n <tr>\n <th>Operator</th>\n <th>Notation</th>\n
\ <th>Example</th>\n </tr>\n <tr>\n <td>Equals</td>\n
\ <td>No prefix or optionally \\~eq\\~</td>\n <td>10 or \\~eq\\~10</td>\n
\ </tr>\n <tr>\n <td>Not equals</td>\n <td>\\~neq\\~</td>\n
\ <td>\\~neq\\~10</td>\n </tr>\n <tr>\n <td>Greater
than</td>\n <td>\\~gt\\~</td>\n <td>\\~gt\\~10</td>\n </tr>\n
\ <tr>\n <td>Greater than equals</td>\n <td>\\~gte\\~</td>\n
\ <td>\\~gte\\~10</td>\n </tr>\n <tr>\n <td>Less than</td>\n
\ <td>\\~lt\\~</td>\n <td>\\~lt\\~10</td>\n </tr>\n <tr>\n
\ <td>Less than equals</td>\n <td>\\~lte\\~</td>\n <td>\\~lte\\~10</td>\n
\ </tr>\n <tr>\n <td>Between two ranges</td>\n <td>\\~bt\\~</td>\n
\ <td>\\~bt\\~10,20</td>\n </tr>\n </table>\n "
title: Allfindingscount
type: string
34 changes: 34 additions & 0 deletions api/services/security/v1/parameters/allMisconfigCount_query.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
description: "The total number of misconfigurations found for the asset.\n <br>\n
\ Enter either a number or prefix it with one of the following operators.\n
\ <table>\n <tr>\n <th>Operator</th>\n <th>Notation</th>\n
\ <th>Example</th>\n </tr>\n <tr>\n <td>Equals</td>\n
\ <td>No prefix or optionally \\~eq\\~</td>\n <td>10 or \\~eq\\~10</td>\n
\ </tr>\n <tr>\n <td>Not equals</td>\n <td>\\~neq\\~</td>\n
\ <td>\\~neq\\~10</td>\n </tr>\n <tr>\n <td>Greater than</td>\n
\ <td>\\~gt\\~</td>\n <td>\\~gt\\~10</td>\n </tr>\n <tr>\n
\ <td>Greater than equals</td>\n <td>\\~gte\\~</td>\n <td>\\~gte\\~10</td>\n
\ </tr>\n <tr>\n <td>Less than</td>\n <td>\\~lt\\~</td>\n
\ <td>\\~lt\\~10</td>\n </tr>\n <tr>\n <td>Less than
equals</td>\n <td>\\~lte\\~</td>\n <td>\\~lte\\~10</td>\n </tr>\n
\ <tr>\n <td>Between two ranges</td>\n <td>\\~bt\\~</td>\n <td>\\~bt\\~10,20</td>\n
\ </tr>\n </table>\n "
in: query
name: allMisconfigCount
required: false
schema:
description: "The total number of misconfigurations found for the asset.\n <br>\n
\ Enter either a number or prefix it with one of the following operators.\n
\ <table>\n <tr>\n <th>Operator</th>\n <th>Notation</th>\n
\ <th>Example</th>\n </tr>\n <tr>\n <td>Equals</td>\n
\ <td>No prefix or optionally \\~eq\\~</td>\n <td>10 or \\~eq\\~10</td>\n
\ </tr>\n <tr>\n <td>Not equals</td>\n <td>\\~neq\\~</td>\n
\ <td>\\~neq\\~10</td>\n </tr>\n <tr>\n <td>Greater
than</td>\n <td>\\~gt\\~</td>\n <td>\\~gt\\~10</td>\n </tr>\n
\ <tr>\n <td>Greater than equals</td>\n <td>\\~gte\\~</td>\n
\ <td>\\~gte\\~10</td>\n </tr>\n <tr>\n <td>Less than</td>\n
\ <td>\\~lt\\~</td>\n <td>\\~lt\\~10</td>\n </tr>\n <tr>\n
\ <td>Less than equals</td>\n <td>\\~lte\\~</td>\n <td>\\~lte\\~10</td>\n
\ </tr>\n <tr>\n <td>Between two ranges</td>\n <td>\\~bt\\~</td>\n
\ <td>\\~bt\\~10,20</td>\n </tr>\n </table>\n "
title: Allmisconfigcount
type: string
34 changes: 34 additions & 0 deletions api/services/security/v1/parameters/allThreatsCount_query.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
description: "The total number of threats found for the asset.\n <br>\n Enter
either a number or prefix it with one of the following operators.\n <table>\n
\ <tr>\n <th>Operator</th>\n <th>Notation</th>\n <th>Example</th>\n
\ </tr>\n <tr>\n <td>Equals</td>\n <td>No prefix or optionally
\\~eq\\~</td>\n <td>10 or \\~eq\\~10</td>\n </tr>\n <tr>\n
\ <td>Not equals</td>\n <td>\\~neq\\~</td>\n <td>\\~neq\\~10</td>\n
\ </tr>\n <tr>\n <td>Greater than</td>\n <td>\\~gt\\~</td>\n
\ <td>\\~gt\\~10</td>\n </tr>\n <tr>\n <td>Greater than
equals</td>\n <td>\\~gte\\~</td>\n <td>\\~gte\\~10</td>\n </tr>\n
\ <tr>\n <td>Less than</td>\n <td>\\~lt\\~</td>\n <td>\\~lt\\~10</td>\n
\ </tr>\n <tr>\n <td>Less than equals</td>\n <td>\\~lte\\~</td>\n
\ <td>\\~lte\\~10</td>\n </tr>\n <tr>\n <td>Between two
ranges</td>\n <td>\\~bt\\~</td>\n <td>\\~bt\\~10,20</td>\n </tr>\n
\ </table>\n "
in: query
name: allThreatsCount
required: false
schema:
description: "The total number of threats found for the asset.\n <br>\n Enter
either a number or prefix it with one of the following operators.\n <table>\n
\ <tr>\n <th>Operator</th>\n <th>Notation</th>\n <th>Example</th>\n
\ </tr>\n <tr>\n <td>Equals</td>\n <td>No prefix or
optionally \\~eq\\~</td>\n <td>10 or \\~eq\\~10</td>\n </tr>\n <tr>\n
\ <td>Not equals</td>\n <td>\\~neq\\~</td>\n <td>\\~neq\\~10</td>\n
\ </tr>\n <tr>\n <td>Greater than</td>\n <td>\\~gt\\~</td>\n
\ <td>\\~gt\\~10</td>\n </tr>\n <tr>\n <td>Greater
than equals</td>\n <td>\\~gte\\~</td>\n <td>\\~gte\\~10</td>\n </tr>\n
\ <tr>\n <td>Less than</td>\n <td>\\~lt\\~</td>\n <td>\\~lt\\~10</td>\n
\ </tr>\n <tr>\n <td>Less than equals</td>\n <td>\\~lte\\~</td>\n
\ <td>\\~lte\\~10</td>\n </tr>\n <tr>\n <td>Between
two ranges</td>\n <td>\\~bt\\~</td>\n <td>\\~bt\\~10,20</td>\n </tr>\n
\ </table>\n "
title: Allthreatscount
type: string
34 changes: 34 additions & 0 deletions api/services/security/v1/parameters/allVulnCount_query.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
description: "The total number of vulnerabilities found for the asset.\n <br>\n
\ Enter either a number or prefix it with one of the following operators.\n
\ <table>\n <tr>\n <th>Operator</th>\n <th>Notation</th>\n
\ <th>Example</th>\n </tr>\n <tr>\n <td>Equals</td>\n
\ <td>No prefix or optionally \\~eq\\~</td>\n <td>10 or \\~eq\\~10</td>\n
\ </tr>\n <tr>\n <td>Not equals</td>\n <td>\\~neq\\~</td>\n
\ <td>\\~neq\\~10</td>\n </tr>\n <tr>\n <td>Greater than</td>\n
\ <td>\\~gt\\~</td>\n <td>\\~gt\\~10</td>\n </tr>\n <tr>\n
\ <td>Greater than equals</td>\n <td>\\~gte\\~</td>\n <td>\\~gte\\~10</td>\n
\ </tr>\n <tr>\n <td>Less than</td>\n <td>\\~lt\\~</td>\n
\ <td>\\~lt\\~10</td>\n </tr>\n <tr>\n <td>Less than
equals</td>\n <td>\\~lte\\~</td>\n <td>\\~lte\\~10</td>\n </tr>\n
\ <tr>\n <td>Between two ranges</td>\n <td>\\~bt\\~</td>\n <td>\\~bt\\~10,20</td>\n
\ </tr>\n </table>\n "
in: query
name: allVulnCount
required: false
schema:
description: "The total number of vulnerabilities found for the asset.\n <br>\n
\ Enter either a number or prefix it with one of the following operators.\n
\ <table>\n <tr>\n <th>Operator</th>\n <th>Notation</th>\n
\ <th>Example</th>\n </tr>\n <tr>\n <td>Equals</td>\n
\ <td>No prefix or optionally \\~eq\\~</td>\n <td>10 or \\~eq\\~10</td>\n
\ </tr>\n <tr>\n <td>Not equals</td>\n <td>\\~neq\\~</td>\n
\ <td>\\~neq\\~10</td>\n </tr>\n <tr>\n <td>Greater
than</td>\n <td>\\~gt\\~</td>\n <td>\\~gt\\~10</td>\n </tr>\n
\ <tr>\n <td>Greater than equals</td>\n <td>\\~gte\\~</td>\n
\ <td>\\~gte\\~10</td>\n </tr>\n <tr>\n <td>Less than</td>\n
\ <td>\\~lt\\~</td>\n <td>\\~lt\\~10</td>\n </tr>\n <tr>\n
\ <td>Less than equals</td>\n <td>\\~lte\\~</td>\n <td>\\~lte\\~10</td>\n
\ </tr>\n <tr>\n <td>Between two ranges</td>\n <td>\\~bt\\~</td>\n
\ <td>\\~bt\\~10,20</td>\n </tr>\n </table>\n "
title: Allvulncount
type: string
8 changes: 8 additions & 0 deletions api/services/security/v1/parameters/assetName_query.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
description: The name of the asset ID.
in: query
name: assetName
required: false
schema:
description: The name of the asset ID.
title: Assetname
type: string
Loading
Loading