362 lines
14 KiB
Markdown
362 lines
14 KiB
Markdown
# gitea.PackageApi
|
|
|
|
All URIs are relative to *https://localhost/api/v1*
|
|
|
|
Method | HTTP request | Description
|
|
------------- | ------------- | -------------
|
|
[**delete_package**](PackageApi.md#delete_package) | **DELETE** /packages/{owner}/{type}/{name}/{version} | Delete a package
|
|
[**get_package**](PackageApi.md#get_package) | **GET** /packages/{owner}/{type}/{name}/{version} | Gets a package
|
|
[**list_package_files**](PackageApi.md#list_package_files) | **GET** /packages/{owner}/{type}/{name}/{version}/files | Gets all files of a package
|
|
[**list_packages**](PackageApi.md#list_packages) | **GET** /packages/{owner} | Gets all packages of an owner
|
|
|
|
|
|
# **delete_package**
|
|
> delete_package(owner, type, name, version)
|
|
|
|
Delete a package
|
|
|
|
### Example
|
|
```python
|
|
from __future__ import print_function
|
|
import time
|
|
import gitea
|
|
from gitea.rest import ApiException
|
|
from pprint import pprint
|
|
|
|
# Configure API key authorization: AccessToken
|
|
configuration = gitea.Configuration()
|
|
configuration.api_key['access_token'] = 'YOUR_API_KEY'
|
|
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
# configuration.api_key_prefix['access_token'] = 'Bearer'
|
|
# Configure API key authorization: AuthorizationHeaderToken
|
|
configuration = gitea.Configuration()
|
|
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
|
|
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
# configuration.api_key_prefix['Authorization'] = 'Bearer'
|
|
# Configure HTTP basic authorization: BasicAuth
|
|
configuration = gitea.Configuration()
|
|
configuration.username = 'YOUR_USERNAME'
|
|
configuration.password = 'YOUR_PASSWORD'
|
|
# Configure API key authorization: SudoHeader
|
|
configuration = gitea.Configuration()
|
|
configuration.api_key['Sudo'] = 'YOUR_API_KEY'
|
|
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
# configuration.api_key_prefix['Sudo'] = 'Bearer'
|
|
# Configure API key authorization: SudoParam
|
|
configuration = gitea.Configuration()
|
|
configuration.api_key['sudo'] = 'YOUR_API_KEY'
|
|
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
# configuration.api_key_prefix['sudo'] = 'Bearer'
|
|
# Configure API key authorization: TOTPHeader
|
|
configuration = gitea.Configuration()
|
|
configuration.api_key['X-GITEA-OTP'] = 'YOUR_API_KEY'
|
|
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
# configuration.api_key_prefix['X-GITEA-OTP'] = 'Bearer'
|
|
# Configure API key authorization: Token
|
|
configuration = gitea.Configuration()
|
|
configuration.api_key['token'] = 'YOUR_API_KEY'
|
|
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
# configuration.api_key_prefix['token'] = 'Bearer'
|
|
|
|
# create an instance of the API class
|
|
api_instance = gitea.PackageApi(gitea.ApiClient(configuration))
|
|
owner = 'owner_example' # str | owner of the package
|
|
type = 'type_example' # str | type of the package
|
|
name = 'name_example' # str | name of the package
|
|
version = 'version_example' # str | version of the package
|
|
|
|
try:
|
|
# Delete a package
|
|
api_instance.delete_package(owner, type, name, version)
|
|
except ApiException as e:
|
|
print("Exception when calling PackageApi->delete_package: %s\n" % e)
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**owner** | **str**| owner of the package |
|
|
**type** | **str**| type of the package |
|
|
**name** | **str**| name of the package |
|
|
**version** | **str**| version of the package |
|
|
|
|
### Return type
|
|
|
|
void (empty response body)
|
|
|
|
### Authorization
|
|
|
|
[AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: application/json, text/plain
|
|
- **Accept**: application/json, text/html
|
|
|
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
|
|
# **get_package**
|
|
> Package get_package(owner, type, name, version)
|
|
|
|
Gets a package
|
|
|
|
### Example
|
|
```python
|
|
from __future__ import print_function
|
|
import time
|
|
import gitea
|
|
from gitea.rest import ApiException
|
|
from pprint import pprint
|
|
|
|
# Configure API key authorization: AccessToken
|
|
configuration = gitea.Configuration()
|
|
configuration.api_key['access_token'] = 'YOUR_API_KEY'
|
|
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
# configuration.api_key_prefix['access_token'] = 'Bearer'
|
|
# Configure API key authorization: AuthorizationHeaderToken
|
|
configuration = gitea.Configuration()
|
|
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
|
|
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
# configuration.api_key_prefix['Authorization'] = 'Bearer'
|
|
# Configure HTTP basic authorization: BasicAuth
|
|
configuration = gitea.Configuration()
|
|
configuration.username = 'YOUR_USERNAME'
|
|
configuration.password = 'YOUR_PASSWORD'
|
|
# Configure API key authorization: SudoHeader
|
|
configuration = gitea.Configuration()
|
|
configuration.api_key['Sudo'] = 'YOUR_API_KEY'
|
|
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
# configuration.api_key_prefix['Sudo'] = 'Bearer'
|
|
# Configure API key authorization: SudoParam
|
|
configuration = gitea.Configuration()
|
|
configuration.api_key['sudo'] = 'YOUR_API_KEY'
|
|
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
# configuration.api_key_prefix['sudo'] = 'Bearer'
|
|
# Configure API key authorization: TOTPHeader
|
|
configuration = gitea.Configuration()
|
|
configuration.api_key['X-GITEA-OTP'] = 'YOUR_API_KEY'
|
|
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
# configuration.api_key_prefix['X-GITEA-OTP'] = 'Bearer'
|
|
# Configure API key authorization: Token
|
|
configuration = gitea.Configuration()
|
|
configuration.api_key['token'] = 'YOUR_API_KEY'
|
|
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
# configuration.api_key_prefix['token'] = 'Bearer'
|
|
|
|
# create an instance of the API class
|
|
api_instance = gitea.PackageApi(gitea.ApiClient(configuration))
|
|
owner = 'owner_example' # str | owner of the package
|
|
type = 'type_example' # str | type of the package
|
|
name = 'name_example' # str | name of the package
|
|
version = 'version_example' # str | version of the package
|
|
|
|
try:
|
|
# Gets a package
|
|
api_response = api_instance.get_package(owner, type, name, version)
|
|
pprint(api_response)
|
|
except ApiException as e:
|
|
print("Exception when calling PackageApi->get_package: %s\n" % e)
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**owner** | **str**| owner of the package |
|
|
**type** | **str**| type of the package |
|
|
**name** | **str**| name of the package |
|
|
**version** | **str**| version of the package |
|
|
|
|
### Return type
|
|
|
|
[**Package**](Package.md)
|
|
|
|
### Authorization
|
|
|
|
[AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: application/json, text/plain
|
|
- **Accept**: application/json
|
|
|
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
|
|
# **list_package_files**
|
|
> list[PackageFile] list_package_files(owner, type, name, version)
|
|
|
|
Gets all files of a package
|
|
|
|
### Example
|
|
```python
|
|
from __future__ import print_function
|
|
import time
|
|
import gitea
|
|
from gitea.rest import ApiException
|
|
from pprint import pprint
|
|
|
|
# Configure API key authorization: AccessToken
|
|
configuration = gitea.Configuration()
|
|
configuration.api_key['access_token'] = 'YOUR_API_KEY'
|
|
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
# configuration.api_key_prefix['access_token'] = 'Bearer'
|
|
# Configure API key authorization: AuthorizationHeaderToken
|
|
configuration = gitea.Configuration()
|
|
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
|
|
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
# configuration.api_key_prefix['Authorization'] = 'Bearer'
|
|
# Configure HTTP basic authorization: BasicAuth
|
|
configuration = gitea.Configuration()
|
|
configuration.username = 'YOUR_USERNAME'
|
|
configuration.password = 'YOUR_PASSWORD'
|
|
# Configure API key authorization: SudoHeader
|
|
configuration = gitea.Configuration()
|
|
configuration.api_key['Sudo'] = 'YOUR_API_KEY'
|
|
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
# configuration.api_key_prefix['Sudo'] = 'Bearer'
|
|
# Configure API key authorization: SudoParam
|
|
configuration = gitea.Configuration()
|
|
configuration.api_key['sudo'] = 'YOUR_API_KEY'
|
|
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
# configuration.api_key_prefix['sudo'] = 'Bearer'
|
|
# Configure API key authorization: TOTPHeader
|
|
configuration = gitea.Configuration()
|
|
configuration.api_key['X-GITEA-OTP'] = 'YOUR_API_KEY'
|
|
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
# configuration.api_key_prefix['X-GITEA-OTP'] = 'Bearer'
|
|
# Configure API key authorization: Token
|
|
configuration = gitea.Configuration()
|
|
configuration.api_key['token'] = 'YOUR_API_KEY'
|
|
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
# configuration.api_key_prefix['token'] = 'Bearer'
|
|
|
|
# create an instance of the API class
|
|
api_instance = gitea.PackageApi(gitea.ApiClient(configuration))
|
|
owner = 'owner_example' # str | owner of the package
|
|
type = 'type_example' # str | type of the package
|
|
name = 'name_example' # str | name of the package
|
|
version = 'version_example' # str | version of the package
|
|
|
|
try:
|
|
# Gets all files of a package
|
|
api_response = api_instance.list_package_files(owner, type, name, version)
|
|
pprint(api_response)
|
|
except ApiException as e:
|
|
print("Exception when calling PackageApi->list_package_files: %s\n" % e)
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**owner** | **str**| owner of the package |
|
|
**type** | **str**| type of the package |
|
|
**name** | **str**| name of the package |
|
|
**version** | **str**| version of the package |
|
|
|
|
### Return type
|
|
|
|
[**list[PackageFile]**](PackageFile.md)
|
|
|
|
### Authorization
|
|
|
|
[AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: application/json, text/plain
|
|
- **Accept**: application/json
|
|
|
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
|
|
# **list_packages**
|
|
> list[Package] list_packages(owner, page=page, limit=limit, type=type, q=q)
|
|
|
|
Gets all packages of an owner
|
|
|
|
### Example
|
|
```python
|
|
from __future__ import print_function
|
|
import time
|
|
import gitea
|
|
from gitea.rest import ApiException
|
|
from pprint import pprint
|
|
|
|
# Configure API key authorization: AccessToken
|
|
configuration = gitea.Configuration()
|
|
configuration.api_key['access_token'] = 'YOUR_API_KEY'
|
|
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
# configuration.api_key_prefix['access_token'] = 'Bearer'
|
|
# Configure API key authorization: AuthorizationHeaderToken
|
|
configuration = gitea.Configuration()
|
|
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
|
|
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
# configuration.api_key_prefix['Authorization'] = 'Bearer'
|
|
# Configure HTTP basic authorization: BasicAuth
|
|
configuration = gitea.Configuration()
|
|
configuration.username = 'YOUR_USERNAME'
|
|
configuration.password = 'YOUR_PASSWORD'
|
|
# Configure API key authorization: SudoHeader
|
|
configuration = gitea.Configuration()
|
|
configuration.api_key['Sudo'] = 'YOUR_API_KEY'
|
|
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
# configuration.api_key_prefix['Sudo'] = 'Bearer'
|
|
# Configure API key authorization: SudoParam
|
|
configuration = gitea.Configuration()
|
|
configuration.api_key['sudo'] = 'YOUR_API_KEY'
|
|
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
# configuration.api_key_prefix['sudo'] = 'Bearer'
|
|
# Configure API key authorization: TOTPHeader
|
|
configuration = gitea.Configuration()
|
|
configuration.api_key['X-GITEA-OTP'] = 'YOUR_API_KEY'
|
|
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
# configuration.api_key_prefix['X-GITEA-OTP'] = 'Bearer'
|
|
# Configure API key authorization: Token
|
|
configuration = gitea.Configuration()
|
|
configuration.api_key['token'] = 'YOUR_API_KEY'
|
|
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
# configuration.api_key_prefix['token'] = 'Bearer'
|
|
|
|
# create an instance of the API class
|
|
api_instance = gitea.PackageApi(gitea.ApiClient(configuration))
|
|
owner = 'owner_example' # str | owner of the packages
|
|
page = 56 # int | page number of results to return (1-based) (optional)
|
|
limit = 56 # int | page size of results (optional)
|
|
type = 'type_example' # str | package type filter (optional)
|
|
q = 'q_example' # str | name filter (optional)
|
|
|
|
try:
|
|
# Gets all packages of an owner
|
|
api_response = api_instance.list_packages(owner, page=page, limit=limit, type=type, q=q)
|
|
pprint(api_response)
|
|
except ApiException as e:
|
|
print("Exception when calling PackageApi->list_packages: %s\n" % e)
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**owner** | **str**| owner of the packages |
|
|
**page** | **int**| page number of results to return (1-based) | [optional]
|
|
**limit** | **int**| page size of results | [optional]
|
|
**type** | **str**| package type filter | [optional]
|
|
**q** | **str**| name filter | [optional]
|
|
|
|
### Return type
|
|
|
|
[**list[Package]**](Package.md)
|
|
|
|
### Authorization
|
|
|
|
[AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: application/json, text/plain
|
|
- **Accept**: application/json
|
|
|
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
|