chore(api): minor updates

Author: stainless-app[bot]

src/gcore/resources/waap/domains/api_discovery.py

@@ -167,9 +167,9 @@ def list_scan_results(
 
           ordering: Sort the response by given field.
 
-          status: The different statuses a task result can have
+          status: Filter by the status of the scan
 
-          type: The different types of scans that can be performed
+          type: Filter by the path of the scan type
 
           extra_headers: Send extra headers
 
@@ -485,9 +485,9 @@ def list_scan_results(
 
           ordering: Sort the response by given field.
 
-          status: The different statuses a task result can have
+          status: Filter by the status of the scan
 
-          type: The different types of scans that can be performed
+          type: Filter by the path of the scan type
 
           extra_headers: Send extra headers
 

src/gcore/resources/waap/domains/api_paths.py

@@ -211,21 +211,21 @@ def list(
 
           api_version: Filter by the API version
 
-          http_scheme: The different HTTP schemes an API path can have
+          http_scheme: Filter by the HTTP version of the API path
 
           ids: Filter by the path ID
 
           limit: Number of items to return
 
-          method: The different methods an API path can have
+          method: Filter by the API RESTful method
 
           offset: Number of items to skip
 
           ordering: Sort the response by given field.
 
           path: Filter by the path. Supports '\\**' as a wildcard character
 
-          source: The different sources an API path can have
+          source: Filter by the source of the discovered API
 
           status: Filter by the status of the discovered API path
 
@@ -529,21 +529,21 @@ def list(
 
           api_version: Filter by the API version
 
-          http_scheme: The different HTTP schemes an API path can have
+          http_scheme: Filter by the HTTP version of the API path
 
           ids: Filter by the path ID
 
           limit: Number of items to return
 
-          method: The different methods an API path can have
+          method: Filter by the API RESTful method
 
           offset: Number of items to skip
 
           ordering: Sort the response by given field.
 
           path: Filter by the path. Supports '\\**' as a wildcard character
 
-          source: The different sources an API path can have
+          source: Filter by the source of the discovered API
 
           status: Filter by the status of the discovered API path
 

src/gcore/resources/waap/insights.py

@@ -76,7 +76,7 @@ def list_types(
 
           ordering: Sort the response by given field.
 
-          slug: The slug of the insight type
+          slug: Filter by the slug of the insight type
 
           extra_headers: Send extra headers
 
@@ -161,7 +161,7 @@ def list_types(
 
           ordering: Sort the response by given field.
 
-          slug: The slug of the insight type
+          slug: Filter by the slug of the insight type
 
           extra_headers: Send extra headers
 

src/gcore/types/waap/domains/api_discovery_list_scan_results_params.py

@@ -35,7 +35,7 @@ class APIDiscoveryListScanResultsParams(TypedDict, total=False):
     """Sort the response by given field."""
 
     status: Optional[Literal["SUCCESS", "FAILURE", "IN_PROGRESS"]]
-    """The different statuses a task result can have"""
+    """Filter by the status of the scan"""
 
     type: Optional[Literal["TRAFFIC_SCAN", "API_DESCRIPTION_FILE_SCAN"]]
-    """The different types of scans that can be performed"""
+    """Filter by the path of the scan type"""

src/gcore/types/waap/domains/api_path_list_params.py

@@ -18,7 +18,7 @@ class APIPathListParams(TypedDict, total=False):
     """Filter by the API version"""
 
     http_scheme: Optional[Literal["HTTP", "HTTPS"]]
-    """The different HTTP schemes an API path can have"""
+    """Filter by the HTTP version of the API path"""
 
     ids: Optional[SequenceNotStr[str]]
     """Filter by the path ID"""
@@ -27,7 +27,7 @@ class APIPathListParams(TypedDict, total=False):
     """Number of items to return"""
 
     method: Optional[Literal["GET", "POST", "PUT", "PATCH", "DELETE", "TRACE", "HEAD", "OPTIONS"]]
-    """The different methods an API path can have"""
+    """Filter by the API RESTful method"""
 
     offset: int
     """Number of items to skip"""
@@ -58,7 +58,7 @@ class APIPathListParams(TypedDict, total=False):
     """Filter by the path. Supports '\\**' as a wildcard character"""
 
     source: Optional[Literal["API_DESCRIPTION_FILE", "TRAFFIC_SCAN", "USER_DEFINED"]]
-    """The different sources an API path can have"""
+    """Filter by the source of the discovered API"""
 
     status: Optional[List[Literal["CONFIRMED_API", "POTENTIAL_API", "NOT_API", "DELISTED_API"]]]
     """Filter by the status of the discovered API path"""

src/gcore/types/waap/insight_list_types_params.py

@@ -25,4 +25,4 @@ class InsightListTypesParams(TypedDict, total=False):
     """Sort the response by given field."""
 
     slug: Optional[str]
-    """The slug of the insight type"""
+    """Filter by the slug of the insight type"""