Skip to content

Commit 5bc33a2

Browse files
committed
Update operation and parameter descriptions (Container Packages)
1 parent 71c9d8a commit 5bc33a2

File tree

1 file changed

+13
-12
lines changed

1 file changed

+13
-12
lines changed

src/falconpy/_endpoint/_container_packages.py

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -95,13 +95,13 @@
9595
{
9696
"type": "integer",
9797
"default": 100,
98-
"description": "The upper-bound on the number of records to retrieve.",
98+
"description": "The upper-bound on the number of records to retrieve. Maximum limit: 100.",
9999
"name": "limit",
100100
"in": "query"
101101
},
102102
{
103103
"type": "integer",
104-
"description": "The offset from where to begin.",
104+
"description": "The offset from where to begin. Maximum offset = 10000 - limit.",
105105
"name": "offset",
106106
"in": "query"
107107
}
@@ -125,13 +125,13 @@
125125
{
126126
"type": "integer",
127127
"default": 100,
128-
"description": "The upper-bound on the number of records to retrieve.",
128+
"description": "The upper-bound on the number of records to retrieve. Maximum limit: 100.",
129129
"name": "limit",
130130
"in": "query"
131131
},
132132
{
133133
"type": "integer",
134-
"description": "The offset from where to begin.",
134+
"description": "The offset from where to begin. Maximum offset = 10000 - limit.",
135135
"name": "offset",
136136
"in": "query"
137137
}
@@ -141,7 +141,8 @@
141141
"ReadPackagesCombinedExport",
142142
"GET",
143143
"/container-security/combined/packages/export/v1",
144-
"Retrieve packages identified by the provided filter criteria for the purpose of export",
144+
"Retrieves a paginated list of packages identified by the provided filter criteria,used for export.Maximum"
145+
"page size: 100. Maximum available packages: 10,000",
145146
"container_packages",
146147
[
147148
{
@@ -169,13 +170,13 @@
169170
{
170171
"type": "integer",
171172
"default": 100,
172-
"description": "The upper-bound on the number of records to retrieve.",
173+
"description": "The upper-bound on the number of records to retrieve. Maximum limit: 100.",
173174
"name": "limit",
174175
"in": "query"
175176
},
176177
{
177178
"type": "integer",
178-
"description": "The offset from where to begin.",
179+
"description": "The offset from where to begin. Maximum offset = 10000 - limit.",
179180
"name": "offset",
180181
"in": "query"
181182
}
@@ -213,13 +214,13 @@
213214
{
214215
"type": "integer",
215216
"default": 100,
216-
"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.",
217218
"name": "limit",
218219
"in": "query"
219220
},
220221
{
221222
"type": "integer",
222-
"description": "The offset from where to begin.",
223+
"description": "The offset from where to begin. Maximum offset = 10000 - limit.",
223224
"name": "offset",
224225
"in": "query"
225226
}
@@ -229,7 +230,7 @@
229230
"ReadPackagesCombinedV2",
230231
"GET",
231232
"/container-security/combined/packages/v2",
232-
"Retrieve packages identified by the provided filter criteria.",
233+
"Retrieve packages identified by the provided filter criteria",
233234
"container_packages",
234235
[
235236
{
@@ -257,13 +258,13 @@
257258
{
258259
"type": "integer",
259260
"default": 100,
260-
"description": "The upper-bound on the number of records to retrieve.",
261+
"description": "The upper-bound on the number of records to retrieve. Maximum limit: 100.",
261262
"name": "limit",
262263
"in": "query"
263264
},
264265
{
265266
"type": "integer",
266-
"description": "The offset from where to begin.",
267+
"description": "The offset from where to begin. Maximum offset = 10000 - limit.",
267268
"name": "offset",
268269
"in": "query"
269270
}

0 commit comments

Comments
 (0)