docs/PackagesApi.md in cloudsmith-api-0.53.79 vs docs/PackagesApi.md in cloudsmith-api-0.54.15

- old
+ new

@@ -8,10 +8,11 @@ [**packages_delete**](PackagesApi.md#packages_delete) | **DELETE** /packages/{owner}/{repo}/{identifier}/ | Delete a specific package in a repository. [**packages_list**](PackagesApi.md#packages_list) | **GET** /packages/{owner}/{repo}/ | Get a list of all packages associated with repository. [**packages_move**](PackagesApi.md#packages_move) | **POST** /packages/{owner}/{repo}/{identifier}/move/ | Move a package to another repository. [**packages_read**](PackagesApi.md#packages_read) | **GET** /packages/{owner}/{repo}/{identifier}/ | Get a specific package in a repository. [**packages_resync**](PackagesApi.md#packages_resync) | **POST** /packages/{owner}/{repo}/{identifier}/resync/ | Schedule a package for resynchronisation. +[**packages_scan**](PackagesApi.md#packages_scan) | **POST** /packages/{owner}/{repo}/{identifier}/scan/ | Schedule a package for scanning. [**packages_status**](PackagesApi.md#packages_status) | **GET** /packages/{owner}/{repo}/{identifier}/status/ | Get the synchronisation status for a package. [**packages_tag**](PackagesApi.md#packages_tag) | **POST** /packages/{owner}/{repo}/{identifier}/tag/ | Add/Replace/Remove tags for a package. [**packages_upload_alpine**](PackagesApi.md#packages_upload_alpine) | **POST** /packages/{owner}/{repo}/upload/alpine/ | Create a new Alpine package [**packages_upload_cargo**](PackagesApi.md#packages_upload_cargo) | **POST** /packages/{owner}/{repo}/upload/cargo/ | Create a new Cargo package [**packages_upload_cocoapods**](PackagesApi.md#packages_upload_cocoapods) | **POST** /packages/{owner}/{repo}/upload/cocoapods/ | Create a new CocoaPods package @@ -367,11 +368,11 @@ - **Accept**: Not defined # **packages_resync** -> Package packages_resync(owner, repo, identifier) +> Package packages_resync(owner, repo, identifier, opts) Schedule a package for resynchronisation. Schedule a package for resynchronisation. @@ -393,14 +394,17 @@ repo = "repo_example" # String | identifier = "identifier_example" # String | +opts = { + data: CloudsmithApi::PackagesResync.new # PackagesResync | +} begin #Schedule a package for resynchronisation. - result = api_instance.packages_resync(owner, repo, identifier) + result = api_instance.packages_resync(owner, repo, identifier, opts) p result rescue CloudsmithApi::ApiError => e puts "Exception when calling PackagesApi->packages_resync: #{e}" end ``` @@ -410,10 +414,11 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| | **repo** | **String**| | **identifier** | **String**| | + **data** | [**PackagesResync**](PackagesResync.md)| | [optional] ### Return type [**Package**](Package.md) @@ -421,10 +426,74 @@ [apikey](../README.md#apikey) ### HTTP request headers - - **Content-Type**: Not defined + - **Content-Type**: application/json + - **Accept**: Not defined + + + +# **packages_scan** +> Package packages_scan(owner, repo, identifier, opts) + +Schedule a package for scanning. + +Schedule a package for scanning. + +### Example +```ruby +# load the gem +require 'cloudsmith-api' +# setup authorization +CloudsmithApi.configure do |config| + # Configure API key authorization: apikey + config.api_key['X-Api-Key'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['X-Api-Key'] = 'Bearer' +end + +api_instance = CloudsmithApi::PackagesApi.new + +owner = "owner_example" # String | + +repo = "repo_example" # String | + +identifier = "identifier_example" # String | + +opts = { + data: CloudsmithApi::PackagesScan.new # PackagesScan | +} + +begin + #Schedule a package for scanning. + result = api_instance.packages_scan(owner, repo, identifier, opts) + p result +rescue CloudsmithApi::ApiError => e + puts "Exception when calling PackagesApi->packages_scan: #{e}" +end +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **owner** | **String**| | + **repo** | **String**| | + **identifier** | **String**| | + **data** | [**PackagesScan**](PackagesScan.md)| | [optional] + +### Return type + +[**Package**](Package.md) + +### Authorization + +[apikey](../README.md#apikey) + +### HTTP request headers + + - **Content-Type**: application/json - **Accept**: Not defined # **packages_status**