VulnerabilitiesApi.md in cloudsmith-api-0.54.15

- old
+ new

@@ -2,22 +2,22 @@
 
 All URIs are relative to *https://api.cloudsmith.io*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**vulnerabilities_list**](VulnerabilitiesApi.md#vulnerabilities_list) | **GET** /vulnerabilities/{owner}/ | Read-only view to list vulnerabiltiy scan results within a Namespace.
-[**vulnerabilities_list0**](VulnerabilitiesApi.md#vulnerabilities_list0) | **GET** /vulnerabilities/{owner}/{repo}/ | Read-only views to list vulnerabiltiy scan results within a Repository.
-[**vulnerabilities_list1**](VulnerabilitiesApi.md#vulnerabilities_list1) | **GET** /vulnerabilities/{owner}/{repo}/{package}/ | Read-only views to list vulnerabiltiy scan results within a Repository
-[**vulnerabilities_read**](VulnerabilitiesApi.md#vulnerabilities_read) | **GET** /vulnerabilities/{owner}/{repo}/{package}/{scan_id}/ | Read-only view to retrieve vulnerability scans results using a
+[**vulnerabilities_list**](VulnerabilitiesApi.md#vulnerabilities_list) | **GET** /vulnerabilities/{owner}/ | Checks feature is within plan before listing results.
+[**vulnerabilities_list0**](VulnerabilitiesApi.md#vulnerabilities_list0) | **GET** /vulnerabilities/{owner}/{repo}/ | Checks feature is within plan before listing results.
+[**vulnerabilities_list1**](VulnerabilitiesApi.md#vulnerabilities_list1) | **GET** /vulnerabilities/{owner}/{repo}/{package}/ | Checks feature is within plan before listing results.
+[**vulnerabilities_read**](VulnerabilitiesApi.md#vulnerabilities_read) | **GET** /vulnerabilities/{owner}/{repo}/{package}/{scan_id}/ | Checks feature is within plan before retrieving results.
 
 
 # **vulnerabilities_list**
 > Array&lt;VulnerabilityScanResultsList&gt; vulnerabilities_list(owner, opts)
 
-Read-only view to list vulnerabiltiy scan results within a Namespace.
+Checks feature is within plan before listing results.
 
-Read-only view to list vulnerabiltiy scan results within a Namespace.
+Checks feature is within plan before listing results.
 
 ### Example
 ```ruby
 # load the gem
 require 'cloudsmith-api'
@@ -37,11 +37,11 @@
   page: 56, # Integer | A page number within the paginated result set.
   page_size: 56 # Integer | Number of results to return per page.
 }
 
 begin
-  #Read-only view to list vulnerabiltiy scan results within a Namespace.
+  #Checks feature is within plan before listing results.
   result = api_instance.vulnerabilities_list(owner, opts)
   p result
 rescue CloudsmithApi::ApiError => e
   puts "Exception when calling VulnerabilitiesApi->vulnerabilities_list: #{e}"
 end
@@ -71,13 +71,13 @@
 
 
 # **vulnerabilities_list0**
 > Array&lt;VulnerabilityScanResultsList&gt; vulnerabilities_list0(owner, repo, opts)
 
-Read-only views to list vulnerabiltiy scan results within a Repository.
+Checks feature is within plan before listing results.
 
-Read-only views to list vulnerabiltiy scan results within a Repository.
+Checks feature is within plan before listing results.
 
 ### Example
 ```ruby
 # load the gem
 require 'cloudsmith-api'
@@ -99,11 +99,11 @@
   page: 56, # Integer | A page number within the paginated result set.
   page_size: 56 # Integer | Number of results to return per page.
 }
 
 begin
-  #Read-only views to list vulnerabiltiy scan results within a Repository.
+  #Checks feature is within plan before listing results.
   result = api_instance.vulnerabilities_list0(owner, repo, opts)
   p result
 rescue CloudsmithApi::ApiError => e
   puts "Exception when calling VulnerabilitiesApi->vulnerabilities_list0: #{e}"
 end
@@ -134,13 +134,13 @@
 
 
 # **vulnerabilities_list1**
 > Array&lt;VulnerabilityScanResultsList&gt; vulnerabilities_list1(owner, repo, package, opts)
 
-Read-only views to list vulnerabiltiy scan results within a Repository
+Checks feature is within plan before listing results.
 
-Read-only views to list vulnerabiltiy scan results within a Repository for a given Package identifier.
+Checks feature is within plan before listing results.
 
 ### Example
 ```ruby
 # load the gem
 require 'cloudsmith-api'
@@ -156,19 +156,19 @@
 
 owner = "owner_example" # String | 
 
 repo = "repo_example" # String | 
 
-package = "package_example" # String | The package that the scan result relates to.
+package = "package_example" # String | 
 
 opts = { 
   page: 56, # Integer | A page number within the paginated result set.
   page_size: 56 # Integer | Number of results to return per page.
 }
 
 begin
-  #Read-only views to list vulnerabiltiy scan results within a Repository
+  #Checks feature is within plan before listing results.
   result = api_instance.vulnerabilities_list1(owner, repo, package, opts)
   p result
 rescue CloudsmithApi::ApiError => e
   puts "Exception when calling VulnerabilitiesApi->vulnerabilities_list1: #{e}"
 end
@@ -178,11 +178,11 @@
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **owner** | **String**|  | 
  **repo** | **String**|  | 
- **package** | **String**| The package that the scan result relates to. | 
+ **package** | **String**|  | 
  **page** | **Integer**| A page number within the paginated result set. | [optional] 
  **page_size** | **Integer**| Number of results to return per page. | [optional] 
 
 ### Return type
 
@@ -200,13 +200,13 @@
 
 
 # **vulnerabilities_read**
 > VulnerabilityScanResults vulnerabilities_read(owner, repo, package, scan_id)
 
-Read-only view to retrieve vulnerability scans results using a
+Checks feature is within plan before retrieving results.
 
-Read-only view to retrieve vulnerability scans results using a vulnerabiltiy scan results identifier (slug_perm).
+Checks feature is within plan before retrieving results.
 
 ### Example
 ```ruby
 # load the gem
 require 'cloudsmith-api'
@@ -222,17 +222,17 @@
 
 owner = "owner_example" # String | 
 
 repo = "repo_example" # String | 
 
-package = "package_example" # String | The package that the scan result relates to.
+package = "package_example" # String | 
 
-scan_id = "scan_id_example" # String | A sequential identifier that increments by one for each new scan result within a package. These are always unique and can be used to reference the scan results elsewhere (e.g. via the CLI.)
+scan_id = "scan_id_example" # String | 
 
 
 begin
-  #Read-only view to retrieve vulnerability scans results using a
+  #Checks feature is within plan before retrieving results.
   result = api_instance.vulnerabilities_read(owner, repo, package, scan_id)
   p result
 rescue CloudsmithApi::ApiError => e
   puts "Exception when calling VulnerabilitiesApi->vulnerabilities_read: #{e}"
 end
@@ -242,11 +242,11 @@
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **owner** | **String**|  | 
  **repo** | **String**|  | 
- **package** | **String**| The package that the scan result relates to. | 
- **scan_id** | **String**| A sequential identifier that increments by one for each new scan result within a package. These are always unique and can be used to reference the scan results elsewhere (e.g. via the CLI.) | 
+ **package** | **String**|  | 
+ **scan_id** | **String**|  | 
 
 ### Return type
 
 [**VulnerabilityScanResults**](VulnerabilityScanResults.md)
 