octopush/crates/gitea_raw_client/docs/PackageApi.md
Kasper Juul Hermansen 991861db99
All checks were successful
continuous-integration/drone/push Build is passing
continuous-integration/drone/pr Build is passing
Rewrite rust (#38)
Co-authored-by: kjuulh <contact@kjuulh.io>
Reviewed-on: #38
2022-11-27 11:21:35 +00:00

5.1 KiB

\PackageApi

All URIs are relative to /api/v1

Method HTTP request Description
delete_package DELETE /packages/{owner}/{type}/{name}/{version} Delete a package
get_package GET /packages/{owner}/{type}/{name}/{version} Gets a package
list_package_files GET /packages/{owner}/{type}/{name}/{version}/files Gets all files of a package
list_packages GET /packages/{owner} Gets all packages of an owner

delete_package

delete_package(owner, r#type, name, version) Delete a package

Parameters

Name Type Description Required Notes
owner String owner of the package [required]
r#type String type of the package [required]
name String name of the package [required]
version String version of the package [required]

Return type

(empty response body)

Authorization

AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, TOTPHeader, Token

HTTP request headers

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

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

get_package

crate::models::Package get_package(owner, r#type, name, version) Gets a package

Parameters

Name Type Description Required Notes
owner String owner of the package [required]
r#type String type of the package [required]
name String name of the package [required]
version String version of the package [required]

Return type

crate::models::Package

Authorization

AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, TOTPHeader, Token

HTTP request headers

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

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

list_package_files

Veccrate::models::PackageFile list_package_files(owner, r#type, name, version) Gets all files of a package

Parameters

Name Type Description Required Notes
owner String owner of the package [required]
r#type String type of the package [required]
name String name of the package [required]
version String version of the package [required]

Return type

Veccrate::models::PackageFile

Authorization

AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, TOTPHeader, Token

HTTP request headers

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

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

list_packages

Veccrate::models::Package list_packages(owner, page, limit, r#type, q) Gets all packages of an owner

Parameters

Name Type Description Required Notes
owner String owner of the packages [required]
page Option<i32> page number of results to return (1-based)
limit Option<i32> page size of results
r#type Option<String> package type filter
q Option<String> name filter

Return type

Veccrate::models::Package

Authorization

AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, TOTPHeader, Token

HTTP request headers

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

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