Skip to content

FilesApi.md

Latest commit

 

History

History
329 lines (245 loc) · 10.8 KB

FilesApi.md

File metadata and controls

329 lines (245 loc) · 10.8 KB

cloudsmith_api.FilesApi

All URIs are relative to https://api.cloudsmith.io

Method HTTP request Description
files_abort POST /files/{owner}/{repo}/{identifier}/abort/ Abort a multipart file upload.
files_complete POST /files/{owner}/{repo}/{identifier}/complete/ Complete a multipart file upload.
files_create POST /files/{owner}/{repo}/ Request URL(s) to upload new package file upload(s) to.
files_info GET /files/{owner}/{repo}/{identifier}/info/ Get upload information to perform a multipart file upload.
files_validate POST /files/{owner}/{repo}/validate/ Validate parameters used for create.

files_abort

files_abort(owner, repo, identifier, data=data)

Abort a multipart file upload.

Abort a multipart file upload.

Example

from __future__ import print_function
import time
import cloudsmith_api
from cloudsmith_api.rest import ApiException
from pprint import pprint

# Configure API key authorization: apikey
configuration = cloudsmith_api.Configuration()
configuration.api_key['X-Api-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Api-Key'] = 'Bearer'
# Configure HTTP basic authorization: basic
configuration = cloudsmith_api.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cloudsmith_api.FilesApi(cloudsmith_api.ApiClient(configuration))
owner = 'owner_example' # str | 
repo = 'repo_example' # str | 
identifier = 'identifier_example' # str | 
data = cloudsmith_api.PackageFileUploadRequest() # PackageFileUploadRequest |  (optional)

try:
    # Abort a multipart file upload.
    api_instance.files_abort(owner, repo, identifier, data=data)
except ApiException as e:
    print("Exception when calling FilesApi->files_abort: %s\n" % e)

Parameters

Name Type Description Notes
owner str
repo str
identifier str
data PackageFileUploadRequest [optional]

Return type

void (empty response body)

Authorization

apikey, basic

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

files_complete

PackageFileUpload files_complete(owner, repo, identifier, data=data)

Complete a multipart file upload.

Complete a multipart file upload.

Example

from __future__ import print_function
import time
import cloudsmith_api
from cloudsmith_api.rest import ApiException
from pprint import pprint

# Configure API key authorization: apikey
configuration = cloudsmith_api.Configuration()
configuration.api_key['X-Api-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Api-Key'] = 'Bearer'
# Configure HTTP basic authorization: basic
configuration = cloudsmith_api.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cloudsmith_api.FilesApi(cloudsmith_api.ApiClient(configuration))
owner = 'owner_example' # str | 
repo = 'repo_example' # str | 
identifier = 'identifier_example' # str | 
data = cloudsmith_api.PackageFileUploadRequest() # PackageFileUploadRequest |  (optional)

try:
    # Complete a multipart file upload.
    api_response = api_instance.files_complete(owner, repo, identifier, data=data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilesApi->files_complete: %s\n" % e)

Parameters

Name Type Description Notes
owner str
repo str
identifier str
data PackageFileUploadRequest [optional]

Return type

PackageFileUpload

Authorization

apikey, basic

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

files_create

PackageFileUpload files_create(owner, repo, data=data)

Request URL(s) to upload new package file upload(s) to.

Request URL(s) to upload new package file upload(s) to.

Example

from __future__ import print_function
import time
import cloudsmith_api
from cloudsmith_api.rest import ApiException
from pprint import pprint

# Configure API key authorization: apikey
configuration = cloudsmith_api.Configuration()
configuration.api_key['X-Api-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Api-Key'] = 'Bearer'
# Configure HTTP basic authorization: basic
configuration = cloudsmith_api.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cloudsmith_api.FilesApi(cloudsmith_api.ApiClient(configuration))
owner = 'owner_example' # str | 
repo = 'repo_example' # str | 
data = cloudsmith_api.PackageFileUploadRequest() # PackageFileUploadRequest |  (optional)

try:
    # Request URL(s) to upload new package file upload(s) to.
    api_response = api_instance.files_create(owner, repo, data=data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilesApi->files_create: %s\n" % e)

Parameters

Name Type Description Notes
owner str
repo str
data PackageFileUploadRequest [optional]

Return type

PackageFileUpload

Authorization

apikey, basic

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

files_info

PackageFilePartsUpload files_info(owner, repo, identifier, filename, part_number=part_number)

Get upload information to perform a multipart file upload.

Get upload information to perform a multipart file upload.

Example

from __future__ import print_function
import time
import cloudsmith_api
from cloudsmith_api.rest import ApiException
from pprint import pprint

# Configure API key authorization: apikey
configuration = cloudsmith_api.Configuration()
configuration.api_key['X-Api-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Api-Key'] = 'Bearer'
# Configure HTTP basic authorization: basic
configuration = cloudsmith_api.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cloudsmith_api.FilesApi(cloudsmith_api.ApiClient(configuration))
owner = 'owner_example' # str | 
repo = 'repo_example' # str | 
identifier = 'identifier_example' # str | 
filename = 'filename_example' # str | The filename of the file being uploaded
part_number = 56 # int | The part number to be uploaded next (optional)

try:
    # Get upload information to perform a multipart file upload.
    api_response = api_instance.files_info(owner, repo, identifier, filename, part_number=part_number)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilesApi->files_info: %s\n" % e)

Parameters

Name Type Description Notes
owner str
repo str
identifier str
filename str The filename of the file being uploaded
part_number int The part number to be uploaded next [optional]

Return type

PackageFilePartsUpload

Authorization

apikey, basic

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

files_validate

files_validate(owner, repo, data=data)

Validate parameters used for create.

Validate parameters used for create.

Example

from __future__ import print_function
import time
import cloudsmith_api
from cloudsmith_api.rest import ApiException
from pprint import pprint

# Configure API key authorization: apikey
configuration = cloudsmith_api.Configuration()
configuration.api_key['X-Api-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Api-Key'] = 'Bearer'
# Configure HTTP basic authorization: basic
configuration = cloudsmith_api.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cloudsmith_api.FilesApi(cloudsmith_api.ApiClient(configuration))
owner = 'owner_example' # str | 
repo = 'repo_example' # str | 
data = cloudsmith_api.PackageFileUploadRequest() # PackageFileUploadRequest |  (optional)

try:
    # Validate parameters used for create.
    api_instance.files_validate(owner, repo, data=data)
except ApiException as e:
    print("Exception when calling FilesApi->files_validate: %s\n" % e)

Parameters

Name Type Description Notes
owner str
repo str
data PackageFileUploadRequest [optional]

Return type

void (empty response body)

Authorization

apikey, basic

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]