crimson-falcon 0.5.0 → 1.0.0

data/spec/api/{container_detections_api_spec.rb → container_detections_spec.rb}

@@ -30,32 +30,32 @@ SOFTWARE.
 require 'spec_helper'
 require 'json'
 
-# Unit tests for Falcon::ContainerDetectionsApi
+# Unit tests for Falcon::ContainerDetections
 # Automatically generated by openapi-generator (https://openapi-generator.tech)
 # Please update as you see appropriate
-describe 'ContainerDetectionsApi' do
-  before do
+describe 'ContainerDetections' do
+  before(:all) do
     # run before each test
-    @api_instance = Falcon::ContainerDetectionsApi.new
+    @api_instance = Falcon::ContainerDetections.new
   end
 
-  after do
+  after(:all) do
     # run after each test
   end
 
-  describe 'test an instance of ContainerDetectionsApi' do
-    it 'should create an instance of ContainerDetectionsApi' do
-      expect(@api_instance).to be_instance_of(Falcon::ContainerDetectionsApi)
+  describe 'test an instance of ContainerDetections' do
+    it 'should create an instance of ContainerDetections' do
+      expect(@api_instance).to be_instance_of(Falcon::ContainerDetections)
     end
   end
 
   # unit tests for read_combined_detections
-  # Retrieve image assessment detections identified by the provided filter criteria
+  # Maximum offset = 10000 - limit
   # @param [Hash] opts the optional parameters
-  # @option opts [String] :filter Filter images using a query in Falcon Query Language (FQL). Supported filters:  cid,container_id,detection_type,id,image_digest,image_id,image_registry,image_repository,image_tag,name,severity
+  # @option opts [String] :filter Filter images detections using a query in Falcon Query Language (FQL). Supported filter fields: - `cid` - `detection_type` - `image_registry` - `image_repository` - `image_tag`
+  # @option opts [String] :sort The fields to sort the records on. Supported columns: - `containers_impacted` - `detection_name` - `detection_severity` - `detection_type` - `images_impacted` - `last_detected`
   # @option opts [Integer] :limit The upper-bound on the number of records to retrieve.
   # @option opts [Integer] :offset The offset from where to begin.
-  # @option opts [String] :sort The fields to sort the records on. Supported columns:  [containers_impacted detection_name detection_severity detection_type images_impacted last_detected]
   # @return [DetectionsApiCombinedDetections]
   describe 'read_combined_detections test' do
     it 'should work' do
@@ -64,9 +64,9 @@ describe 'ContainerDetectionsApi' do
   end
 
   # unit tests for read_detections
-  # Retrieve image assessment detection entities identified by the provided filter criteria
+  # Maximum offset = 10000 - limit
   # @param [Hash] opts the optional parameters
-  # @option opts [String] :filter Filter images using a query in Falcon Query Language (FQL). Supported filters:  cid,detection_type,image_registry,image_repository,image_tag
+  # @option opts [String] :filter Filter images detections using a query in Falcon Query Language (FQL). Supported filter fields: - `cid` - `detection_type` - `image_registry` - `image_repository` - `image_tag`
   # @option opts [Integer] :limit The upper-bound on the number of records to retrieve.
   # @option opts [Integer] :offset The offset from where to begin.
   # @return [DetectionsApiAssessmentDetections]
@@ -79,7 +79,7 @@ describe 'ContainerDetectionsApi' do
   # unit tests for read_detections_count
   # Aggregate count of detections
   # @param [Hash] opts the optional parameters
-  # @option opts [String] :filter Filter images using a query in Falcon Query Language (FQL). Supported filters:  cid,container_id,detection_type,id,image_digest,image_id,image_registry,image_repository,image_tag,name,severity
+  # @option opts [String] :filter Filter images detections using a query in Falcon Query Language (FQL). Supported filter fields: - `cid` - `detection_type` - `image_registry` - `image_repository` - `image_tag`
   # @return [DetectionsApiDetectionsCount]
   describe 'read_detections_count test' do
     it 'should work' do
@@ -90,7 +90,7 @@ describe 'ContainerDetectionsApi' do
   # unit tests for read_detections_count_by_severity
   # Aggregate counts of detections by severity
   # @param [Hash] opts the optional parameters
-  # @option opts [String] :filter Filter images using a query in Falcon Query Language (FQL). Supported filters:  cid,container_id,detection_type,id,image_digest,image_id,image_registry,image_repository,image_tag,name,severity
+  # @option opts [String] :filter Filter images detections using a query in Falcon Query Language (FQL). Supported filter fields: - `cid` - `detection_type` - `image_registry` - `image_repository` - `image_tag`
   # @return [DetectionsApiDetectionsBySeverity]
   describe 'read_detections_count_by_severity test' do
     it 'should work' do
@@ -101,7 +101,7 @@ describe 'ContainerDetectionsApi' do
   # unit tests for read_detections_count_by_type
   # Aggregate counts of detections by detection type
   # @param [Hash] opts the optional parameters
-  # @option opts [String] :filter Filter images using a query in Falcon Query Language (FQL). Supported filters:  cid,container_id,detection_type,id,image_digest,image_id,image_registry,image_repository,image_tag,name,severity
+  # @option opts [String] :filter Filter images detections using a query in Falcon Query Language (FQL). Supported filter fields: - `cid` - `detection_type` - `image_registry` - `image_repository` - `image_tag`
   # @return [DetectionsApiDetectionsByType]
   describe 'read_detections_count_by_type test' do
     it 'should work' do
@@ -110,9 +110,9 @@ describe 'ContainerDetectionsApi' do
   end
 
   # unit tests for search_detections
-  # Retrieve image assessment detection entities identified by the provided filter criteria
+  # Maximum offset = 10000 - limit
   # @param [Hash] opts the optional parameters
-  # @option opts [String] :filter Filter images using a query in Falcon Query Language (FQL). Supported filters:  cid,container_id,detection_type,id,image_digest,image_id,image_registry,image_repository,image_tag,name,severity
+  # @option opts [String] :filter Filter images detections using a query in Falcon Query Language (FQL). Supported filter fields: - `cid` - `detection_type` - `image_registry` - `image_repository` - `image_tag`
   # @option opts [Integer] :limit The upper-bound on the number of records to retrieve.
   # @option opts [Integer] :offset The offset from where to begin.
   # @return [CommonGenericEntityResponseString]

data/spec/api/{container_images_api_spec.rb → container_images_spec.rb}

@@ -30,29 +30,29 @@ SOFTWARE.
 require 'spec_helper'
 require 'json'
 
-# Unit tests for Falcon::ContainerImagesApi
+# Unit tests for Falcon::ContainerImages
 # Automatically generated by openapi-generator (https://openapi-generator.tech)
 # Please update as you see appropriate
-describe 'ContainerImagesApi' do
-  before do
+describe 'ContainerImages' do
+  before(:all) do
     # run before each test
-    @api_instance = Falcon::ContainerImagesApi.new
+    @api_instance = Falcon::ContainerImages.new
   end
 
-  after do
+  after(:all) do
     # run after each test
   end
 
-  describe 'test an instance of ContainerImagesApi' do
-    it 'should create an instance of ContainerImagesApi' do
-      expect(@api_instance).to be_instance_of(Falcon::ContainerImagesApi)
+  describe 'test an instance of ContainerImages' do
+    it 'should create an instance of ContainerImages' do
+      expect(@api_instance).to be_instance_of(Falcon::ContainerImages)
     end
   end
 
   # unit tests for aggregate_image_assessment_history
   # Image assessment history
   # @param [Hash] opts the optional parameters
-  # @option opts [String] :filter Filter using a query in Falcon Query Language (FQL). Supported filters:  cid,registry,repository
+  # @option opts [String] :filter Filter using a query in Falcon Query Language (FQL). Supported filter fields: - `cid` - `registry` - `repository`
   # @return [ImagesApiImageAssessmentHistory]
   describe 'aggregate_image_assessment_history test' do
     it 'should work' do
@@ -63,7 +63,7 @@ describe 'ContainerImagesApi' do
   # unit tests for aggregate_image_count
   # Aggregate count of images
   # @param [Hash] opts the optional parameters
-  # @option opts [String] :filter Filter images using a query in Falcon Query Language (FQL). Supported filters:  arch,base_os,cid,container_id,container_running_status,cps_rating,crowdstrike_user,cve_id,detection_count,detection_name,detection_severity,first_seen,image_digest,image_id,include_base_image_vuln,layer_digest,package_name_version,registry,repository,source,tag,vulnerability_count,vulnerability_severity
+  # @option opts [String] :filter Filter images using a query in Falcon Query Language (FQL). Supported filter fields: - `ai_related` - `arch` - `base_os` - `cid` - `container_id` - `container_running_status` - `cps_rating` - `crowdstrike_user` - `cve_id` - `detection_count` - `detection_name` - `detection_severity` - `first_seen` - `image_digest` - `image_id` - `include_base_image_vuln` - `layer_digest` - `package_name_version` - `registry` - `repository` - `source` - `tag` - `vulnerability_count` - `vulnerability_severity`
   # @return [ImagesApiImageCount]
   describe 'aggregate_image_count test' do
     it 'should work' do
@@ -74,7 +74,7 @@ describe 'ContainerImagesApi' do
   # unit tests for aggregate_image_count_by_base_os
   # Aggregate count of images grouped by Base OS distribution
   # @param [Hash] opts the optional parameters
-  # @option opts [String] :filter Filter images using a query in Falcon Query Language (FQL). Supported filters:  arch,base_os,cid,registry,repository,tag
+  # @option opts [String] :filter Filter images using a query in Falcon Query Language (FQL). Supported filter fields: - `registry` - `repository` - `tag`
   # @return [ImagesApiImageCountByBaseOS]
   describe 'aggregate_image_count_by_base_os test' do
     it 'should work' do
@@ -85,7 +85,7 @@ describe 'ContainerImagesApi' do
   # unit tests for aggregate_image_count_by_state
   # Aggregate count of images grouped by state
   # @param [Hash] opts the optional parameters
-  # @option opts [String] :filter Filter images using a query in Falcon Query Language (FQL). Supported filters:  cid,last_seen,registry,repository
+  # @option opts [String] :filter Filter images using a query in Falcon Query Language (FQL). Supported filter fields: - `registry` - `repository` - `tag`
   # @return [ImagesApiImageCountByState]
   describe 'aggregate_image_count_by_state test' do
     it 'should work' do
@@ -94,9 +94,9 @@ describe 'ContainerImagesApi' do
   end
 
   # unit tests for combined_base_images
-  # Retrieve base images for provided filter
+  # Retrieves a list of base images for the provided filter. Maximum page size: 100
   # @param [Hash] opts the optional parameters
-  # @option opts [String] :filter Search base images using a query in Falcon Query Language (FQL). Supported filters:  image_digest,image_id,registry,repository,tag
+  # @option opts [String] :filter Search base images using a query in Falcon Query Language (FQL). Supported filter fields: - `image_digest` - `image_id` - `registry` - `repository` - `tag`
   # @return [CoreEntitiesResponse]
   describe 'combined_base_images test' do
     it 'should work' do
@@ -107,9 +107,9 @@ describe 'ContainerImagesApi' do
   # unit tests for combined_image_by_vulnerability_count
   # Retrieve top x images with the most vulnerabilities
   # @param [Hash] opts the optional parameters
-  # @option opts [String] :filter Filter images using a query in Falcon Query Language (FQL). Supported filters:  arch,base_os,cid,registry,repository,tag
+  # @option opts [String] :filter Filter images using a query in Falcon Query Language (FQL). Supported filter fields: - `registry` - `repository` - `tag`
   # @option opts [Integer] :limit The upper-bound on the number of records to retrieve.
-  # @option opts [Integer] :offset This is not used in the backend but is added here for compatibility purposes as some clients expects this i.e UI widgets.
+  # @option opts [Integer] :offset The fields to sort the records on. **Not supported.**
   # @return [ImagesApiImageByVulnerabilityCount]
   describe 'combined_image_by_vulnerability_count test' do
     it 'should work' do
@@ -118,13 +118,13 @@ describe 'ContainerImagesApi' do
   end
 
   # unit tests for combined_image_detail
-  # Retrieve image entities identified by the provided filter criteria
+  # Maximum offset = 10000 - limit
   # @param [Hash] opts the optional parameters
-  # @option opts [String] :filter Filter images using a query in Falcon Query Language (FQL). Supported filters:  registry,repository,tag
+  # @option opts [String] :filter Filter images using a query in Falcon Query Language (FQL). Supported filter fields: - `registry` - `repository` - `tag`
   # @option opts [Boolean] :with_config (true/false) include image config, default is false
+  # @option opts [String] :sort The fields to sort the records on.
   # @option opts [Integer] :limit The upper-bound on the number of records to retrieve.
   # @option opts [Integer] :offset The offset from where to begin.
-  # @option opts [String] :sort The fields to sort the records on.
   # @return [ImagesApiCustomerAndImage]
   describe 'combined_image_detail test' do
     it 'should work' do
@@ -134,12 +134,12 @@ describe 'ContainerImagesApi' do
 
   # unit tests for combined_image_issues_summary
   # Retrieve image issues summary such as Image detections, Runtime detections, Policies, vulnerabilities
-  # @param cid CID
-  # @param registry registry name
-  # @param repository repository name
-  # @param tag tag name
+  # @param cid CS Customer ID
+  # @param registry Registry
+  # @param repository Repository name
+  # @param tag Tag name
   # @param [Hash] opts the optional parameters
-  # @option opts [Boolean] :include_base_image_vuln include base image vulnerabilities
+  # @option opts [Boolean] :include_base_image_vuln Include base image vulnerabilities.
   # @return [ImagesApiImageIssuesSummary]
   describe 'combined_image_issues_summary test' do
     it 'should work' do
@@ -149,12 +149,12 @@ describe 'ContainerImagesApi' do
 
   # unit tests for combined_image_vulnerability_summary
   # aggregates information about vulnerabilities for an image
-  # @param cid CID
-  # @param registry registry name
-  # @param repository repository name
-  # @param tag tag name
+  # @param cid CS Customer ID
+  # @param registry Registry
+  # @param repository Repository name
+  # @param tag Tag name
   # @param [Hash] opts the optional parameters
-  # @option opts [Boolean] :include_base_image_vuln include base image vulnerabilities
+  # @option opts [Boolean] :include_base_image_vuln Include base image vulnerabilities.
   # @return [ImagesApiImageVulnerabilitiesSummary]
   describe 'combined_image_vulnerability_summary test' do
     it 'should work' do
@@ -185,12 +185,12 @@ describe 'ContainerImagesApi' do
   end
 
   # unit tests for get_combined_images
-  # Get image assessment results by providing an FQL filter and paging details
+  # Maximum offset = 10000 - limit
   # @param [Hash] opts the optional parameters
-  # @option opts [String] :filter Filter images using a query in Falcon Query Language (FQL). Supported filters:  container_id, container_running_status, cve_id, detection_name, detection_severity, first_seen, image_digest, image_id, registry, repository, tag, vulnerability_severity
-  # @option opts [Integer] :limit The upper-bound on the number of records to retrieve [1-100]
+  # @option opts [String] :filter Filter images using a query in Falcon Query Language (FQL). Supported filter fields: - `ai_related` - `container_id` - `container_running_status` - `cve_id` - `detection_name` - `detection_severity` - `first_seen` - `image_digest` - `image_id` - `registry` - `repository` - `tag` - `vulnerability_severity`
+  # @option opts [String] :sort The fields to sort the records on. Supported columns: - `first_seen` - `highest_detection_severity` - `highest_vulnerability_severity` - `image_digest` - `image_id` - `registry` - `repository` - `source` - `tag`
+  # @option opts [Integer] :limit The upper-bound on the number of records to retrieve.
   # @option opts [Integer] :offset The offset from where to begin.
-  # @option opts [String] :sort The fields to sort the records on. Supported columns:  [first_seen highest_detection_severity highest_vulnerability_severity image_digest image_id registry repository source tag]
   # @return [ImagesExtCombinedImagesResponse]
   describe 'get_combined_images test' do
     it 'should work' do
@@ -199,14 +199,14 @@ describe 'ContainerImagesApi' do
   end
 
   # unit tests for read_combined_images_export
-  # Retrieve images with an option to expand aggregated vulnerabilities/detections
+  # Maximum offset = 10000 - limit
   # @param [Hash] opts the optional parameters
-  # @option opts [String] :filter Filter images using a query in Falcon Query Language (FQL). Supported filters:  arch,base_os,cid,container_id,container_running_status,cps_rating,crowdstrike_user,cve_id,detection_count,detection_name,detection_severity,first_seen,image_digest,image_id,include_base_image_vuln,layer_digest,package_name_version,registry,repository,source,tag,vulnerability_count,vulnerability_severity
-  # @option opts [Boolean] :expand_vulnerabilities expand vulnerabilities
-  # @option opts [Boolean] :expand_detections expand detections
+  # @option opts [String] :filter Filter images using a query in Falcon Query Language (FQL). Supported filter fields: - `ai_related` - `arch` - `base_os` - `cid` - `container_id` - `container_running_status` - `cps_rating` - `crowdstrike_user` - `cve_id` - `detection_count` - `detection_name` - `detection_severity` - `first_seen` - `image_digest` - `image_id` - `include_base_image_vuln` - `layer_digest` - `package_name_version` - `registry` - `repository` - `source` - `tag` - `vulnerability_count` - `vulnerability_severity`
+  # @option opts [Boolean] :expand_vulnerabilities Expand vulnerabilities details
+  # @option opts [Boolean] :expand_detections Expand detections details
   # @option opts [Integer] :limit The upper-bound on the number of records to retrieve.
   # @option opts [Integer] :offset The offset from where to begin.
-  # @option opts [String] :sort The fields to sort the records on. Supported columns:  [base_os cid detections firstScanned first_seen highest_cps_current_rating highest_detection_severity highest_vulnerability_severity image_digest image_id last_seen layers_with_vulnerabilities packages registry repository source tag vulnerabilities]
+  # @option opts [String] :sort The fields to sort the records on. Supported columns: - `base_os` - `cid` - `detections` - `firstScanned` - `first_seen` - `highest_cps_current_rating` - `highest_detection_severity` - `highest_vulnerability_severity` - `image_digest` - `image_id` - `last_seen` - `layers_with_vulnerabilities` - `packages` - `registry` - `repository` - `source` - `tag` - `vulnerabilities`
   # @return [ImagesApiCombinedImageExport]
   describe 'read_combined_images_export test' do
     it 'should work' do

data/spec/api/{container_packages_api_spec.rb → container_packages_spec.rb}

@@ -30,29 +30,29 @@ SOFTWARE.
 require 'spec_helper'
 require 'json'
 
-# Unit tests for Falcon::ContainerPackagesApi
+# Unit tests for Falcon::ContainerPackages
 # Automatically generated by openapi-generator (https://openapi-generator.tech)
 # Please update as you see appropriate
-describe 'ContainerPackagesApi' do
-  before do
+describe 'ContainerPackages' do
+  before(:all) do
     # run before each test
-    @api_instance = Falcon::ContainerPackagesApi.new
+    @api_instance = Falcon::ContainerPackages.new
   end
 
-  after do
+  after(:all) do
     # run after each test
   end
 
-  describe 'test an instance of ContainerPackagesApi' do
-    it 'should create an instance of ContainerPackagesApi' do
-      expect(@api_instance).to be_instance_of(Falcon::ContainerPackagesApi)
+  describe 'test an instance of ContainerPackages' do
+    it 'should create an instance of ContainerPackages' do
+      expect(@api_instance).to be_instance_of(Falcon::ContainerPackages)
     end
   end
 
   # unit tests for read_packages_by_fixable_vuln_count
-  # Retrieve top x app packages with the most fixable vulnerabilities
+  # Maximum offset = 10000 - limit
   # @param [Hash] opts the optional parameters
-  # @option opts [String] :filter Filter packages using a query in Falcon Query Language (FQL). Supported filters: cid,container_id,cveid,fix_status,image_digest,license,package_name_version,severity,type,vulnerability_count
+  # @option opts [String] :filter Filter packages using a query in Falcon Query Language (FQL). Supported filter fields: - `ai_related` - `cid` - `container_id` - `cveid` - `fix_status` - `image_digest` - `license` - `package_name_version` - `severity` - `type` - `vulnerability_count`
   # @option opts [Integer] :limit The upper-bound on the number of records to retrieve.
   # @option opts [Integer] :offset The offset from where to begin.
   # @return [PackagesApiPackagesByVulnCount]
@@ -63,9 +63,9 @@ describe 'ContainerPackagesApi' do
   end
 
   # unit tests for read_packages_by_vuln_count
-  # Retrieve top x packages with the most vulnerabilities
+  # Maximum offset = 10000 - limit
   # @param [Hash] opts the optional parameters
-  # @option opts [String] :filter Filter packages using a query in Falcon Query Language (FQL). Supported filters: cid,container_id,cveid,fix_status,image_digest,license,package_name_version,severity,type,vulnerability_count
+  # @option opts [String] :filter Filter packages using a query in Falcon Query Language (FQL). Supported filter fields: - `ai_related` - `cid` - `container_id` - `cveid` - `fix_status` - `image_digest` - `license` - `package_name_version` - `severity` - `type` - `vulnerability_count`
   # @option opts [Integer] :limit The upper-bound on the number of records to retrieve.
   # @option opts [Integer] :offset The offset from where to begin.
   # @return [PackagesApiPackagesByVulnCount]
@@ -76,13 +76,13 @@ describe 'ContainerPackagesApi' do
   end
 
   # unit tests for read_packages_combined
-  # Retrieve packages identified by the provided filter criteria
+  # Maximum offset = 10000 - limit
   # @param [Hash] opts the optional parameters
-  # @option opts [String] :filter Filter packages using a query in Falcon Query Language (FQL). Supported filters:  cid,container_id,cveid,fix_status,image_digest,license,package_name_version,severity,type,vulnerability_count
-  # @option opts [Boolean] :only_zero_day_affected (true/false) load zero day affected packages, default is false
+  # @option opts [String] :filter Filter packages using a query in Falcon Query Language (FQL). Supported filter fields: - `ai_related` - `cid` - `container_id` - `cveid` - `fix_status` - `image_digest` - `license` - `package_name_version` - `severity` - `type` - `vulnerability_count`
+  # @option opts [Boolean] :only_zero_day_affected (true/false) load zero day affected packages
+  # @option opts [String] :sort The fields to sort the records on. Supported columns: - `license` - `package_name_version` - `type`
   # @option opts [Integer] :limit The upper-bound on the number of records to retrieve.
   # @option opts [Integer] :offset The offset from where to begin.
-  # @option opts [String] :sort The fields to sort the records on. Supported columns:  [license package_name_version type]
   # @return [PackagesApiCombinedPackage]
   describe 'read_packages_combined test' do
     it 'should work' do
@@ -91,13 +91,13 @@ describe 'ContainerPackagesApi' do
   end
 
   # unit tests for read_packages_combined_export
-  # Retrieve packages identified by the provided filter criteria for the purpose of export
+  # Maximum offset = 10000 - limit
   # @param [Hash] opts the optional parameters
-  # @option opts [String] :filter Filter packages using a query in Falcon Query Language (FQL). Supported filters:  cid,container_id,cveid,fix_status,image_digest,license,package_name_version,severity,type,vulnerability_count
-  # @option opts [Boolean] :only_zero_day_affected (true/false) load zero day affected packages, default is false
+  # @option opts [String] :filter Filter packages using a query in Falcon Query Language (FQL). Supported filter fields: - `ai_related` - `cid` - `container_id` - `cveid` - `fix_status` - `image_digest` - `license` - `package_name_version` - `severity` - `type` - `vulnerability_count`
+  # @option opts [Boolean] :only_zero_day_affected (true/false) load zero day affected packages
+  # @option opts [String] :sort The fields to sort the records on. Supported columns: - `license` - `package_name_version` - `type`
   # @option opts [Integer] :limit The upper-bound on the number of records to retrieve.
   # @option opts [Integer] :offset The offset from where to begin.
-  # @option opts [String] :sort The fields to sort the records on. Supported columns:  [license package_name_version type]
   # @return [PackagesApiCombinedPackageExport]
   describe 'read_packages_combined_export test' do
     it 'should work' do
@@ -105,10 +105,25 @@ describe 'ContainerPackagesApi' do
     end
   end
 
+  # unit tests for read_packages_combined_v2
+  # Maximum offset = 10000 - limit
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :filter Filter packages using a query in Falcon Query Language (FQL). Supported filter fields: - `ai_related` - `cid` - `container_id` - `cveid` - `fix_status` - `image_digest` - `license` - `package_name_version` - `severity` - `type` - `vulnerability_count`
+  # @option opts [Boolean] :only_zero_day_affected (true/false) load zero day affected packages
+  # @option opts [String] :sort The fields to sort the records on. Supported columns: - `license` - `package_name_version` - `type`
+  # @option opts [Integer] :limit The upper-bound on the number of records to retrieve.
+  # @option opts [Integer] :offset The offset from where to begin.
+  # @return [PackagesApiCombinedPackageV2]
+  describe 'read_packages_combined_v2 test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
   # unit tests for read_packages_count_by_zero_day
   # Retrieve packages count affected by zero day vulnerabilities
   # @param [Hash] opts the optional parameters
-  # @option opts [String] :filter Filter packages using a query in Falcon Query Language (FQL). Supported filters: cid
+  # @option opts [String] :filter Filter packages using a query in Falcon Query Language (FQL). Supported filter fields: - `cid`
   # @return [CommonCountResponse]
   describe 'read_packages_count_by_zero_day test' do
     it 'should work' do

data/spec/api/{container_vulnerabilities_api_spec.rb → container_vulnerabilities_spec.rb}

@@ -30,32 +30,32 @@ SOFTWARE.
 require 'spec_helper'
 require 'json'
 
-# Unit tests for Falcon::ContainerVulnerabilitiesApi
+# Unit tests for Falcon::ContainerVulnerabilities
 # Automatically generated by openapi-generator (https://openapi-generator.tech)
 # Please update as you see appropriate
-describe 'ContainerVulnerabilitiesApi' do
-  before do
+describe 'ContainerVulnerabilities' do
+  before(:all) do
     # run before each test
-    @api_instance = Falcon::ContainerVulnerabilitiesApi.new
+    @api_instance = Falcon::ContainerVulnerabilities.new
   end
 
-  after do
+  after(:all) do
     # run after each test
   end
 
-  describe 'test an instance of ContainerVulnerabilitiesApi' do
-    it 'should create an instance of ContainerVulnerabilitiesApi' do
-      expect(@api_instance).to be_instance_of(Falcon::ContainerVulnerabilitiesApi)
+  describe 'test an instance of ContainerVulnerabilities' do
+    it 'should create an instance of ContainerVulnerabilities' do
+      expect(@api_instance).to be_instance_of(Falcon::ContainerVulnerabilities)
     end
   end
 
   # unit tests for read_combined_vulnerabilities
-  # Retrieve vulnerability and aggregate data filtered by the provided FQL
+  # Maximum offset = 10000 - limit
   # @param [Hash] opts the optional parameters
-  # @option opts [String] :filter Filter vulnerabilities using a query in Falcon Query Language (FQL). Supported filters: base_os,cid,container_id,container_running_status,containers_impacted_range,cps_rating,cve_id,cvss_score,description,exploited_status,exploited_status_name,fix_status,image_digest,image_id,images_impacted_range,include_base_image_vuln,package_name_version,registry,repository,severity,tag
+  # @option opts [String] :filter Filter vulnerabilities using a query in Falcon Query Language (FQL). Supported filter fields: - `ai_related` - `base_os` - `cid` - `container_id` - `container_running_status` - `containers_impacted_range` - `cps_rating` - `cve_id` - `cvss_score` - `description` - `exploited_status_name` - `exploited_status` - `fix_status` - `image_digest` - `image_id` - `images_impacted_range` - `include_base_image_vuln` - `package_name_version` - `registry` - `repository` - `severity` - `tag`
   # @option opts [Integer] :limit The upper-bound on the number of records to retrieve.
   # @option opts [Integer] :offset The offset from where to begin.
-  # @option opts [String] :sort The fields to sort the records on. Supported columns:  [cps_current_rating cve_id cvss_score description images_impacted packages_impacted severity]
+  # @option opts [String] :sort The fields to sort the records on. Supported columns: - `cps_current_rating` - `cve_id` - `cvss_score` - `description` - `images_impacted` - `packages_impacted` - `severity`
   # @return [VulnerabilitiesApiCombinedVulnerability]
   describe 'read_combined_vulnerabilities test' do
     it 'should work' do
@@ -64,10 +64,10 @@ describe 'ContainerVulnerabilitiesApi' do
   end
 
   # unit tests for read_combined_vulnerabilities_details
-  # Retrieve vulnerability details related to an image
+  # Maximum offset = 10000 - limit
   # @param id Image UUID
   # @param [Hash] opts the optional parameters
-  # @option opts [String] :filter Filter the vulnerabilities using a query in Falcon Query Language (FQL). Supported vulnerability filters: cid,cps_rating,cve_id,cvss_score,exploited_status,exploited_status_name,include_base_image_vuln,is_zero_day,remediation_available,severity
+  # @option opts [String] :filter Filter the vulnerabilities using a query in Falcon Query Language (FQL). Supported vulnerability filter fields: - `cid` - `cps_rating` - `cve_id` - `cvss_score` - `exploited_status_name` - `exploited_status` - `include_base_image_vuln` - `is_zero_day` - `remediation_available` - `severity`
   # @option opts [Integer] :limit The upper-bound on the number of records to retrieve.
   # @option opts [Integer] :offset The offset from where to begin.
   # @return [VulnerabilitiesApiCombinedVulnerabilityDetails]
@@ -78,7 +78,7 @@ describe 'ContainerVulnerabilitiesApi' do
   end
 
   # unit tests for read_combined_vulnerabilities_info
-  # Retrieve vulnerability and package related info for this customer
+  # Maximum offset = 10000 - limit
   # @param cve_id Vulnerability CVE ID
   # @param [Hash] opts the optional parameters
   # @option opts [Integer] :limit The upper-bound on the number of records to retrieve.
@@ -91,9 +91,9 @@ describe 'ContainerVulnerabilitiesApi' do
   end
 
   # unit tests for read_vulnerabilities_by_image_count
-  # Retrieve top x vulnerabilities with the most impacted images
+  # Maximum offset = 10000 - limit
   # @param [Hash] opts the optional parameters
-  # @option opts [String] :filter Filter vulnerabilities using a query in Falcon Query Language (FQL). Supported filters: cid,cve_id,registry,repository,tag
+  # @option opts [String] :filter Filter vulnerabilities using a query in Falcon Query Language (FQL). Supported filter fields: - `cid` - `cve_id` - `registry` - `repository` - `tag`
   # @option opts [Integer] :limit The upper-bound on the number of records to retrieve.
   # @option opts [Integer] :offset The offset from where to begin.
   # @return [VulnerabilitiesApiVulnByImageCount]
@@ -104,9 +104,9 @@ describe 'ContainerVulnerabilitiesApi' do
   end
 
   # unit tests for read_vulnerabilities_publication_date
-  # Retrieve top x vulnerabilities with the most recent publication date
+  # Maximum offset = 10000 - limit
   # @param [Hash] opts the optional parameters
-  # @option opts [String] :filter Filter vulnerabilities using a query in Falcon Query Language (FQL). Supported filters: cid,cve_id,registry,repository,tag
+  # @option opts [String] :filter Filter vulnerabilities using a query in Falcon Query Language (FQL). Supported filter fields: - `cid` - `cve_id` - `registry` - `repository` - `tag`
   # @option opts [Integer] :limit The upper-bound on the number of records to retrieve.
   # @option opts [Integer] :offset The offset from where to begin.
   # @return [VulnerabilitiesApiVulnByPublication]
@@ -117,9 +117,9 @@ describe 'ContainerVulnerabilitiesApi' do
   end
 
   # unit tests for read_vulnerability_count
-  # Aggregate count of vulnerabilities
+  # Maximum offset = 10000 - limit
   # @param [Hash] opts the optional parameters
-  # @option opts [String] :filter Filter vulnerabilities using a query in Falcon Query Language (FQL). Supported filters: base_os,cid,container_id,container_running_status,containers_impacted_range,cps_rating,cve_id,cvss_score,description,exploited_status,exploited_status_name,fix_status,image_digest,image_id,images_impacted_range,include_base_image_vuln,package_name_version,registry,repository,severity,tag
+  # @option opts [String] :filter Filter vulnerabilities using a query in Falcon Query Language (FQL). Supported filter fields: - `ai_related` - `base_os` - `cid` - `container_id` - `container_running_status` - `containers_impacted_range` - `cps_rating` - `cve_id` - `cvss_score` - `description` - `exploited_status_name` - `exploited_status` - `fix_status` - `image_digest` - `image_id` - `images_impacted_range` - `include_base_image_vuln` - `package_name_version` - `registry` - `repository` - `severity` - `tag`
   # @option opts [Integer] :limit The upper-bound on the number of records to retrieve.
   # @option opts [Integer] :offset The offset from where to begin.
   # @return [VulnerabilitiesApiVulnCount]
@@ -130,9 +130,9 @@ describe 'ContainerVulnerabilitiesApi' do
   end
 
   # unit tests for read_vulnerability_count_by_actively_exploited
-  # Aggregate count of vulnerabilities grouped by actively exploited
+  # Maximum offset = 10000 - limit
   # @param [Hash] opts the optional parameters
-  # @option opts [String] :filter Filter vulnerabilities using a query in Falcon Query Language (FQL). Supported filters: base_os,cid,container_id,container_running_status,containers_impacted_range,cps_rating,cve_id,cvss_score,description,exploited_status,exploited_status_name,fix_status,image_digest,image_id,images_impacted_range,include_base_image_vuln,package_name_version,registry,repository,severity,tag
+  # @option opts [String] :filter Filter vulnerabilities using a query in Falcon Query Language (FQL). Supported filter fields: - `ai_related` - `base_os` - `cid` - `container_id` - `container_running_status` - `containers_impacted_range` - `cps_rating` - `cve_id` - `cvss_score` - `description` - `exploited_status_name` - `exploited_status` - `fix_status` - `image_digest` - `image_id` - `images_impacted_range` - `include_base_image_vuln` - `package_name_version` - `registry` - `repository` - `severity` - `tag`
   # @option opts [Integer] :limit The upper-bound on the number of records to retrieve.
   # @option opts [Integer] :offset The offset from where to begin.
   # @return [VulnerabilitiesApiVulnCountByActivelyExploited]
@@ -143,9 +143,9 @@ describe 'ContainerVulnerabilitiesApi' do
   end
 
   # unit tests for read_vulnerability_count_by_cps_rating
-  # Aggregate count of vulnerabilities grouped by csp_rating
+  # Maximum offset = 10000 - limit
   # @param [Hash] opts the optional parameters
-  # @option opts [String] :filter Filter vulnerabilities using a query in Falcon Query Language (FQL). Supported filters: base_os,cid,container_id,container_running_status,containers_impacted_range,cps_rating,cve_id,cvss_score,description,exploited_status,exploited_status_name,fix_status,image_digest,image_id,images_impacted_range,include_base_image_vuln,package_name_version,registry,repository,severity,tag
+  # @option opts [String] :filter Filter vulnerabilities using a query in Falcon Query Language (FQL). Supported filter fields: - `ai_related` - `base_os` - `cid` - `container_id` - `container_running_status` - `containers_impacted_range` - `cps_rating` - `cve_id` - `cvss_score` - `description` - `exploited_status_name` - `exploited_status` - `fix_status` - `image_digest` - `image_id` - `images_impacted_range` - `include_base_image_vuln` - `package_name_version` - `registry` - `repository` - `severity` - `tag`
   # @option opts [Integer] :limit The upper-bound on the number of records to retrieve.
   # @option opts [Integer] :offset The offset from where to begin.
   # @return [VulnerabilitiesApiVulnCountByCSPRating]
@@ -156,9 +156,9 @@ describe 'ContainerVulnerabilitiesApi' do
   end
 
   # unit tests for read_vulnerability_count_by_cvss_score
-  # Aggregate count of vulnerabilities grouped by cvss score
+  # Maximum offset = 10000 - limit
   # @param [Hash] opts the optional parameters
-  # @option opts [String] :filter Filter vulnerabilities using a query in Falcon Query Language (FQL). Supported filters: base_os,cid,container_id,container_running_status,containers_impacted_range,cps_rating,cve_id,cvss_score,description,exploited_status,exploited_status_name,fix_status,image_digest,image_id,images_impacted_range,include_base_image_vuln,package_name_version,registry,repository,severity,tag
+  # @option opts [String] :filter Filter vulnerabilities using a query in Falcon Query Language (FQL). Supported filter fields: - `ai_related` - `base_os` - `cid` - `container_id` - `container_running_status` - `containers_impacted_range` - `cps_rating` - `cve_id` - `cvss_score` - `description` - `exploited_status_name` - `exploited_status` - `fix_status` - `image_digest` - `image_id` - `images_impacted_range` - `include_base_image_vuln` - `package_name_version` - `registry` - `repository` - `severity` - `tag`
   # @option opts [Integer] :limit The upper-bound on the number of records to retrieve.
   # @option opts [Integer] :offset The offset from where to begin.
   # @return [VulnerabilitiesApiVulnCountByCVSSScore]
@@ -169,9 +169,9 @@ describe 'ContainerVulnerabilitiesApi' do
   end
 
   # unit tests for read_vulnerability_count_by_severity
-  # Aggregate count of vulnerabilities grouped by severity
+  # Maximum offset = 10000 - limit
   # @param [Hash] opts the optional parameters
-  # @option opts [String] :filter Filter vulnerabilities using a query in Falcon Query Language (FQL). Supported filters: base_os,cid,container_id,container_running_status,containers_impacted_range,cps_rating,cve_id,cvss_score,description,exploited_status,exploited_status_name,fix_status,image_digest,image_id,images_impacted_range,include_base_image_vuln,package_name_version,registry,repository,severity,tag
+  # @option opts [String] :filter Filter vulnerabilities using a query in Falcon Query Language (FQL). Supported filter fields: - `ai_related` - `base_os` - `cid` - `container_id` - `container_running_status` - `containers_impacted_range` - `cps_rating` - `cve_id` - `cvss_score` - `description` - `exploited_status_name` - `exploited_status` - `fix_status` - `image_digest` - `image_id` - `images_impacted_range` - `include_base_image_vuln` - `package_name_version` - `registry` - `repository` - `severity` - `tag`
   # @option opts [Integer] :limit The upper-bound on the number of records to retrieve.
   # @option opts [Integer] :offset The offset from where to begin.
   # @return [VulnerabilitiesApiVulnCountBySeverity]