Update operation and parameter descriptions (Container Vulnerabilities)

jshcodes · jshcodes · commit 2a21ee50f334 · 2025-11-07T23:25:54.000-05:00
diff --git a/src/falconpy/_endpoint/_container_vulnerabilities.py b/src/falconpy/_endpoint/_container_vulnerabilities.py
@@ -57,13 +57,13 @@
       {
         "type": "integer",
         "default": 100,
-        "description": "The upper-bound on the number of records to retrieve.",
+        "description": "The upper-bound on the number of records to retrieve. Maximum limit: 100.",
         "name": "limit",
         "in": "query"
       },
       {
         "type": "integer",
-        "description": "The offset from where to begin.",
+        "description": "The offset from where to begin. Maximum offset = 10000 - limit.",
         "name": "offset",
         "in": "query"
       }
@@ -89,13 +89,13 @@
       {
         "type": "integer",
         "default": 100,
-        "description": "The upper-bound on the number of records to retrieve.",
+        "description": "The upper-bound on the number of records to retrieve. Maximum limit: 100.",
         "name": "limit",
         "in": "query"
       },
       {
         "type": "integer",
-        "description": "The offset from where to begin.",
+        "description": "The offset from where to begin. Maximum offset = 10000 - limit.",
         "name": "offset",
         "in": "query"
       }
@@ -105,7 +105,7 @@
     "ReadVulnerabilityCountByCVSSScore",
     "GET",
     "/container-security/aggregates/vulnerabilities/count-by-cvss-score/v1",
-    "Aggregate count of vulnerabilities grouped by cvss score",
+    "Aggregate count of vulnerabilities grouped by CVSS score",
     "container_vulnerabilities",
     [
       {
@@ -121,13 +121,13 @@
       {
         "type": "integer",
         "default": 100,
-        "description": "The upper-bound on the number of records to retrieve.",
+        "description": "The upper-bound on the number of records to retrieve. Maximum limit: 100.",
         "name": "limit",
         "in": "query"
       },
       {
         "type": "integer",
-        "description": "The offset from where to begin.",
+        "description": "The offset from where to begin. Maximum offset = 10000 - limit.",
         "name": "offset",
         "in": "query"
       }
@@ -153,13 +153,13 @@
       {
         "type": "integer",
         "default": 100,
-        "description": "The upper-bound on the number of records to retrieve.",
+        "description": "The upper-bound on the number of records to retrieve. Maximum limit: 100.",
         "name": "limit",
         "in": "query"
       },
       {
         "type": "integer",
-        "description": "The offset from where to begin.",
+        "description": "The offset from where to begin. Maximum offset = 10000 - limit.",
         "name": "offset",
         "in": "query"
       }
@@ -185,13 +185,13 @@
       {
         "type": "integer",
         "default": 100,
-        "description": "The upper-bound on the number of records to retrieve.",
+        "description": "The upper-bound on the number of records to retrieve. Maximum limit: 100.",
         "name": "limit",
         "in": "query"
       },
       {
         "type": "integer",
-        "description": "The offset from where to begin.",
+        "description": "The offset from where to begin. Maximum offset = 10000 - limit.",
         "name": "offset",
         "in": "query"
       }
@@ -214,13 +214,13 @@
       {
         "type": "integer",
         "default": 100,
-        "description": "The upper-bound on the number of records to retrieve.",
+        "description": "The upper-bound on the number of records to retrieve. Maximum limit: 100.",
         "name": "limit",
         "in": "query"
       },
       {
         "type": "integer",
-        "description": "The offset from where to begin.",
+        "description": "The offset from where to begin. Maximum offset = 10000 - limit.",
         "name": "offset",
         "in": "query"
       }
@@ -243,13 +243,13 @@
       {
         "type": "integer",
         "default": 100,
-        "description": "The upper-bound on the number of records to retrieve.",
+        "description": "The upper-bound on the number of records to retrieve. Maximum limit: 100.",
         "name": "limit",
         "in": "query"
       },
       {
         "type": "integer",
-        "description": "The offset from where to begin.",
+        "description": "The offset from where to begin. Maximum offset = 10000 - limit.",
         "name": "offset",
         "in": "query"
       }
@@ -280,13 +280,13 @@
       {
         "type": "integer",
         "default": 5000,
-        "description": "The upper-bound on the number of records to retrieve.",
+        "description": "The upper-bound on the number of records to retrieve. Maximum limit: 5000.",
         "name": "limit",
         "in": "query"
       },
       {
         "type": "integer",
-        "description": "The offset from where to begin.",
+        "description": "The offset from where to begin. Maximum offset = 10000 - limit.",
         "name": "offset",
         "in": "query"
       }
@@ -309,13 +309,13 @@
       {
         "type": "integer",
         "default": 100,
-        "description": "The upper-bound on the number of records to retrieve.",
+        "description": "The upper-bound on the number of records to retrieve. Maximum limit: 100.",
         "name": "limit",
         "in": "query"
       },
       {
         "type": "integer",
-        "description": "The offset from where to begin.",
+        "description": "The offset from where to begin. Maximum offset = 10000 - limit.",
         "name": "offset",
         "in": "query"
       }
@@ -325,7 +325,8 @@
     "ReadCombinedVulnerabilities",
     "GET",
     "/container-security/combined/vulnerabilities/v1",
-    "Retrieve vulnerability and aggregate data filtered by the provided FQL",
+    "Retrieves a paginated list of vulnerabilities filtered by the provided FQL. Maximum page size: 100. "
+    "Maximum available vulnerabilities: 10,000",
     "container_vulnerabilities",
     [
       {
@@ -341,13 +342,13 @@
       {
         "type": "integer",
         "default": 100,
-        "description": "The upper-bound on the number of records to retrieve.",
+        "description": "The upper-bound on the number of records to retrieve. Maximum limit: 100.",
         "name": "limit",
         "in": "query"
       },
       {
         "type": "integer",
-        "description": "The offset from where to begin.",
+        "description": "The offset from where to begin. Maximum offset = 10000 - limit.",
         "name": "offset",
         "in": "query"
       },

Original file line number	Diff line number	Diff line change
`@@ -57,13 +57,13 @@`
`57`	`57`	`{`
`58`	`58`	`"type": "integer",`
`59`	`59`	`"default": 100,`
`60`		`- "description": "The upper-bound on the number of records to retrieve.",`
	`60`	`+ "description": "The upper-bound on the number of records to retrieve. Maximum limit: 100.",`
`61`	`61`	`"name": "limit",`
`62`	`62`	`"in": "query"`
`63`	`63`	`},`
`64`	`64`	`{`
`65`	`65`	`"type": "integer",`
`66`		`- "description": "The offset from where to begin.",`
	`66`	`+ "description": "The offset from where to begin. Maximum offset = 10000 - limit.",`
`67`	`67`	`"name": "offset",`
`68`	`68`	`"in": "query"`
`69`	`69`	`}`
`@@ -89,13 +89,13 @@`
`89`	`89`	`{`
`90`	`90`	`"type": "integer",`
`91`	`91`	`"default": 100,`
`92`		`- "description": "The upper-bound on the number of records to retrieve.",`
	`92`	`+ "description": "The upper-bound on the number of records to retrieve. Maximum limit: 100.",`
`93`	`93`	`"name": "limit",`
`94`	`94`	`"in": "query"`
`95`	`95`	`},`
`96`	`96`	`{`
`97`	`97`	`"type": "integer",`
`98`		`- "description": "The offset from where to begin.",`
	`98`	`+ "description": "The offset from where to begin. Maximum offset = 10000 - limit.",`
`99`	`99`	`"name": "offset",`
`100`	`100`	`"in": "query"`
`101`	`101`	`}`
`@@ -105,7 +105,7 @@`
`105`	`105`	`"ReadVulnerabilityCountByCVSSScore",`
`106`	`106`	`"GET",`
`107`	`107`	`"/container-security/aggregates/vulnerabilities/count-by-cvss-score/v1",`
`108`		`- "Aggregate count of vulnerabilities grouped by cvss score",`
	`108`	`+ "Aggregate count of vulnerabilities grouped by CVSS score",`
`109`	`109`	`"container_vulnerabilities",`
`110`	`110`	`[`
`111`	`111`	`{`
`@@ -121,13 +121,13 @@`
`121`	`121`	`{`
`122`	`122`	`"type": "integer",`
`123`	`123`	`"default": 100,`
`124`		`- "description": "The upper-bound on the number of records to retrieve.",`
	`124`	`+ "description": "The upper-bound on the number of records to retrieve. Maximum limit: 100.",`
`125`	`125`	`"name": "limit",`
`126`	`126`	`"in": "query"`
`127`	`127`	`},`
`128`	`128`	`{`
`129`	`129`	`"type": "integer",`
`130`		`- "description": "The offset from where to begin.",`
	`130`	`+ "description": "The offset from where to begin. Maximum offset = 10000 - limit.",`
`131`	`131`	`"name": "offset",`
`132`	`132`	`"in": "query"`
`133`	`133`	`}`
`@@ -153,13 +153,13 @@`
`153`	`153`	`{`
`154`	`154`	`"type": "integer",`
`155`	`155`	`"default": 100,`
`156`		`- "description": "The upper-bound on the number of records to retrieve.",`
	`156`	`+ "description": "The upper-bound on the number of records to retrieve. Maximum limit: 100.",`
`157`	`157`	`"name": "limit",`
`158`	`158`	`"in": "query"`
`159`	`159`	`},`
`160`	`160`	`{`
`161`	`161`	`"type": "integer",`
`162`		`- "description": "The offset from where to begin.",`
	`162`	`+ "description": "The offset from where to begin. Maximum offset = 10000 - limit.",`
`163`	`163`	`"name": "offset",`
`164`	`164`	`"in": "query"`
`165`	`165`	`}`
`@@ -185,13 +185,13 @@`
`185`	`185`	`{`
`186`	`186`	`"type": "integer",`
`187`	`187`	`"default": 100,`
`188`		`- "description": "The upper-bound on the number of records to retrieve.",`
	`188`	`+ "description": "The upper-bound on the number of records to retrieve. Maximum limit: 100.",`
`189`	`189`	`"name": "limit",`
`190`	`190`	`"in": "query"`
`191`	`191`	`},`
`192`	`192`	`{`
`193`	`193`	`"type": "integer",`
`194`		`- "description": "The offset from where to begin.",`
	`194`	`+ "description": "The offset from where to begin. Maximum offset = 10000 - limit.",`
`195`	`195`	`"name": "offset",`
`196`	`196`	`"in": "query"`
`197`	`197`	`}`
`@@ -214,13 +214,13 @@`
`214`	`214`	`{`
`215`	`215`	`"type": "integer",`
`216`	`216`	`"default": 100,`
`217`		`- "description": "The upper-bound on the number of records to retrieve.",`
	`217`	`+ "description": "The upper-bound on the number of records to retrieve. Maximum limit: 100.",`
`218`	`218`	`"name": "limit",`
`219`	`219`	`"in": "query"`
`220`	`220`	`},`
`221`	`221`	`{`
`222`	`222`	`"type": "integer",`
`223`		`- "description": "The offset from where to begin.",`
	`223`	`+ "description": "The offset from where to begin. Maximum offset = 10000 - limit.",`
`224`	`224`	`"name": "offset",`
`225`	`225`	`"in": "query"`
`226`	`226`	`}`
`@@ -243,13 +243,13 @@`
`243`	`243`	`{`
`244`	`244`	`"type": "integer",`
`245`	`245`	`"default": 100,`
`246`		`- "description": "The upper-bound on the number of records to retrieve.",`
	`246`	`+ "description": "The upper-bound on the number of records to retrieve. Maximum limit: 100.",`
`247`	`247`	`"name": "limit",`
`248`	`248`	`"in": "query"`
`249`	`249`	`},`
`250`	`250`	`{`
`251`	`251`	`"type": "integer",`
`252`		`- "description": "The offset from where to begin.",`
	`252`	`+ "description": "The offset from where to begin. Maximum offset = 10000 - limit.",`
`253`	`253`	`"name": "offset",`
`254`	`254`	`"in": "query"`
`255`	`255`	`}`
`@@ -280,13 +280,13 @@`
`280`	`280`	`{`
`281`	`281`	`"type": "integer",`
`282`	`282`	`"default": 5000,`
`283`		`- "description": "The upper-bound on the number of records to retrieve.",`
	`283`	`+ "description": "The upper-bound on the number of records to retrieve. Maximum limit: 5000.",`
`284`	`284`	`"name": "limit",`
`285`	`285`	`"in": "query"`
`286`	`286`	`},`
`287`	`287`	`{`
`288`	`288`	`"type": "integer",`
`289`		`- "description": "The offset from where to begin.",`
	`289`	`+ "description": "The offset from where to begin. Maximum offset = 10000 - limit.",`
`290`	`290`	`"name": "offset",`
`291`	`291`	`"in": "query"`
`292`	`292`	`}`
`@@ -309,13 +309,13 @@`
`309`	`309`	`{`
`310`	`310`	`"type": "integer",`
`311`	`311`	`"default": 100,`
`312`		`- "description": "The upper-bound on the number of records to retrieve.",`
	`312`	`+ "description": "The upper-bound on the number of records to retrieve. Maximum limit: 100.",`
`313`	`313`	`"name": "limit",`
`314`	`314`	`"in": "query"`
`315`	`315`	`},`
`316`	`316`	`{`
`317`	`317`	`"type": "integer",`
`318`		`- "description": "The offset from where to begin.",`
	`318`	`+ "description": "The offset from where to begin. Maximum offset = 10000 - limit.",`
`319`	`319`	`"name": "offset",`
`320`	`320`	`"in": "query"`
`321`	`321`	`}`
`@@ -325,7 +325,8 @@`
`325`	`325`	`"ReadCombinedVulnerabilities",`
`326`	`326`	`"GET",`
`327`	`327`	`"/container-security/combined/vulnerabilities/v1",`
`328`		`- "Retrieve vulnerability and aggregate data filtered by the provided FQL",`
	`328`	`+ "Retrieves a paginated list of vulnerabilities filtered by the provided FQL. Maximum page size: 100. "`
	`329`	`+ "Maximum available vulnerabilities: 10,000",`
`329`	`330`	`"container_vulnerabilities",`
`330`	`331`	`[`
`331`	`332`	`{`
`@@ -341,13 +342,13 @@`
`341`	`342`	`{`
`342`	`343`	`"type": "integer",`
`343`	`344`	`"default": 100,`
`344`		`- "description": "The upper-bound on the number of records to retrieve.",`
	`345`	`+ "description": "The upper-bound on the number of records to retrieve. Maximum limit: 100.",`
`345`	`346`	`"name": "limit",`
`346`	`347`	`"in": "query"`
`347`	`348`	`},`
`348`	`349`	`{`
`349`	`350`	`"type": "integer",`
`350`		`- "description": "The offset from where to begin.",`
	`351`	`+ "description": "The offset from where to begin. Maximum offset = 10000 - limit.",`
`351`	`352`	`"name": "offset",`
`352`	`353`	`"in": "query"`
`353`	`354`	`},`