Skip to content

Latest commit

 

History

History
203 lines (126 loc) · 6.46 KB

FilesApi.md

File metadata and controls

203 lines (126 loc) · 6.46 KB
Raw

\FilesApi

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

Method HTTP request Description
FilesAbort Post /files/{owner}/{repo}/{identifier}/abort/ Abort a multipart file upload.
FilesComplete Post /files/{owner}/{repo}/{identifier}/complete/ Complete a multipart file upload.
FilesCreate Post /files/{owner}/{repo}/ Request URL(s) to upload new package file upload(s) to.
FilesInfo Get /files/{owner}/{repo}/{identifier}/info/ Get upload information for a multipart file upload.
FilesValidate Post /files/{owner}/{repo}/validate/ Validate parameters used for create.

FilesAbort

FilesAbort(ctx, owner, repo, identifier, optional) Abort a multipart file upload.

Abort a multipart file upload.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
owner string
repo string
identifier string
optional *FilesApiFilesAbortOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a FilesApiFilesAbortOpts struct

Name Type Description Notes

data | optional.Interface of FilesAbort| |

Return type

(empty response body)

Authorization

apikey

HTTP request headers

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

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

FilesComplete

PackageFileUpload FilesComplete(ctx, owner, repo, identifier, optional) Complete a multipart file upload.

Complete a multipart file upload.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
owner string
repo string
identifier string
optional *FilesApiFilesCompleteOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a FilesApiFilesCompleteOpts struct

Name Type Description Notes

data | optional.Interface of FilesComplete| |

Return type

PackageFileUpload

Authorization

apikey

HTTP request headers

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

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

FilesCreate

PackageFileUpload FilesCreate(ctx, owner, repo, optional) Request URL(s) to upload new package file upload(s) to.

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

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
owner string
repo string
optional *FilesApiFilesCreateOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a FilesApiFilesCreateOpts struct

Name Type Description Notes

data | optional.Interface of FilesCreate| |

Return type

PackageFileUpload

Authorization

apikey

HTTP request headers

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

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

FilesInfo

PackageFilePartsUpload FilesInfo(ctx, owner, repo, identifier) Get upload information for a multipart file upload.

Get upload information for a multipart file upload.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
owner string
repo string
identifier string

Return type

PackageFilePartsUpload

Authorization

apikey

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

FilesValidate

FilesValidate(ctx, owner, repo, optional) Validate parameters used for create.

Validate parameters used for create.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
owner string
repo string
optional *FilesApiFilesValidateOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a FilesApiFilesValidateOpts struct

Name Type Description Notes

data | optional.Interface of FilesValidate| |

Return type

(empty response body)

Authorization

apikey

HTTP request headers

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

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