docs/FilesApi.md in cloudsmith-api-0.30.7 vs docs/FilesApi.md in cloudsmith-api-0.44.4
- old
+ new
@@ -1,21 +1,161 @@
# CloudsmithApi::FilesApi
-All URIs are relative to *https://api.cloudsmith.io/v1*
+All URIs are relative to *https://api.cloudsmith.io*
Method | HTTP request | Description
------------- | ------------- | -------------
-[**files_create**](FilesApi.md#files_create) | **POST** /files/{owner}/{repo}/ | Request URL(s) to POST new package file upload(s) to.
+[**files_abort**](FilesApi.md#files_abort) | **POST** /files/{owner}/{repo}/{identifier}/abort/ | Abort a multipart file upload.
+[**files_complete**](FilesApi.md#files_complete) | **POST** /files/{owner}/{repo}/{identifier}/complete/ | Complete a multipart file upload.
+[**files_create**](FilesApi.md#files_create) | **POST** /files/{owner}/{repo}/ | Request URL(s) to upload new package file upload(s) to.
+[**files_info**](FilesApi.md#files_info) | **GET** /files/{owner}/{repo}/{identifier}/info/ | Get upload information for a multipart file upload.
[**files_validate**](FilesApi.md#files_validate) | **POST** /files/{owner}/{repo}/validate/ | Validate parameters used for create.
+# **files_abort**
+> files_abort(owner, repo, identifier, opts)
+
+Abort a multipart file upload.
+
+Abort a multipart file upload.
+
+### 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'
+
+ # Configure API key authorization: csrf_token
+ config.api_key['X-CSRFToken'] = '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-CSRFToken'] = 'Bearer'
+end
+
+api_instance = CloudsmithApi::FilesApi.new
+
+owner = "owner_example" # String |
+
+repo = "repo_example" # String |
+
+identifier = "identifier_example" # String |
+
+opts = {
+ data: CloudsmithApi::FilesAbort.new # FilesAbort |
+}
+
+begin
+ #Abort a multipart file upload.
+ api_instance.files_abort(owner, repo, identifier, opts)
+rescue CloudsmithApi::ApiError => e
+ puts "Exception when calling FilesApi->files_abort: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **owner** | **String**| |
+ **repo** | **String**| |
+ **identifier** | **String**| |
+ **data** | [**FilesAbort**](FilesAbort.md)| | [optional]
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[apikey](../README.md#apikey), [csrf_token](../README.md#csrf_token)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: Not defined
+
+
+
+# **files_complete**
+> PackageFileUpload files_complete(owner, repo, identifier, opts)
+
+Complete a multipart file upload.
+
+Complete a multipart file upload.
+
+### 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'
+
+ # Configure API key authorization: csrf_token
+ config.api_key['X-CSRFToken'] = '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-CSRFToken'] = 'Bearer'
+end
+
+api_instance = CloudsmithApi::FilesApi.new
+
+owner = "owner_example" # String |
+
+repo = "repo_example" # String |
+
+identifier = "identifier_example" # String |
+
+opts = {
+ data: CloudsmithApi::FilesComplete.new # FilesComplete |
+}
+
+begin
+ #Complete a multipart file upload.
+ result = api_instance.files_complete(owner, repo, identifier, opts)
+ p result
+rescue CloudsmithApi::ApiError => e
+ puts "Exception when calling FilesApi->files_complete: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **owner** | **String**| |
+ **repo** | **String**| |
+ **identifier** | **String**| |
+ **data** | [**FilesComplete**](FilesComplete.md)| | [optional]
+
+### Return type
+
+[**PackageFileUpload**](PackageFileUpload.md)
+
+### Authorization
+
+[apikey](../README.md#apikey), [csrf_token](../README.md#csrf_token)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: Not defined
+
+
+
# **files_create**
> PackageFileUpload files_create(owner, repo, opts)
-Request URL(s) to POST new package file upload(s) to.
+Request URL(s) to upload new package file upload(s) to.
-Request URL(s) to POST new package file upload(s) to.
+Request URL(s) to upload new package file upload(s) to.
### Example
```ruby
# load the gem
require 'cloudsmith-api'
@@ -24,14 +164,10 @@
# 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'
- # Configure HTTP basic authorization: basic
- config.username = 'YOUR USERNAME'
- config.password = 'YOUR PASSWORD'
-
# Configure API key authorization: csrf_token
config.api_key['X-CSRFToken'] = '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-CSRFToken'] = 'Bearer'
end
@@ -45,11 +181,11 @@
opts = {
data: CloudsmithApi::FilesCreate.new # FilesCreate |
}
begin
- #Request URL(s) to POST new package file upload(s) to.
+ #Request URL(s) to upload new package file upload(s) to.
result = api_instance.files_create(owner, repo, opts)
p result
rescue CloudsmithApi::ApiError => e
puts "Exception when calling FilesApi->files_create: #{e}"
end
@@ -67,19 +203,84 @@
[**PackageFileUpload**](PackageFileUpload.md)
### Authorization
-[apikey](../README.md#apikey), [basic](../README.md#basic), [csrf_token](../README.md#csrf_token)
+[apikey](../README.md#apikey), [csrf_token](../README.md#csrf_token)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: Not defined
+# **files_info**
+> PackageFilePartsUpload files_info(owner, repo, identifier)
+
+Get upload information for a multipart file upload.
+
+Get upload information for a multipart file upload.
+
+### 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'
+
+ # Configure API key authorization: csrf_token
+ config.api_key['X-CSRFToken'] = '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-CSRFToken'] = 'Bearer'
+end
+
+api_instance = CloudsmithApi::FilesApi.new
+
+owner = "owner_example" # String |
+
+repo = "repo_example" # String |
+
+identifier = "identifier_example" # String |
+
+
+begin
+ #Get upload information for a multipart file upload.
+ result = api_instance.files_info(owner, repo, identifier)
+ p result
+rescue CloudsmithApi::ApiError => e
+ puts "Exception when calling FilesApi->files_info: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **owner** | **String**| |
+ **repo** | **String**| |
+ **identifier** | **String**| |
+
+### Return type
+
+[**PackageFilePartsUpload**](PackageFilePartsUpload.md)
+
+### Authorization
+
+[apikey](../README.md#apikey), [csrf_token](../README.md#csrf_token)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+
# **files_validate**
> files_validate(owner, repo, opts)
Validate parameters used for create.
@@ -94,14 +295,10 @@
# 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'
- # Configure HTTP basic authorization: basic
- config.username = 'YOUR USERNAME'
- config.password = 'YOUR PASSWORD'
-
# Configure API key authorization: csrf_token
config.api_key['X-CSRFToken'] = '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-CSRFToken'] = 'Bearer'
end
@@ -136,10 +333,10 @@
nil (empty response body)
### Authorization
-[apikey](../README.md#apikey), [basic](../README.md#basic), [csrf_token](../README.md#csrf_token)
+[apikey](../README.md#apikey), [csrf_token](../README.md#csrf_token)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: Not defined