docs/VulnerabilitiesApi.md in cloudsmith-api-1.142.3 vs docs/VulnerabilitiesApi.md in cloudsmith-api-2.0.0
- old
+ new
@@ -2,18 +2,18 @@
All URIs are relative to *https://api.cloudsmith.io/v1*
Method | HTTP request | Description
------------- | ------------- | -------------
-[**vulnerabilities_list**](VulnerabilitiesApi.md#vulnerabilities_list) | **GET** /vulnerabilities/{owner}/ | Lists scan results for a specific namespace.
-[**vulnerabilities_list0**](VulnerabilitiesApi.md#vulnerabilities_list0) | **GET** /vulnerabilities/{owner}/{repo}/ | Lists scan results for a specific repository.
-[**vulnerabilities_list1**](VulnerabilitiesApi.md#vulnerabilities_list1) | **GET** /vulnerabilities/{owner}/{repo}/{package}/ | Lists scan results for a specific package.
+[**vulnerabilities_namespace_list**](VulnerabilitiesApi.md#vulnerabilities_namespace_list) | **GET** /vulnerabilities/{owner}/ | Lists scan results for a specific namespace.
+[**vulnerabilities_package_list**](VulnerabilitiesApi.md#vulnerabilities_package_list) | **GET** /vulnerabilities/{owner}/{repo}/{package}/ | Lists scan results for a specific package.
[**vulnerabilities_read**](VulnerabilitiesApi.md#vulnerabilities_read) | **GET** /vulnerabilities/{owner}/{repo}/{package}/{scan_id}/ | Returns a Scan Result.
+[**vulnerabilities_repo_list**](VulnerabilitiesApi.md#vulnerabilities_repo_list) | **GET** /vulnerabilities/{owner}/{repo}/ | Lists scan results for a specific repository.
-# **vulnerabilities_list**
-> Array<VulnerabilityScanResultsList> vulnerabilities_list(owner, opts)
+# **vulnerabilities_namespace_list**
+> Array<VulnerabilityScanResultsList> vulnerabilities_namespace_list(owner, opts)
Lists scan results for a specific namespace.
Lists scan results for a specific namespace.
@@ -38,14 +38,14 @@
page_size: 56 # Integer | Number of results to return per page.
}
begin
#Lists scan results for a specific namespace.
- result = api_instance.vulnerabilities_list(owner, opts)
+ result = api_instance.vulnerabilities_namespace_list(owner, opts)
p result
rescue CloudsmithApi::ApiError => e
- puts "Exception when calling VulnerabilitiesApi->vulnerabilities_list: #{e}"
+ puts "Exception when calling VulnerabilitiesApi->vulnerabilities_namespace_list: #{e}"
end
```
### Parameters
@@ -63,21 +63,21 @@
[apikey](../README.md#apikey)
### HTTP request headers
- - **Content-Type**: Not defined
- - **Accept**: Not defined
+ - **Content-Type**: application/json
+ - **Accept**: application/json
-# **vulnerabilities_list0**
-> Array<VulnerabilityScanResultsList> vulnerabilities_list0(owner, repo, opts)
+# **vulnerabilities_package_list**
+> Array<VulnerabilityScanResultsList> vulnerabilities_package_list(owner, repo, package, opts)
-Lists scan results for a specific repository.
+Lists scan results for a specific package.
-Lists scan results for a specific repository.
+Lists scan results for a specific package.
### Example
```ruby
# load the gem
require 'cloudsmith-api'
@@ -93,30 +93,33 @@
owner = 'owner_example' # String |
repo = 'repo_example' # String |
+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
- #Lists scan results for a specific repository.
- result = api_instance.vulnerabilities_list0(owner, repo, opts)
+ #Lists scan results for a specific package.
+ result = api_instance.vulnerabilities_package_list(owner, repo, package, opts)
p result
rescue CloudsmithApi::ApiError => e
- puts "Exception when calling VulnerabilitiesApi->vulnerabilities_list0: #{e}"
+ puts "Exception when calling VulnerabilitiesApi->vulnerabilities_package_list: #{e}"
end
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**owner** | **String**| |
**repo** | **String**| |
+ **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
@@ -126,21 +129,21 @@
[apikey](../README.md#apikey)
### HTTP request headers
- - **Content-Type**: Not defined
- - **Accept**: Not defined
+ - **Content-Type**: application/json
+ - **Accept**: application/json
-# **vulnerabilities_list1**
-> Array<VulnerabilityScanResultsList> vulnerabilities_list1(owner, repo, package, opts)
+# **vulnerabilities_read**
+> VulnerabilityScanResults vulnerabilities_read(owner, repo, package, scan_id)
-Lists scan results for a specific package.
+Returns a Scan Result.
-Lists scan results for a specific package.
+Returns a Scan Result.
### Example
```ruby
# load the gem
require 'cloudsmith-api'
@@ -158,55 +161,52 @@
repo = 'repo_example' # String |
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.
-}
+scan_id = 'scan_id_example' # String |
+
begin
- #Lists scan results for a specific package.
- result = api_instance.vulnerabilities_list1(owner, repo, package, opts)
+ #Returns a Scan Result.
+ result = api_instance.vulnerabilities_read(owner, repo, package, scan_id)
p result
rescue CloudsmithApi::ApiError => e
- puts "Exception when calling VulnerabilitiesApi->vulnerabilities_list1: #{e}"
+ puts "Exception when calling VulnerabilitiesApi->vulnerabilities_read: #{e}"
end
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**owner** | **String**| |
**repo** | **String**| |
**package** | **String**| |
- **page** | **Integer**| A page number within the paginated result set. | [optional]
- **page_size** | **Integer**| Number of results to return per page. | [optional]
+ **scan_id** | **String**| |
### Return type
-[**Array<VulnerabilityScanResultsList>**](VulnerabilityScanResultsList.md)
+[**VulnerabilityScanResults**](VulnerabilityScanResults.md)
### Authorization
[apikey](../README.md#apikey)
### HTTP request headers
- - **Content-Type**: Not defined
- - **Accept**: Not defined
+ - **Content-Type**: application/json
+ - **Accept**: application/json
-# **vulnerabilities_read**
-> VulnerabilityScanResults vulnerabilities_read(owner, repo, package, scan_id)
+# **vulnerabilities_repo_list**
+> Array<VulnerabilityScanResultsList> vulnerabilities_repo_list(owner, repo, opts)
-Returns a Scan Result.
+Lists scan results for a specific repository.
-Returns a Scan Result.
+Lists scan results for a specific repository.
### Example
```ruby
# load the gem
require 'cloudsmith-api'
@@ -222,43 +222,43 @@
owner = 'owner_example' # String |
repo = 'repo_example' # String |
-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.
+}
-scan_id = 'scan_id_example' # String |
-
-
begin
- #Returns a Scan Result.
- result = api_instance.vulnerabilities_read(owner, repo, package, scan_id)
+ #Lists scan results for a specific repository.
+ result = api_instance.vulnerabilities_repo_list(owner, repo, opts)
p result
rescue CloudsmithApi::ApiError => e
- puts "Exception when calling VulnerabilitiesApi->vulnerabilities_read: #{e}"
+ puts "Exception when calling VulnerabilitiesApi->vulnerabilities_repo_list: #{e}"
end
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**owner** | **String**| |
**repo** | **String**| |
- **package** | **String**| |
- **scan_id** | **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
-[**VulnerabilityScanResults**](VulnerabilityScanResults.md)
+[**Array<VulnerabilityScanResultsList>**](VulnerabilityScanResultsList.md)
### Authorization
[apikey](../README.md#apikey)
### HTTP request headers
- - **Content-Type**: Not defined
- - **Accept**: Not defined
+ - **Content-Type**: application/json
+ - **Accept**: application/json