Skip to content

Commit

Permalink
publish docs for New Asset Sim filter api for spot security (#712)
Browse files Browse the repository at this point in the history
* added changes for asset simfilter api

* removed unused files

* updated: security api docs

* added: fixes

* fix

* update: added changes

* added: fix

* fix

* fix

* fix

---------

Co-authored-by: Avinash Bharti <[email protected]>
  • Loading branch information
abharti1111 and Avinash Bharti authored Jan 9, 2025
1 parent 8c141fd commit 111db40
Show file tree
Hide file tree
Showing 30 changed files with 851 additions and 0 deletions.
33 changes: 33 additions & 0 deletions api/services/security/v1/parameters/affectedAssetsCount_query.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
description: "The number of related assets affected by the finding.\n <br>\n
\ Enter either a number or prefix it with one of these 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 \\~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 numbers</td>\n <td>\\~bt\\~</td>\n
\ <td>\\~bt\\~10,20</td>\n </tr>\n </table>\n "
in: query
name: affectedAssetsCount
required: false
schema:
description: "The number of related assets affected by the finding.\n <br>\n
\ Enter either a number or prefix it with one of these 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
\\~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 numbers</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
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
description: "The total number of anomalies found for the asset identified that are
still applicable today.\n <br>\n Enter either a number or prefix it
with one of these 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 \\~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 numbers</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 identified that
are still applicable today.\n <br>\n Enter either a number or prefix
it with one of these 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 \\~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 numbers</td>\n <td>\\~bt\\~</td>\n
\ <td>\\~bt\\~10,20</td>\n </tr>\n </table>\n "
title: Allanomaliescount
type: string
33 changes: 33 additions & 0 deletions api/services/security/v1/parameters/allEventsCount_query.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
description: "The total number of events found for the asset.\n <br>\n Enter
either a number or prefix it with one of these 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 \\~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 numbers</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 these 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
\\~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 numbers</td>\n <td>\\~bt\\~</td>\n <td>\\~bt\\~10,20</td>\n
\ </tr>\n </table>\n "
title: Alleventscount
type: string
35 changes: 35 additions & 0 deletions api/services/security/v1/parameters/allFindingsCount_query.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
description: "The sum of misconfigurations and vulnerabilities for today's date, and
threats and anomalies identified that are still applicable today.\n <br>\n
\ Enter either a number or prefix it with one of these 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 \\~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 numbers</td>\n <td>\\~bt\\~</td>\n
\ <td>\\~bt\\~10,20</td>\n </tr>\n </table>\n "
in: query
name: allFindingsCount
required: false
schema:
description: "The sum of misconfigurations and vulnerabilities for today's date,
and threats and anomalies identified that are still applicable today.\n <br>\n
\ Enter either a number or prefix it with one of these 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
\\~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 numbers</td>\n <td>\\~bt\\~</td>\n <td>\\~bt\\~10,20</td>\n
\ </tr>\n </table>\n "
title: Allfindingscount
type: string
33 changes: 33 additions & 0 deletions api/services/security/v1/parameters/allMisconfigCount_query.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
description: "The total number of misconfigurations found for the asset.\n <br>\n
\ Enter either a number or prefix it with one of these 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 \\~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 numbers</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 these 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
\\~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 numbers</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
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
description: "The total number of threats found for the asset identified that are
still applicable today.\n <br>\n Enter either a number or prefix it
with one of these 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 \\~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 numbers</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 identified that are
still applicable today.\n <br>\n Enter either a number or prefix
it with one of these 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 \\~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 numbers</td>\n <td>\\~bt\\~</td>\n
\ <td>\\~bt\\~10,20</td>\n </tr>\n </table>\n "
title: Allthreatscount
type: string
33 changes: 33 additions & 0 deletions api/services/security/v1/parameters/allVulnCount_query.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
description: "The total number of vulnerabilities found for the asset.\n <br>\n
\ Enter either a number or prefix it with one of these 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 \\~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 numbers</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 these 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
\\~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 numbers</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
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

0 comments on commit 111db40

Please sign in to comment.