docs/VulnerabilitiesApi.md in cloudsmith-api-0.57.1 vs docs/VulnerabilitiesApi.md in cloudsmith-api-1.30.0

- old
+ new

@@ -2,22 +2,22 @@ All URIs are relative to *https://api.cloudsmith.io/v1* Method | HTTP request | Description ------------- | ------------- | ------------- -[**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}/ | Check package identifier is valid before querying results. -[**vulnerabilities_read**](VulnerabilitiesApi.md#vulnerabilities_read) | **GET** /vulnerabilities/{owner}/{repo}/{package}/{scan_id}/ | Checks feature is within plan before retrieving results. +[**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_read**](VulnerabilitiesApi.md#vulnerabilities_read) | **GET** /vulnerabilities/{owner}/{repo}/{package}/{scan_id}/ | Returns a Scan Result. # **vulnerabilities_list** > Array<VulnerabilityScanResultsList> vulnerabilities_list(owner, opts) -Checks feature is within plan before listing results. +Lists scan results for a specific namespace. -Checks feature is within plan before listing results. +Lists scan results for a specific namespace. ### 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 - #Checks feature is within plan before listing results. + #Lists scan results for a specific namespace. 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<VulnerabilityScanResultsList> vulnerabilities_list0(owner, repo, opts) -Checks feature is within plan before listing results. +Lists scan results for a specific repository. -Checks feature is within plan before listing results. +Lists scan results for a specific repository. ### 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 - #Checks feature is within plan before listing results. + #Lists scan results for a specific repository. 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<VulnerabilityScanResultsList> vulnerabilities_list1(owner, repo, package, opts) -Check package identifier is valid before querying results. +Lists scan results for a specific package. -Check package identifier is valid before querying results. +Lists scan results for a specific package. ### Example ```ruby # load the gem require 'cloudsmith-api' @@ -164,11 +164,11 @@ page: 56, # Integer | A page number within the paginated result set. page_size: 56 # Integer | Number of results to return per page. } begin - #Check package identifier is valid before querying results. + #Lists scan results for a specific package. result = api_instance.vulnerabilities_list1(owner, repo, package, opts) p result rescue CloudsmithApi::ApiError => e puts "Exception when calling VulnerabilitiesApi->vulnerabilities_list1: #{e}" end @@ -200,13 +200,13 @@ # **vulnerabilities_read** > VulnerabilityScanResults vulnerabilities_read(owner, repo, package, scan_id) -Checks feature is within plan before retrieving results. +Returns a Scan Result. -Checks feature is within plan before retrieving results. +Returns a Scan Result. ### Example ```ruby # load the gem require 'cloudsmith-api' @@ -228,10 +228,10 @@ scan_id = "scan_id_example" # String | begin - #Checks feature is within plan before retrieving results. + #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_read: #{e}" end