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

- old
+ new

@@ -4,10 +4,11 @@ Method | HTTP request | Description ------------- | ------------- | ------------- [**packages_copy**](PackagesApi.md#packages_copy) | **POST** /packages/{owner}/{repo}/{identifier}/copy/ | Copy a package to another repository. [**packages_delete**](PackagesApi.md#packages_delete) | **DELETE** /packages/{owner}/{repo}/{identifier}/ | Delete a specific package in a repository. +[**packages_dependencies**](PackagesApi.md#packages_dependencies) | **GET** /packages/{owner}/{repo}/{identifier}/dependencies/ | Get the direct (non-transitive) dependencies list for a package. [**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. @@ -16,20 +17,22 @@ [**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 [**packages_upload_composer**](PackagesApi.md#packages_upload_composer) | **POST** /packages/{owner}/{repo}/upload/composer/ | Create a new Composer package [**packages_upload_conan**](PackagesApi.md#packages_upload_conan) | **POST** /packages/{owner}/{repo}/upload/conan/ | Create a new Conan package +[**packages_upload_conda**](PackagesApi.md#packages_upload_conda) | **POST** /packages/{owner}/{repo}/upload/conda/ | Create a new Conda package [**packages_upload_cran**](PackagesApi.md#packages_upload_cran) | **POST** /packages/{owner}/{repo}/upload/cran/ | Create a new CRAN package [**packages_upload_dart**](PackagesApi.md#packages_upload_dart) | **POST** /packages/{owner}/{repo}/upload/dart/ | Create a new Dart package [**packages_upload_deb**](PackagesApi.md#packages_upload_deb) | **POST** /packages/{owner}/{repo}/upload/deb/ | Create a new Debian package [**packages_upload_docker**](PackagesApi.md#packages_upload_docker) | **POST** /packages/{owner}/{repo}/upload/docker/ | Create a new Docker package [**packages_upload_go**](PackagesApi.md#packages_upload_go) | **POST** /packages/{owner}/{repo}/upload/go/ | Create a new Go package [**packages_upload_helm**](PackagesApi.md#packages_upload_helm) | **POST** /packages/{owner}/{repo}/upload/helm/ | Create a new Helm package [**packages_upload_luarocks**](PackagesApi.md#packages_upload_luarocks) | **POST** /packages/{owner}/{repo}/upload/luarocks/ | Create a new LuaRocks package [**packages_upload_maven**](PackagesApi.md#packages_upload_maven) | **POST** /packages/{owner}/{repo}/upload/maven/ | Create a new Maven package [**packages_upload_npm**](PackagesApi.md#packages_upload_npm) | **POST** /packages/{owner}/{repo}/upload/npm/ | Create a new npm package [**packages_upload_nuget**](PackagesApi.md#packages_upload_nuget) | **POST** /packages/{owner}/{repo}/upload/nuget/ | Create a new NuGet package +[**packages_upload_p2**](PackagesApi.md#packages_upload_p2) | **POST** /packages/{owner}/{repo}/upload/p2/ | Create a new P2 package [**packages_upload_python**](PackagesApi.md#packages_upload_python) | **POST** /packages/{owner}/{repo}/upload/python/ | Create a new Python package [**packages_upload_raw**](PackagesApi.md#packages_upload_raw) | **POST** /packages/{owner}/{repo}/upload/raw/ | Create a new Raw package [**packages_upload_rpm**](PackagesApi.md#packages_upload_rpm) | **POST** /packages/{owner}/{repo}/upload/rpm/ | Create a new RedHat package [**packages_upload_ruby**](PackagesApi.md#packages_upload_ruby) | **POST** /packages/{owner}/{repo}/upload/ruby/ | Create a new Ruby package [**packages_upload_terraform**](PackagesApi.md#packages_upload_terraform) | **POST** /packages/{owner}/{repo}/upload/terraform/ | Create a new Terraform package @@ -37,20 +40,22 @@ [**packages_validate_upload_alpine**](PackagesApi.md#packages_validate_upload_alpine) | **POST** /packages/{owner}/{repo}/validate-upload/alpine/ | Validate parameters for create Alpine package [**packages_validate_upload_cargo**](PackagesApi.md#packages_validate_upload_cargo) | **POST** /packages/{owner}/{repo}/validate-upload/cargo/ | Validate parameters for create Cargo package [**packages_validate_upload_cocoapods**](PackagesApi.md#packages_validate_upload_cocoapods) | **POST** /packages/{owner}/{repo}/validate-upload/cocoapods/ | Validate parameters for create CocoaPods package [**packages_validate_upload_composer**](PackagesApi.md#packages_validate_upload_composer) | **POST** /packages/{owner}/{repo}/validate-upload/composer/ | Validate parameters for create Composer package [**packages_validate_upload_conan**](PackagesApi.md#packages_validate_upload_conan) | **POST** /packages/{owner}/{repo}/validate-upload/conan/ | Validate parameters for create Conan package +[**packages_validate_upload_conda**](PackagesApi.md#packages_validate_upload_conda) | **POST** /packages/{owner}/{repo}/validate-upload/conda/ | Validate parameters for create Conda package [**packages_validate_upload_cran**](PackagesApi.md#packages_validate_upload_cran) | **POST** /packages/{owner}/{repo}/validate-upload/cran/ | Validate parameters for create CRAN package [**packages_validate_upload_dart**](PackagesApi.md#packages_validate_upload_dart) | **POST** /packages/{owner}/{repo}/validate-upload/dart/ | Validate parameters for create Dart package [**packages_validate_upload_deb**](PackagesApi.md#packages_validate_upload_deb) | **POST** /packages/{owner}/{repo}/validate-upload/deb/ | Validate parameters for create Debian package [**packages_validate_upload_docker**](PackagesApi.md#packages_validate_upload_docker) | **POST** /packages/{owner}/{repo}/validate-upload/docker/ | Validate parameters for create Docker package [**packages_validate_upload_go**](PackagesApi.md#packages_validate_upload_go) | **POST** /packages/{owner}/{repo}/validate-upload/go/ | Validate parameters for create Go package [**packages_validate_upload_helm**](PackagesApi.md#packages_validate_upload_helm) | **POST** /packages/{owner}/{repo}/validate-upload/helm/ | Validate parameters for create Helm package [**packages_validate_upload_luarocks**](PackagesApi.md#packages_validate_upload_luarocks) | **POST** /packages/{owner}/{repo}/validate-upload/luarocks/ | Validate parameters for create LuaRocks package [**packages_validate_upload_maven**](PackagesApi.md#packages_validate_upload_maven) | **POST** /packages/{owner}/{repo}/validate-upload/maven/ | Validate parameters for create Maven package [**packages_validate_upload_npm**](PackagesApi.md#packages_validate_upload_npm) | **POST** /packages/{owner}/{repo}/validate-upload/npm/ | Validate parameters for create npm package [**packages_validate_upload_nuget**](PackagesApi.md#packages_validate_upload_nuget) | **POST** /packages/{owner}/{repo}/validate-upload/nuget/ | Validate parameters for create NuGet package +[**packages_validate_upload_p2**](PackagesApi.md#packages_validate_upload_p2) | **POST** /packages/{owner}/{repo}/validate-upload/p2/ | Validate parameters for create P2 package [**packages_validate_upload_python**](PackagesApi.md#packages_validate_upload_python) | **POST** /packages/{owner}/{repo}/validate-upload/python/ | Validate parameters for create Python package [**packages_validate_upload_raw**](PackagesApi.md#packages_validate_upload_raw) | **POST** /packages/{owner}/{repo}/validate-upload/raw/ | Validate parameters for create Raw package [**packages_validate_upload_rpm**](PackagesApi.md#packages_validate_upload_rpm) | **POST** /packages/{owner}/{repo}/validate-upload/rpm/ | Validate parameters for create RedHat package [**packages_validate_upload_ruby**](PackagesApi.md#packages_validate_upload_ruby) | **POST** /packages/{owner}/{repo}/validate-upload/ruby/ | Validate parameters for create Ruby package [**packages_validate_upload_terraform**](PackagesApi.md#packages_validate_upload_terraform) | **POST** /packages/{owner}/{repo}/validate-upload/terraform/ | Validate parameters for create Terraform package @@ -178,10 +183,70 @@ - **Content-Type**: Not defined - **Accept**: Not defined +# **packages_dependencies** +> PackageDependencies packages_dependencies(owner, repo, identifier) + +Get the direct (non-transitive) dependencies list for a package. + +Get the direct (non-transitive) dependencies list for a package. + +### 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 | + + +begin + #Get the direct (non-transitive) dependencies list for a package. + result = api_instance.packages_dependencies(owner, repo, identifier) + p result +rescue CloudsmithApi::ApiError => e + puts "Exception when calling PackagesApi->packages_dependencies: #{e}" +end +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **owner** | **String**| | + **repo** | **String**| | + **identifier** | **String**| | + +### Return type + +[**PackageDependencies**](PackageDependencies.md) + +### Authorization + +[apikey](../README.md#apikey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + + # **packages_list** > Array<Package> packages_list(owner, repo, opts) Get a list of all packages associated with repository. @@ -206,11 +271,12 @@ repo = "repo_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. - query: "query_example" # String | A search term for querying names, filenames, versions, distributions, architectures, formats or statuses of packages. + query: "query_example", # String | A search term for querying names, filenames, versions, distributions, architectures, formats or statuses of packages. + sort: "sort_example" # String | A field for sorting objects in ascending or descending order. } begin #Get a list of all packages associated with repository. result = api_instance.packages_list(owner, repo, opts) @@ -227,10 +293,11 @@ **owner** | **String**| | **repo** | **String**| | **page** | **Integer**| A page number within the paginated result set. | [optional] **page_size** | **Integer**| Number of results to return per page. | [optional] **query** | **String**| A search term for querying names, filenames, versions, distributions, architectures, formats or statuses of packages. | [optional] + **sort** | **String**| A field for sorting objects in ascending or descending order. | [optional] ### Return type [**Array<Package>**](Package.md) @@ -916,10 +983,71 @@ - **Content-Type**: application/json - **Accept**: Not defined +# **packages_upload_conda** +> AlpinePackageUpload packages_upload_conda(owner, repo, opts) + +Create a new Conda package + +Create a new Conda package + +### 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 | + +opts = { + data: CloudsmithApi::PackagesUploadConda.new # PackagesUploadConda | +} + +begin + #Create a new Conda package + result = api_instance.packages_upload_conda(owner, repo, opts) + p result +rescue CloudsmithApi::ApiError => e + puts "Exception when calling PackagesApi->packages_upload_conda: #{e}" +end +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **owner** | **String**| | + **repo** | **String**| | + **data** | [**PackagesUploadConda**](PackagesUploadConda.md)| | [optional] + +### Return type + +[**AlpinePackageUpload**](AlpinePackageUpload.md) + +### Authorization + +[apikey](../README.md#apikey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + + # **packages_upload_cran** > AlpinePackageUpload packages_upload_cran(owner, repo, opts) Create a new CRAN package @@ -1526,10 +1654,71 @@ - **Content-Type**: application/json - **Accept**: Not defined +# **packages_upload_p2** +> AlpinePackageUpload packages_upload_p2(owner, repo, opts) + +Create a new P2 package + +Create a new P2 package + +### 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 | + +opts = { + data: CloudsmithApi::PackagesUploadP2.new # PackagesUploadP2 | +} + +begin + #Create a new P2 package + result = api_instance.packages_upload_p2(owner, repo, opts) + p result +rescue CloudsmithApi::ApiError => e + puts "Exception when calling PackagesApi->packages_upload_p2: #{e}" +end +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **owner** | **String**| | + **repo** | **String**| | + **data** | [**PackagesUploadP2**](PackagesUploadP2.md)| | [optional] + +### Return type + +[**AlpinePackageUpload**](AlpinePackageUpload.md) + +### Authorization + +[apikey](../README.md#apikey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + + # **packages_upload_python** > AlpinePackageUpload packages_upload_python(owner, repo, opts) Create a new Python package @@ -2192,10 +2381,70 @@ - **Content-Type**: application/json - **Accept**: Not defined +# **packages_validate_upload_conda** +> packages_validate_upload_conda(owner, repo, opts) + +Validate parameters for create Conda package + +Validate parameters for create Conda package + +### 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 | + +opts = { + data: CloudsmithApi::PackagesValidateuploadConda.new # PackagesValidateuploadConda | +} + +begin + #Validate parameters for create Conda package + api_instance.packages_validate_upload_conda(owner, repo, opts) +rescue CloudsmithApi::ApiError => e + puts "Exception when calling PackagesApi->packages_validate_upload_conda: #{e}" +end +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **owner** | **String**| | + **repo** | **String**| | + **data** | [**PackagesValidateuploadConda**](PackagesValidateuploadConda.md)| | [optional] + +### Return type + +nil (empty response body) + +### Authorization + +[apikey](../README.md#apikey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + + # **packages_validate_upload_cran** > packages_validate_upload_cran(owner, repo, opts) Validate parameters for create CRAN package @@ -2776,9 +3025,69 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| | **repo** | **String**| | **data** | [**PackagesValidateuploadNuget**](PackagesValidateuploadNuget.md)| | [optional] + +### Return type + +nil (empty response body) + +### Authorization + +[apikey](../README.md#apikey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + + +# **packages_validate_upload_p2** +> packages_validate_upload_p2(owner, repo, opts) + +Validate parameters for create P2 package + +Validate parameters for create P2 package + +### 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 | + +opts = { + data: CloudsmithApi::PackagesValidateuploadP2.new # PackagesValidateuploadP2 | +} + +begin + #Validate parameters for create P2 package + api_instance.packages_validate_upload_p2(owner, repo, opts) +rescue CloudsmithApi::ApiError => e + puts "Exception when calling PackagesApi->packages_validate_upload_p2: #{e}" +end +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **owner** | **String**| | + **repo** | **String**| | + **data** | [**PackagesValidateuploadP2**](PackagesValidateuploadP2.md)| | [optional] ### Return type nil (empty response body)