python/giteapython
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Initial commit.

Browse Source
This commit is contained in:
Aleksander Cynarski
2020-11-28 18:59:17 +01:00
commit a60c631551
410 changed files with 87335 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
docs/APIError.md Normal file
View File

@ -0,0 +1,11 @@
# APIError
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**message** | **str** | | [optional]
**url** | **str** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

10
docs/AccessToken.md Normal file
View File

@ -0,0 +1,10 @@
# AccessToken
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **str** | |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

10
docs/AddCollaboratorOption.md Normal file
View File

@ -0,0 +1,10 @@
# AddCollaboratorOption
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**permission** | **str** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

12
docs/AddTimeOption.md Normal file
View File

@ -0,0 +1,12 @@
# AddTimeOption
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**created** | **datetime** | | [optional]
**time** | **int** | time in seconds |
**user_name** | **str** | User who spent the time (optional) | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

713
docs/AdminApi.md Normal file
View File

@ -0,0 +1,713 @@
# giteapython.AdminApi
All URIs are relative to *http://localhost/api/v1*
Method | HTTP request | Description
------------- | ------------- | -------------
[**admin_create_org**](AdminApi.md#admin_create_org) | **POST** /admin/users/{username}/orgs | Create an organization
[**admin_create_public_key**](AdminApi.md#admin_create_public_key) | **POST** /admin/users/{username}/keys | Add a public key on behalf of a user
[**admin_create_repo**](AdminApi.md#admin_create_repo) | **POST** /admin/users/{username}/repos | Create a repository on behalf of a user
[**admin_create_user**](AdminApi.md#admin_create_user) | **POST** /admin/users | Create a user
[**admin_delete_user**](AdminApi.md#admin_delete_user) | **DELETE** /admin/users/{username} | Delete a user
[**admin_delete_user_public_key**](AdminApi.md#admin_delete_user_public_key) | **DELETE** /admin/users/{username}/keys/{id} | Delete a user's public key
[**admin_edit_user**](AdminApi.md#admin_edit_user) | **PATCH** /admin/users/{username} | Edit an existing user
[**admin_get_all_orgs**](AdminApi.md#admin_get_all_orgs) | **GET** /admin/orgs | List all organizations
[**admin_get_all_users**](AdminApi.md#admin_get_all_users) | **GET** /admin/users | List all users
# **admin_create_org**
> Organization admin_create_org(username, organization)
Create an organization
### Example
```python
from __future__ import print_function
import time
import giteapython
from giteapython.rest import ApiException
from pprint import pprint
# Configure API key authorization: AccessToken
configuration = giteapython.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 = giteapython.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 = giteapython.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# Configure API key authorization: SudoHeader
configuration = giteapython.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 = giteapython.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: Token
configuration = giteapython.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 = giteapython.AdminApi(giteapython.ApiClient(configuration))
username = 'username_example' # str | username of the user that will own the created organization
organization = giteapython.CreateOrgOption() # CreateOrgOption |
try:
# Create an organization
api_response = api_instance.admin_create_org(username, organization)
pprint(api_response)
except ApiException as e:
print("Exception when calling AdminApi->admin_create_org: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**username** | **str**| username of the user that will own the created organization |
**organization** | [**CreateOrgOption**](CreateOrgOption.md)| |
### Return type
[**Organization**](Organization.md)
### Authorization
[AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token)
### HTTP request headers
- **Content-Type**: application/json
- **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)
# **admin_create_public_key**
> PublicKey admin_create_public_key(username, key=key)
Add a public key on behalf of a user
### Example
```python
from __future__ import print_function
import time
import giteapython
from giteapython.rest import ApiException
from pprint import pprint
# Configure API key authorization: AccessToken
configuration = giteapython.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 = giteapython.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 = giteapython.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# Configure API key authorization: SudoHeader
configuration = giteapython.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 = giteapython.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: Token
configuration = giteapython.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 = giteapython.AdminApi(giteapython.ApiClient(configuration))
username = 'username_example' # str | username of the user
key = giteapython.CreateKeyOption() # CreateKeyOption | (optional)
try:
# Add a public key on behalf of a user
api_response = api_instance.admin_create_public_key(username, key=key)
pprint(api_response)
except ApiException as e:
print("Exception when calling AdminApi->admin_create_public_key: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**username** | **str**| username of the user |
**key** | [**CreateKeyOption**](CreateKeyOption.md)| | [optional]
### Return type
[**PublicKey**](PublicKey.md)
### Authorization
[AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token)
### HTTP request headers
- **Content-Type**: application/json
- **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)
# **admin_create_repo**
> Repository admin_create_repo(username, repository)
Create a repository on behalf of a user
### Example
```python
from __future__ import print_function
import time
import giteapython
from giteapython.rest import ApiException
from pprint import pprint
# Configure API key authorization: AccessToken
configuration = giteapython.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 = giteapython.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 = giteapython.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# Configure API key authorization: SudoHeader
configuration = giteapython.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 = giteapython.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: Token
configuration = giteapython.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 = giteapython.AdminApi(giteapython.ApiClient(configuration))
username = 'username_example' # str | username of the user. This user will own the created repository
repository = giteapython.CreateRepoOption() # CreateRepoOption |
try:
# Create a repository on behalf of a user
api_response = api_instance.admin_create_repo(username, repository)
pprint(api_response)
except ApiException as e:
print("Exception when calling AdminApi->admin_create_repo: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**username** | **str**| username of the user. This user will own the created repository |
**repository** | [**CreateRepoOption**](CreateRepoOption.md)| |
### Return type
[**Repository**](Repository.md)
### Authorization
[AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token)
### HTTP request headers
- **Content-Type**: application/json
- **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)
# **admin_create_user**
> User admin_create_user(body=body)
Create a user
### Example
```python
from __future__ import print_function
import time
import giteapython
from giteapython.rest import ApiException
from pprint import pprint
# Configure API key authorization: AccessToken
configuration = giteapython.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 = giteapython.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 = giteapython.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# Configure API key authorization: SudoHeader
configuration = giteapython.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 = giteapython.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: Token
configuration = giteapython.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 = giteapython.AdminApi(giteapython.ApiClient(configuration))
body = giteapython.CreateUserOption() # CreateUserOption | (optional)
try:
# Create a user
api_response = api_instance.admin_create_user(body=body)
pprint(api_response)
except ApiException as e:
print("Exception when calling AdminApi->admin_create_user: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**CreateUserOption**](CreateUserOption.md)| | [optional]
### Return type
[**User**](User.md)
### Authorization
[AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token)
### HTTP request headers
- **Content-Type**: application/json
- **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)
# **admin_delete_user**
> admin_delete_user(username)
Delete a user
### Example
```python
from __future__ import print_function
import time
import giteapython
from giteapython.rest import ApiException
from pprint import pprint
# Configure API key authorization: AccessToken
configuration = giteapython.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 = giteapython.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 = giteapython.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# Configure API key authorization: SudoHeader
configuration = giteapython.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 = giteapython.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: Token
configuration = giteapython.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 = giteapython.AdminApi(giteapython.ApiClient(configuration))
username = 'username_example' # str | username of user to delete
try:
# Delete a user
api_instance.admin_delete_user(username)
except ApiException as e:
print("Exception when calling AdminApi->admin_delete_user: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**username** | **str**| username of user to delete |
### 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), [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)
# **admin_delete_user_public_key**
> admin_delete_user_public_key(username, id)
Delete a user's public key
### Example
```python
from __future__ import print_function
import time
import giteapython
from giteapython.rest import ApiException
from pprint import pprint
# Configure API key authorization: AccessToken
configuration = giteapython.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 = giteapython.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 = giteapython.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# Configure API key authorization: SudoHeader
configuration = giteapython.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 = giteapython.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: Token
configuration = giteapython.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 = giteapython.AdminApi(giteapython.ApiClient(configuration))
username = 'username_example' # str | username of user
id = 789 # int | id of the key to delete
try:
# Delete a user's public key
api_instance.admin_delete_user_public_key(username, id)
except ApiException as e:
print("Exception when calling AdminApi->admin_delete_user_public_key: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**username** | **str**| username of user |
**id** | **int**| id of the key to delete |
### 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), [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)
# **admin_edit_user**
> User admin_edit_user(username, body=body)
Edit an existing user
### Example
```python
from __future__ import print_function
import time
import giteapython
from giteapython.rest import ApiException
from pprint import pprint
# Configure API key authorization: AccessToken
configuration = giteapython.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 = giteapython.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 = giteapython.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# Configure API key authorization: SudoHeader
configuration = giteapython.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 = giteapython.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: Token
configuration = giteapython.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 = giteapython.AdminApi(giteapython.ApiClient(configuration))
username = 'username_example' # str | username of user to edit
body = giteapython.EditUserOption() # EditUserOption | (optional)
try:
# Edit an existing user
api_response = api_instance.admin_edit_user(username, body=body)
pprint(api_response)
except ApiException as e:
print("Exception when calling AdminApi->admin_edit_user: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**username** | **str**| username of user to edit |
**body** | [**EditUserOption**](EditUserOption.md)| | [optional]
### Return type
[**User**](User.md)
### Authorization
[AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token)
### HTTP request headers
- **Content-Type**: application/json
- **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)
# **admin_get_all_orgs**
> list[Organization] admin_get_all_orgs(page=page, limit=limit)
List all organizations
### Example
```python
from __future__ import print_function
import time
import giteapython
from giteapython.rest import ApiException
from pprint import pprint
# Configure API key authorization: AccessToken
configuration = giteapython.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 = giteapython.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 = giteapython.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# Configure API key authorization: SudoHeader
configuration = giteapython.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 = giteapython.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: Token
configuration = giteapython.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 = giteapython.AdminApi(giteapython.ApiClient(configuration))
page = 56 # int | page number of results to return (1-based) (optional)
limit = 56 # int | page size of results, maximum page size is 50 (optional)
try:
# List all organizations
api_response = api_instance.admin_get_all_orgs(page=page, limit=limit)
pprint(api_response)
except ApiException as e:
print("Exception when calling AdminApi->admin_get_all_orgs: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**page** | **int**| page number of results to return (1-based) | [optional]
**limit** | **int**| page size of results, maximum page size is 50 | [optional]
### Return type
[**list[Organization]**](Organization.md)
### Authorization
[AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [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)
# **admin_get_all_users**
> list[User] admin_get_all_users(page=page, limit=limit)
List all users
### Example
```python
from __future__ import print_function
import time
import giteapython
from giteapython.rest import ApiException
from pprint import pprint
# Configure API key authorization: AccessToken
configuration = giteapython.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 = giteapython.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 = giteapython.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# Configure API key authorization: SudoHeader
configuration = giteapython.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 = giteapython.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: Token
configuration = giteapython.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 = giteapython.AdminApi(giteapython.ApiClient(configuration))
page = 56 # int | page number of results to return (1-based) (optional)
limit = 56 # int | page size of results, maximum page size is 50 (optional)
try:
# List all users
api_response = api_instance.admin_get_all_users(page=page, limit=limit)
pprint(api_response)
except ApiException as e:
print("Exception when calling AdminApi->admin_get_all_users: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**page** | **int**| page number of results to return (1-based) | [optional]
**limit** | **int**| page size of results, maximum page size is 50 | [optional]
### Return type
[**list[User]**](User.md)
### Authorization
[AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [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)

16
docs/AnnotatedTag.md Normal file
View File

@ -0,0 +1,16 @@
# AnnotatedTag
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**message** | **str** | | [optional]
**object** | [**AnnotatedTagObject**](AnnotatedTagObject.md) | | [optional]
**sha** | **str** | | [optional]
**tag** | **str** | | [optional]
**tagger** | [**CommitUser**](CommitUser.md) | | [optional]
**url** | **str** | | [optional]
**verification** | [**PayloadCommitVerification**](PayloadCommitVerification.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

12
docs/AnnotatedTagObject.md Normal file
View File

@ -0,0 +1,12 @@
# AnnotatedTagObject
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**sha** | **str** | | [optional]
**type** | **str** | | [optional]
**url** | **str** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

16
docs/Attachment.md Normal file
View File

@ -0,0 +1,16 @@
# Attachment
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**browser_download_url** | **str** | | [optional]
**created_at** | **datetime** | | [optional]
**download_count** | **int** | | [optional]
**id** | **int** | | [optional]
**name** | **str** | | [optional]
**size** | **int** | | [optional]
**uuid** | **str** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

18
docs/Branch.md Normal file
View File

@ -0,0 +1,18 @@
# Branch
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**commit** | [**PayloadCommit**](PayloadCommit.md) | | [optional]
**effective_branch_protection_name** | **str** | | [optional]
**enable_status_check** | **bool** | | [optional]
**name** | **str** | | [optional]
**protected** | **bool** | | [optional]
**required_approvals** | **int** | | [optional]
**status_check_contexts** | **list[str]** | | [optional]
**user_can_merge** | **bool** | | [optional]
**user_can_push** | **bool** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

31
docs/BranchProtection.md Normal file
View File

@ -0,0 +1,31 @@
# BranchProtection
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**approvals_whitelist_teams** | **list[str]** | | [optional]
**approvals_whitelist_username** | **list[str]** | | [optional]
**block_on_outdated_branch** | **bool** | | [optional]
**block_on_rejected_reviews** | **bool** | | [optional]
**branch_name** | **str** | | [optional]
**created_at** | **datetime** | | [optional]
**dismiss_stale_approvals** | **bool** | | [optional]
**enable_approvals_whitelist** | **bool** | | [optional]
**enable_merge_whitelist** | **bool** | | [optional]
**enable_push** | **bool** | | [optional]
**enable_push_whitelist** | **bool** | | [optional]
**enable_status_check** | **bool** | | [optional]
**merge_whitelist_teams** | **list[str]** | | [optional]
**merge_whitelist_usernames** | **list[str]** | | [optional]
**protected_file_patterns** | **str** | | [optional]
**push_whitelist_deploy_keys** | **bool** | | [optional]
**push_whitelist_teams** | **list[str]** | | [optional]
**push_whitelist_usernames** | **list[str]** | | [optional]
**require_signed_commits** | **bool** | | [optional]
**required_approvals** | **int** | | [optional]
**status_check_contexts** | **list[str]** | | [optional]
**updated_at** | **datetime** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

19
docs/Comment.md Normal file
View File

@ -0,0 +1,19 @@
# Comment
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**body** | **str** | | [optional]
**created_at** | **datetime** | | [optional]
**html_url** | **str** | | [optional]
**id** | **int** | | [optional]
**issue_url** | **str** | | [optional]
**original_author** | **str** | | [optional]
**original_author_id** | **int** | | [optional]
**pull_request_url** | **str** | | [optional]
**updated_at** | **datetime** | | [optional]
**user** | [**User**](User.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

16
docs/Commit.md Normal file
View File

@ -0,0 +1,16 @@
# Commit
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**author** | [**User**](User.md) | | [optional]
**commit** | [**RepoCommit**](RepoCommit.md) | | [optional]
**committer** | [**User**](User.md) | | [optional]
**html_url** | **str** | | [optional]
**parents** | [**list[CommitMeta]**](CommitMeta.md) | | [optional]
**sha** | **str** | | [optional]
**url** | **str** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

11
docs/CommitDateOptions.md Normal file
View File

@ -0,0 +1,11 @@
# CommitDateOptions
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**author** | **datetime** | | [optional]
**committer** | **datetime** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

11
docs/CommitMeta.md Normal file
View File

@ -0,0 +1,11 @@
# CommitMeta
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**sha** | **str** | | [optional]
**url** | **str** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

12
docs/CommitUser.md Normal file
View File

@ -0,0 +1,12 @@
# CommitUser
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**_date** | **str** | | [optional]
**email** | **str** | | [optional]
**name** | **str** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

23
docs/ContentsResponse.md Normal file
View File

@ -0,0 +1,23 @@
# ContentsResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**links** | [**FileLinksResponse**](FileLinksResponse.md) | | [optional]
**content** | **str** | `content` is populated when `type` is `file`, otherwise null | [optional]
**download_url** | **str** | | [optional]
**encoding** | **str** | `encoding` is populated when `type` is `file`, otherwise null | [optional]
**git_url** | **str** | | [optional]
**html_url** | **str** | | [optional]
**name** | **str** | | [optional]
**path** | **str** | | [optional]
**sha** | **str** | | [optional]
**size** | **int** | | [optional]
**submodule_git_url** | **str** | `submodule_git_url` is populated when `type` is `submodule`, otherwise null | [optional]
**target** | **str** | `target` is populated when `type` is `symlink`, otherwise null | [optional]
**type** | **str** | `type` will be `file`, `dir`, `symlink`, or `submodule` | [optional]
**url** | **str** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

29
docs/CreateBranchProtectionOption.md Normal file
View File

@ -0,0 +1,29 @@
# CreateBranchProtectionOption
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**approvals_whitelist_teams** | **list[str]** | | [optional]
**approvals_whitelist_username** | **list[str]** | | [optional]
**block_on_outdated_branch** | **bool** | | [optional]
**block_on_rejected_reviews** | **bool** | | [optional]
**branch_name** | **str** | | [optional]
**dismiss_stale_approvals** | **bool** | | [optional]
**enable_approvals_whitelist** | **bool** | | [optional]
**enable_merge_whitelist** | **bool** | | [optional]
**enable_push** | **bool** | | [optional]
**enable_push_whitelist** | **bool** | | [optional]
**enable_status_check** | **bool** | | [optional]
**merge_whitelist_teams** | **list[str]** | | [optional]
**merge_whitelist_usernames** | **list[str]** | | [optional]
**protected_file_patterns** | **str** | | [optional]
**push_whitelist_deploy_keys** | **bool** | | [optional]
**push_whitelist_teams** | **list[str]** | | [optional]
**push_whitelist_usernames** | **list[str]** | | [optional]
**require_signed_commits** | **bool** | | [optional]
**required_approvals** | **int** | | [optional]
**status_check_contexts** | **list[str]** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

10
docs/CreateEmailOption.md Normal file
View File

@ -0,0 +1,10 @@
# CreateEmailOption
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**emails** | **list[str]** | email addresses to add | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

16
docs/CreateFileOptions.md Normal file
View File

@ -0,0 +1,16 @@
# CreateFileOptions
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**author** | [**Identity**](Identity.md) | | [optional]
**branch** | **str** | branch (optional) to base this file from. if not given, the default branch is used | [optional]
**committer** | [**Identity**](Identity.md) | | [optional]
**content** | **str** | content must be base64 encoded |
**dates** | [**CommitDateOptions**](CommitDateOptions.md) | | [optional]
**message** | **str** | message (optional) for the commit of this file. if not supplied, a default message will be used | [optional]
**new_branch** | **str** | new_branch (optional) will make a new branch from `branch` before creating the file | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

10
docs/CreateForkOption.md Normal file
View File

@ -0,0 +1,10 @@
# CreateForkOption
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**organization** | **str** | organization name, if forking into an organization | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

10
docs/CreateGPGKeyOption.md Normal file
View File

@ -0,0 +1,10 @@
# CreateGPGKeyOption
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**armored_public_key** | **str** | An armored GPG key to add |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

14
docs/CreateHookOption.md Normal file
View File

@ -0,0 +1,14 @@
# CreateHookOption
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**active** | **bool** | | [optional] [default to False]
**branch_filter** | **str** | | [optional]
**config** | [**CreateHookOptionConfig**](CreateHookOptionConfig.md) | |
**events** | **list[str]** | | [optional]
**type** | **str** | |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

9
docs/CreateHookOptionConfig.md Normal file
View File

@ -0,0 +1,9 @@
# CreateHookOptionConfig
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

10
docs/CreateIssueCommentOption.md Normal file
View File

@ -0,0 +1,10 @@
# CreateIssueCommentOption
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**body** | **str** | |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

17
docs/CreateIssueOption.md Normal file
View File

@ -0,0 +1,17 @@
# CreateIssueOption
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**assignee** | **str** | username of assignee | [optional]
**assignees** | **list[str]** | | [optional]
**body** | **str** | | [optional]
**closed** | **bool** | | [optional]
**due_date** | **datetime** | | [optional]
**labels** | **list[int]** | list of label ids | [optional]
**milestone** | **int** | milestone id | [optional]
**title** | **str** | |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

12
docs/CreateKeyOption.md Normal file
View File

@ -0,0 +1,12 @@
# CreateKeyOption
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**key** | **str** | An armored SSH key to add |
**read_only** | **bool** | Describe if the key has only read access or read/write | [optional]
**title** | **str** | Title of the key to add |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

12
docs/CreateLabelOption.md Normal file
View File

@ -0,0 +1,12 @@
# CreateLabelOption
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**color** | **str** | |
**description** | **str** | | [optional]
**name** | **str** | |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

12
docs/CreateMilestoneOption.md Normal file
View File

@ -0,0 +1,12 @@
# CreateMilestoneOption
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**description** | **str** | | [optional]
**due_on** | **datetime** | | [optional]
**title** | **str** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

11
docs/CreateOAuth2ApplicationOptions.md Normal file
View File

@ -0,0 +1,11 @@
# CreateOAuth2ApplicationOptions
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **str** | | [optional]
**redirect_uris** | **list[str]** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

16
docs/CreateOrgOption.md Normal file
View File

@ -0,0 +1,16 @@
# CreateOrgOption
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**description** | **str** | | [optional]
**full_name** | **str** | | [optional]
**location** | **str** | | [optional]
**repo_admin_change_team_access** | **bool** | | [optional]
**username** | **str** | |
**visibility** | **str** | possible values are `public` (default), `limited` or `private` | [optional]
**website** | **str** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

18
docs/CreatePullRequestOption.md Normal file
View File

@ -0,0 +1,18 @@
# CreatePullRequestOption
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**assignee** | **str** | | [optional]
**assignees** | **list[str]** | | [optional]
**base** | **str** | | [optional]
**body** | **str** | | [optional]
**due_date** | **datetime** | | [optional]
**head** | **str** | | [optional]
**labels** | **list[int]** | | [optional]
**milestone** | **int** | | [optional]
**title** | **str** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

13
docs/CreatePullReviewComment.md Normal file
View File

@ -0,0 +1,13 @@
# CreatePullReviewComment
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**body** | **str** | | [optional]
**new_position** | **int** | if comment to new file line or 0 | [optional]
**old_position** | **int** | if comment to old file line or 0 | [optional]
**path** | **str** | the tree path | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

13
docs/CreatePullReviewOptions.md Normal file
View File

@ -0,0 +1,13 @@
# CreatePullReviewOptions
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**body** | **str** | | [optional]
**comments** | [**list[CreatePullReviewComment]**](CreatePullReviewComment.md) | | [optional]
**commit_id** | **str** | | [optional]
**event** | [**ReviewStateType**](ReviewStateType.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

15
docs/CreateReleaseOption.md Normal file
View File

@ -0,0 +1,15 @@
# CreateReleaseOption
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**body** | **str** | | [optional]
**draft** | **bool** | | [optional]
**name** | **str** | | [optional]
**prerelease** | **bool** | | [optional]
**tag_name** | **str** | |
**target_commitish** | **str** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

18
docs/CreateRepoOption.md Normal file
View File

@ -0,0 +1,18 @@
# CreateRepoOption
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**auto_init** | **bool** | Whether the repository should be auto-intialized? | [optional]
**default_branch** | **str** | DefaultBranch of the repository (used when initializes and in template) | [optional]
**description** | **str** | Description of the repository to create | [optional]
**gitignores** | **str** | Gitignores to use | [optional]
**issue_labels** | **str** | Issue Label set to use | [optional]
**license** | **str** | License to use | [optional]
**name** | **str** | Name of the repository to create |
**private** | **bool** | Whether the repository is private | [optional]
**readme** | **str** | Readme of the repository to create | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

13
docs/CreateStatusOption.md Normal file
View File

@ -0,0 +1,13 @@
# CreateStatusOption
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**context** | **str** | | [optional]
**description** | **str** | | [optional]
**state** | [**StatusState**](StatusState.md) | | [optional]
**target_url** | **str** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

15
docs/CreateTeamOption.md Normal file
View File

@ -0,0 +1,15 @@
# CreateTeamOption
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**can_create_org_repo** | **bool** | | [optional]
**description** | **str** | | [optional]
**includes_all_repositories** | **bool** | | [optional]
**name** | **str** | |
**permission** | **str** | | [optional]
**units** | **list[str]** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

17
docs/CreateUserOption.md Normal file
View File

@ -0,0 +1,17 @@
# CreateUserOption
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**email** | **str** | |
**full_name** | **str** | | [optional]
**login_name** | **str** | | [optional]
**must_change_password** | **bool** | | [optional]
**password** | **str** | |
**send_notify** | **bool** | | [optional]
**source_id** | **int** | | [optional]
**username** | **str** | |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

10
docs/DeleteEmailOption.md Normal file
View File

@ -0,0 +1,10 @@
# DeleteEmailOption
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**emails** | **list[str]** | email addresses to delete | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

16
docs/DeleteFileOptions.md Normal file
View File

@ -0,0 +1,16 @@
# DeleteFileOptions
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**author** | [**Identity**](Identity.md) | | [optional]
**branch** | **str** | branch (optional) to base this file from. if not given, the default branch is used | [optional]
**committer** | [**Identity**](Identity.md) | | [optional]
**dates** | [**CommitDateOptions**](CommitDateOptions.md) | | [optional]
**message** | **str** | message (optional) for the commit of this file. if not supplied, a default message will be used | [optional]
**new_branch** | **str** | new_branch (optional) will make a new branch from `branch` before creating the file | [optional]
**sha** | **str** | sha is the SHA for the file that already exists |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

18
docs/DeployKey.md Normal file
View File

@ -0,0 +1,18 @@
# DeployKey
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**created_at** | **datetime** | | [optional]
**fingerprint** | **str** | | [optional]
**id** | **int** | | [optional]
**key** | **str** | | [optional]
**key_id** | **int** | | [optional]
**read_only** | **bool** | | [optional]
**repository** | [**Repository**](Repository.md) | | [optional]
**title** | **str** | | [optional]
**url** | **str** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

10
docs/EditAttachmentOptions.md Normal file
View File

@ -0,0 +1,10 @@
# EditAttachmentOptions
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **str** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

28
docs/EditBranchProtectionOption.md Normal file
View File

@ -0,0 +1,28 @@
# EditBranchProtectionOption
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**approvals_whitelist_teams** | **list[str]** | | [optional]
**approvals_whitelist_username** | **list[str]** | | [optional]
**block_on_outdated_branch** | **bool** | | [optional]
**block_on_rejected_reviews** | **bool** | | [optional]
**dismiss_stale_approvals** | **bool** | | [optional]
**enable_approvals_whitelist** | **bool** | | [optional]
**enable_merge_whitelist** | **bool** | | [optional]
**enable_push** | **bool** | | [optional]
**enable_push_whitelist** | **bool** | | [optional]
**enable_status_check** | **bool** | | [optional]
**merge_whitelist_teams** | **list[str]** | | [optional]
**merge_whitelist_usernames** | **list[str]** | | [optional]
**protected_file_patterns** | **str** | | [optional]
**push_whitelist_deploy_keys** | **bool** | | [optional]
**push_whitelist_teams** | **list[str]** | | [optional]
**push_whitelist_usernames** | **list[str]** | | [optional]
**require_signed_commits** | **bool** | | [optional]
**required_approvals** | **int** | | [optional]
**status_check_contexts** | **list[str]** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

10
docs/EditDeadlineOption.md Normal file
View File

@ -0,0 +1,10 @@
# EditDeadlineOption
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**due_date** | **datetime** | |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

10
docs/EditGitHookOption.md Normal file
View File

@ -0,0 +1,10 @@
# EditGitHookOption
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**content** | **str** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

13
docs/EditHookOption.md Normal file
View File

@ -0,0 +1,13 @@
# EditHookOption
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**active** | **bool** | | [optional]
**branch_filter** | **str** | | [optional]
**config** | **dict(str, str)** | | [optional]
**events** | **list[str]** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

10
docs/EditIssueCommentOption.md Normal file
View File

@ -0,0 +1,10 @@
# EditIssueCommentOption
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**body** | **str** | |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

17
docs/EditIssueOption.md Normal file
View File

@ -0,0 +1,17 @@
# EditIssueOption
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**assignee** | **str** | | [optional]
**assignees** | **list[str]** | | [optional]
**body** | **str** | | [optional]
**due_date** | **datetime** | | [optional]
**milestone** | **int** | | [optional]
**state** | **str** | | [optional]
**title** | **str** | | [optional]
**unset_due_date** | **bool** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

12
docs/EditLabelOption.md Normal file
View File

@ -0,0 +1,12 @@
# EditLabelOption
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**color** | **str** | | [optional]
**description** | **str** | | [optional]
**name** | **str** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

13
docs/EditMilestoneOption.md Normal file
View File

@ -0,0 +1,13 @@
# EditMilestoneOption
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**description** | **str** | | [optional]
**due_on** | **datetime** | | [optional]
**state** | **str** | | [optional]
**title** | **str** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

15
docs/EditOrgOption.md Normal file
View File

@ -0,0 +1,15 @@
# EditOrgOption
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**description** | **str** | | [optional]
**full_name** | **str** | | [optional]
**location** | **str** | | [optional]
**repo_admin_change_team_access** | **bool** | | [optional]
**visibility** | **str** | possible values are `public`, `limited` or `private` | [optional]
**website** | **str** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

19
docs/EditPullRequestOption.md Normal file
View File

@ -0,0 +1,19 @@
# EditPullRequestOption
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**assignee** | **str** | | [optional]
**assignees** | **list[str]** | | [optional]
**base** | **str** | | [optional]
**body** | **str** | | [optional]
**due_date** | **datetime** | | [optional]
**labels** | **list[int]** | | [optional]
**milestone** | **int** | | [optional]
**state** | **str** | | [optional]
**title** | **str** | | [optional]
**unset_due_date** | **bool** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

10
docs/EditReactionOption.md Normal file
View File

@ -0,0 +1,10 @@
# EditReactionOption
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**content** | **str** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

15
docs/EditReleaseOption.md Normal file
View File

@ -0,0 +1,15 @@
# EditReleaseOption
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**body** | **str** | | [optional]
**draft** | **bool** | | [optional]
**name** | **str** | | [optional]
**prerelease** | **bool** | | [optional]
**tag_name** | **str** | | [optional]
**target_commitish** | **str** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

27
docs/EditRepoOption.md Normal file
View File

@ -0,0 +1,27 @@
# EditRepoOption
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**allow_merge_commits** | **bool** | either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits. `has_pull_requests` must be `true`. | [optional]
**allow_rebase** | **bool** | either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging. `has_pull_requests` must be `true`. | [optional]
**allow_rebase_explicit** | **bool** | either `true` to allow rebase with explicit merge commits (--no-ff), or `false` to prevent rebase with explicit merge commits. `has_pull_requests` must be `true`. | [optional]
**allow_squash_merge** | **bool** | either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging. `has_pull_requests` must be `true`. | [optional]
**archived** | **bool** | set to `true` to archive this repository. | [optional]
**default_branch** | **str** | sets the default branch for this repository. | [optional]
**description** | **str** | a short description of the repository. | [optional]
**external_tracker** | [**ExternalTracker**](ExternalTracker.md) | | [optional]
**external_wiki** | [**ExternalWiki**](ExternalWiki.md) | | [optional]
**has_issues** | **bool** | either `true` to enable issues for this repository or `false` to disable them. | [optional]
**has_pull_requests** | **bool** | either `true` to allow pull requests, or `false` to prevent pull request. | [optional]
**has_wiki** | **bool** | either `true` to enable the wiki for this repository or `false` to disable it. | [optional]
**ignore_whitespace_conflicts** | **bool** | either `true` to ignore whitespace for conflicts, or `false` to not ignore whitespace. `has_pull_requests` must be `true`. | [optional]
**internal_tracker** | [**InternalTracker**](InternalTracker.md) | | [optional]
**name** | **str** | name of the repository | [optional]
**private** | **bool** | either `true` to make the repository private or `false` to make it public. Note: you will get a 422 error if the organization restricts changing repository visibility to organization owners and a non-owner tries to change the value of private. | [optional]
**template** | **bool** | either `true` to make this repository a template or `false` to make it a normal repository | [optional]
**website** | **str** | a URL with more information about the repository. | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

15
docs/EditTeamOption.md Normal file
View File

@ -0,0 +1,15 @@
# EditTeamOption
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**can_create_org_repo** | **bool** | | [optional]
**description** | **str** | | [optional]
**includes_all_repositories** | **bool** | | [optional]
**name** | **str** | |
**permission** | **str** | | [optional]
**units** | **list[str]** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

24
docs/EditUserOption.md Normal file
View File

@ -0,0 +1,24 @@
# EditUserOption
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**active** | **bool** | | [optional]
**admin** | **bool** | | [optional]
**allow_create_organization** | **bool** | | [optional]
**allow_git_hook** | **bool** | | [optional]
**allow_import_local** | **bool** | | [optional]
**email** | **str** | |
**full_name** | **str** | | [optional]
**location** | **str** | | [optional]
**login_name** | **str** | | [optional]
**max_repo_creation** | **int** | | [optional]
**must_change_password** | **bool** | | [optional]
**password** | **str** | | [optional]
**prohibit_login** | **bool** | | [optional]
**source_id** | **int** | | [optional]
**website** | **str** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

12
docs/Email.md Normal file
View File

@ -0,0 +1,12 @@
# Email
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**email** | **str** | | [optional]
**primary** | **bool** | | [optional]
**verified** | **bool** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

12
docs/ExternalTracker.md Normal file
View File

@ -0,0 +1,12 @@
# ExternalTracker
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**external_tracker_format** | **str** | External Issue Tracker URL Format. Use the placeholders {user}, {repo} and {index} for the username, repository name and issue index. | [optional]
**external_tracker_style** | **str** | External Issue Tracker Number Format, either `numeric` or `alphanumeric` | [optional]
**external_tracker_url** | **str** | URL of external issue tracker. | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

10
docs/ExternalWiki.md Normal file
View File

@ -0,0 +1,10 @@
# ExternalWiki
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**external_wiki_url** | **str** | URL of external wiki. | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

17
docs/FileCommitResponse.md Normal file
View File

@ -0,0 +1,17 @@
# FileCommitResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**author** | [**CommitUser**](CommitUser.md) | | [optional]
**committer** | [**CommitUser**](CommitUser.md) | | [optional]
**html_url** | **str** | | [optional]
**message** | **str** | | [optional]
**parents** | [**list[CommitMeta]**](CommitMeta.md) | | [optional]
**sha** | **str** | | [optional]
**tree** | [**CommitMeta**](CommitMeta.md) | | [optional]
**url** | **str** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

12
docs/FileDeleteResponse.md Normal file
View File

@ -0,0 +1,12 @@
# FileDeleteResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**commit** | [**FileCommitResponse**](FileCommitResponse.md) | | [optional]
**content** | **object** | | [optional]
**verification** | [**PayloadCommitVerification**](PayloadCommitVerification.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

12
docs/FileLinksResponse.md Normal file
View File

@ -0,0 +1,12 @@
# FileLinksResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**git** | **str** | | [optional]
**html** | **str** | | [optional]
**_self** | **str** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

12
docs/FileResponse.md Normal file
View File

@ -0,0 +1,12 @@
# FileResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**commit** | [**FileCommitResponse**](FileCommitResponse.md) | | [optional]
**content** | [**ContentsResponse**](ContentsResponse.md) | | [optional]
**verification** | [**PayloadCommitVerification**](PayloadCommitVerification.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

21
docs/GPGKey.md Normal file
View File

@ -0,0 +1,21 @@
# GPGKey
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**can_certify** | **bool** | | [optional]
**can_encrypt_comms** | **bool** | | [optional]
**can_encrypt_storage** | **bool** | | [optional]
**can_sign** | **bool** | | [optional]
**created_at** | **datetime** | | [optional]
**emails** | [**list[GPGKeyEmail]**](GPGKeyEmail.md) | | [optional]
**expires_at** | **datetime** | | [optional]
**id** | **int** | | [optional]
**key_id** | **str** | | [optional]
**primary_key_id** | **str** | | [optional]
**public_key** | **str** | | [optional]
**subkeys** | [**list[GPGKey]**](GPGKey.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

11
docs/GPGKeyEmail.md Normal file
View File

@ -0,0 +1,11 @@
# GPGKeyEmail
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**email** | **str** | | [optional]
**verified** | **bool** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

14
docs/GitBlobResponse.md Normal file
View File

@ -0,0 +1,14 @@
# GitBlobResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**content** | **str** | | [optional]
**encoding** | **str** | | [optional]
**sha** | **str** | | [optional]
**size** | **int** | | [optional]
**url** | **str** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

15
docs/GitEntry.md Normal file
View File

@ -0,0 +1,15 @@
# GitEntry
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**mode** | **str** | | [optional]
**path** | **str** | | [optional]
**sha** | **str** | | [optional]
**size** | **int** | | [optional]
**type** | **str** | | [optional]
**url** | **str** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

12
docs/GitHook.md Normal file
View File

@ -0,0 +1,12 @@
# GitHook
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**content** | **str** | | [optional]
**is_active** | **bool** | | [optional]
**name** | **str** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

12
docs/GitObject.md Normal file
View File

@ -0,0 +1,12 @@
# GitObject
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**sha** | **str** | | [optional]
**type** | **str** | | [optional]
**url** | **str** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

15
docs/GitTreeResponse.md Normal file
View File

@ -0,0 +1,15 @@
# GitTreeResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**page** | **int** | | [optional]
**sha** | **str** | | [optional]
**total_count** | **int** | | [optional]
**tree** | [**list[GitEntry]**](GitEntry.md) | | [optional]
**truncated** | **bool** | | [optional]
**url** | **str** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

16
docs/Hook.md Normal file
View File

@ -0,0 +1,16 @@
# Hook
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**active** | **bool** | | [optional]
**config** | **dict(str, str)** | | [optional]
**created_at** | **datetime** | | [optional]
**events** | **list[str]** | | [optional]
**id** | **int** | | [optional]
**type** | **str** | | [optional]
**updated_at** | **datetime** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

11
docs/Identity.md Normal file
View File

@ -0,0 +1,11 @@
# Identity
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**email** | **str** | | [optional]
**name** | **str** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

11
docs/InlineResponse200.md Normal file
View File

@ -0,0 +1,11 @@
# InlineResponse200
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**data** | [**list[Team]**](Team.md) | | [optional]
**ok** | **bool** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

11
docs/InlineResponse2001.md Normal file
View File

@ -0,0 +1,11 @@
# InlineResponse2001
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**data** | [**list[User]**](User.md) | | [optional]
**ok** | **bool** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

12
docs/InternalTracker.md Normal file
View File

@ -0,0 +1,12 @@
# InternalTracker
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**allow_only_contributors_to_track_time** | **bool** | Let only contributors track time (Built-in issue tracker) | [optional]
**enable_issue_dependencies** | **bool** | Enable dependencies for issues and pull requests (Built-in issue tracker) | [optional]
**enable_time_tracker** | **bool** | Enable time tracking (Built-in issue tracker) | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

30
docs/Issue.md Normal file
View File

@ -0,0 +1,30 @@
# Issue
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**assignee** | [**User**](User.md) | | [optional]
**assignees** | [**list[User]**](User.md) | | [optional]
**body** | **str** | | [optional]
**closed_at** | **datetime** | | [optional]
**comments** | **int** | | [optional]
**created_at** | **datetime** | | [optional]
**due_date** | **datetime** | | [optional]
**html_url** | **str** | | [optional]
**id** | **int** | | [optional]
**labels** | [**list[Label]**](Label.md) | | [optional]
**milestone** | [**Milestone**](Milestone.md) | | [optional]
**number** | **int** | | [optional]
**original_author** | **str** | | [optional]
**original_author_id** | **int** | | [optional]
**pull_request** | [**PullRequestMeta**](PullRequestMeta.md) | | [optional]
**repository** | [**RepositoryMeta**](RepositoryMeta.md) | | [optional]
**state** | [**StateType**](StateType.md) | | [optional]
**title** | **str** | | [optional]
**updated_at** | **datetime** | | [optional]
**url** | **str** | | [optional]
**user** | [**User**](User.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

3809
docs/IssueApi.md Normal file
View File

File diff suppressed because it is too large Load Diff

10
docs/IssueDeadline.md Normal file
View File

@ -0,0 +1,10 @@
# IssueDeadline
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**due_date** | **datetime** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

10
docs/IssueLabelsOption.md Normal file
View File

@ -0,0 +1,10 @@
# IssueLabelsOption
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**labels** | **list[int]** | list of label IDs | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

14
docs/Label.md Normal file
View File

@ -0,0 +1,14 @@
# Label
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**color** | **str** | | [optional]
**description** | **str** | | [optional]
**id** | **int** | | [optional]
**name** | **str** | | [optional]
**url** | **str** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

13
docs/MarkdownOption.md Normal file
View File

@ -0,0 +1,13 @@
# MarkdownOption
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**context** | **str** | Context to render in: body | [optional]
**mode** | **str** | Mode to render in: body | [optional]
**text** | **str** | Text markdown to render in: body | [optional]
**wiki** | **bool** | Is it a wiki page ? in: body | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

13
docs/MergePullRequestOption.md Normal file
View File

@ -0,0 +1,13 @@
# MergePullRequestOption
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**do** | **str** | |
**merge_message_field** | **str** | | [optional]
**merge_title_field** | **str** | | [optional]
**force_merge** | **bool** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

23
docs/MigrateRepoForm.md Normal file
View File

@ -0,0 +1,23 @@
# MigrateRepoForm
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**auth_password** | **str** | | [optional]
**auth_username** | **str** | | [optional]
**clone_addr** | **str** | |
**description** | **str** | | [optional]
**issues** | **bool** | | [optional]
**labels** | **bool** | | [optional]
**milestones** | **bool** | | [optional]
**mirror** | **bool** | | [optional]
**private** | **bool** | | [optional]
**pull_requests** | **bool** | | [optional]
**releases** | **bool** | | [optional]
**repo_name** | **str** | |
**uid** | **int** | |
**wiki** | **bool** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

17
docs/Milestone.md Normal file
View File

@ -0,0 +1,17 @@
# Milestone
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**closed_at** | **datetime** | | [optional]
**closed_issues** | **int** | | [optional]
**description** | **str** | | [optional]
**due_on** | **datetime** | | [optional]
**id** | **int** | | [optional]
**open_issues** | **int** | | [optional]
**state** | [**StateType**](StateType.md) | | [optional]
**title** | **str** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

308
docs/MiscellaneousApi.md Normal file
View File

@ -0,0 +1,308 @@
# giteapython.MiscellaneousApi
All URIs are relative to *http://localhost/api/v1*
Method | HTTP request | Description
------------- | ------------- | -------------
[**get_signing_key**](MiscellaneousApi.md#get_signing_key) | **GET** /signing-key.gpg | Get default signing-key.gpg
[**get_version**](MiscellaneousApi.md#get_version) | **GET** /version | Returns the version of the Gitea application
[**render_markdown**](MiscellaneousApi.md#render_markdown) | **POST** /markdown | Render a markdown document as HTML
[**render_markdown_raw**](MiscellaneousApi.md#render_markdown_raw) | **POST** /markdown/raw | Render raw markdown as HTML
# **get_signing_key**
> str get_signing_key()
Get default signing-key.gpg
### Example
```python
from __future__ import print_function
import time
import giteapython
from giteapython.rest import ApiException
from pprint import pprint
# Configure API key authorization: AccessToken
configuration = giteapython.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 = giteapython.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 = giteapython.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# Configure API key authorization: SudoHeader
configuration = giteapython.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 = giteapython.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: Token
configuration = giteapython.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 = giteapython.MiscellaneousApi(giteapython.ApiClient(configuration))
try:
# Get default signing-key.gpg
api_response = api_instance.get_signing_key()
pprint(api_response)
except ApiException as e:
print("Exception when calling MiscellaneousApi->get_signing_key: %s\n" % e)
```
### Parameters
This endpoint does not need any parameter.
### Return type
**str**
### Authorization
[AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token)
### HTTP request headers
- **Content-Type**: application/json, text/plain
- **Accept**: text/plain
[[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_version**
> ServerVersion get_version()
Returns the version of the Gitea application
### Example
```python
from __future__ import print_function
import time
import giteapython
from giteapython.rest import ApiException
from pprint import pprint
# Configure API key authorization: AccessToken
configuration = giteapython.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 = giteapython.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 = giteapython.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# Configure API key authorization: SudoHeader
configuration = giteapython.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 = giteapython.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: Token
configuration = giteapython.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 = giteapython.MiscellaneousApi(giteapython.ApiClient(configuration))
try:
# Returns the version of the Gitea application
api_response = api_instance.get_version()
pprint(api_response)
except ApiException as e:
print("Exception when calling MiscellaneousApi->get_version: %s\n" % e)
```
### Parameters
This endpoint does not need any parameter.
### Return type
[**ServerVersion**](ServerVersion.md)
### Authorization
[AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [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)
# **render_markdown**
> str render_markdown(body=body)
Render a markdown document as HTML
### Example
```python
from __future__ import print_function
import time
import giteapython
from giteapython.rest import ApiException
from pprint import pprint
# Configure API key authorization: AccessToken
configuration = giteapython.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 = giteapython.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 = giteapython.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# Configure API key authorization: SudoHeader
configuration = giteapython.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 = giteapython.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: Token
configuration = giteapython.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 = giteapython.MiscellaneousApi(giteapython.ApiClient(configuration))
body = giteapython.MarkdownOption() # MarkdownOption | (optional)
try:
# Render a markdown document as HTML
api_response = api_instance.render_markdown(body=body)
pprint(api_response)
except ApiException as e:
print("Exception when calling MiscellaneousApi->render_markdown: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**MarkdownOption**](MarkdownOption.md)| | [optional]
### Return type
**str**
### Authorization
[AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: 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)
# **render_markdown_raw**
> str render_markdown_raw(body)
Render raw markdown as HTML
### Example
```python
from __future__ import print_function
import time
import giteapython
from giteapython.rest import ApiException
from pprint import pprint
# Configure API key authorization: AccessToken
configuration = giteapython.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 = giteapython.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 = giteapython.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# Configure API key authorization: SudoHeader
configuration = giteapython.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 = giteapython.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: Token
configuration = giteapython.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 = giteapython.MiscellaneousApi(giteapython.ApiClient(configuration))
body = 'body_example' # str | Request body to render
try:
# Render raw markdown as HTML
api_response = api_instance.render_markdown_raw(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling MiscellaneousApi->render_markdown_raw: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | **str**| Request body to render |
### Return type
**str**
### Authorization
[AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token)
### HTTP request headers
- **Content-Type**: text/plain
- **Accept**: 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)

582
docs/NotificationApi.md Normal file
View File

@ -0,0 +1,582 @@
# giteapython.NotificationApi
All URIs are relative to *http://localhost/api/v1*
Method | HTTP request | Description
------------- | ------------- | -------------
[**notify_get_list**](NotificationApi.md#notify_get_list) | **GET** /notifications | List users's notification threads
[**notify_get_repo_list**](NotificationApi.md#notify_get_repo_list) | **GET** /repos/{owner}/{repo}/notifications | List users's notification threads on a specific repo
[**notify_get_thread**](NotificationApi.md#notify_get_thread) | **GET** /notifications/threads/{id} | Get notification thread by ID
[**notify_new_available**](NotificationApi.md#notify_new_available) | **GET** /notifications/new | Check if unread notifications exist
[**notify_read_list**](NotificationApi.md#notify_read_list) | **PUT** /notifications | Mark notification threads as read, pinned or unread
[**notify_read_repo_list**](NotificationApi.md#notify_read_repo_list) | **PUT** /repos/{owner}/{repo}/notifications | Mark notification threads as read, pinned or unread on a specific repo
[**notify_read_thread**](NotificationApi.md#notify_read_thread) | **PATCH** /notifications/threads/{id} | Mark notification thread as read by ID
# **notify_get_list**
> list[NotificationThread] notify_get_list(all=all, status_types=status_types, since=since, before=before, page=page, limit=limit)
List users's notification threads
### Example
```python
from __future__ import print_function
import time
import giteapython
from giteapython.rest import ApiException
from pprint import pprint
# Configure API key authorization: AccessToken
configuration = giteapython.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 = giteapython.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 = giteapython.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# Configure API key authorization: SudoHeader
configuration = giteapython.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 = giteapython.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: Token
configuration = giteapython.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 = giteapython.NotificationApi(giteapython.ApiClient(configuration))
all = 'all_example' # str | If true, show notifications marked as read. Default value is false (optional)
status_types = ['status_types_example'] # list[str] | Show notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread & pinned. (optional)
since = '2013-10-20T19:20:30+01:00' # datetime | Only show notifications updated after the given time. This is a timestamp in RFC 3339 format (optional)
before = '2013-10-20T19:20:30+01:00' # datetime | Only show notifications updated before the given time. This is a timestamp in RFC 3339 format (optional)
page = 56 # int | page number of results to return (1-based) (optional)
limit = 56 # int | page size of results, maximum page size is 50 (optional)
try:
# List users's notification threads
api_response = api_instance.notify_get_list(all=all, status_types=status_types, since=since, before=before, page=page, limit=limit)
pprint(api_response)
except ApiException as e:
print("Exception when calling NotificationApi->notify_get_list: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**all** | **str**| If true, show notifications marked as read. Default value is false | [optional]
**status_types** | [**list[str]**](str.md)| Show notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread & pinned. | [optional]
**since** | **datetime**| Only show notifications updated after the given time. This is a timestamp in RFC 3339 format | [optional]
**before** | **datetime**| Only show notifications updated before the given time. This is a timestamp in RFC 3339 format | [optional]
**page** | **int**| page number of results to return (1-based) | [optional]
**limit** | **int**| page size of results, maximum page size is 50 | [optional]
### Return type
[**list[NotificationThread]**](NotificationThread.md)
### Authorization
[AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token)
### HTTP request headers
- **Content-Type**: application/json
- **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)
# **notify_get_repo_list**
> list[NotificationThread] notify_get_repo_list(owner, repo, all=all, status_types=status_types, since=since, before=before, page=page, limit=limit)
List users's notification threads on a specific repo
### Example
```python
from __future__ import print_function
import time
import giteapython
from giteapython.rest import ApiException
from pprint import pprint
# Configure API key authorization: AccessToken
configuration = giteapython.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 = giteapython.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 = giteapython.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# Configure API key authorization: SudoHeader
configuration = giteapython.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 = giteapython.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: Token
configuration = giteapython.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 = giteapython.NotificationApi(giteapython.ApiClient(configuration))
owner = 'owner_example' # str | owner of the repo
repo = 'repo_example' # str | name of the repo
all = 'all_example' # str | If true, show notifications marked as read. Default value is false (optional)
status_types = ['status_types_example'] # list[str] | Show notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread & pinned (optional)
since = '2013-10-20T19:20:30+01:00' # datetime | Only show notifications updated after the given time. This is a timestamp in RFC 3339 format (optional)
before = '2013-10-20T19:20:30+01:00' # datetime | Only show notifications updated before the given time. This is a timestamp in RFC 3339 format (optional)
page = 56 # int | page number of results to return (1-based) (optional)
limit = 56 # int | page size of results, maximum page size is 50 (optional)
try:
# List users's notification threads on a specific repo
api_response = api_instance.notify_get_repo_list(owner, repo, all=all, status_types=status_types, since=since, before=before, page=page, limit=limit)
pprint(api_response)
except ApiException as e:
print("Exception when calling NotificationApi->notify_get_repo_list: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**owner** | **str**| owner of the repo |
**repo** | **str**| name of the repo |
**all** | **str**| If true, show notifications marked as read. Default value is false | [optional]
**status_types** | [**list[str]**](str.md)| Show notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread & pinned | [optional]
**since** | **datetime**| Only show notifications updated after the given time. This is a timestamp in RFC 3339 format | [optional]
**before** | **datetime**| Only show notifications updated before the given time. This is a timestamp in RFC 3339 format | [optional]
**page** | **int**| page number of results to return (1-based) | [optional]
**limit** | **int**| page size of results, maximum page size is 50 | [optional]
### Return type
[**list[NotificationThread]**](NotificationThread.md)
### Authorization
[AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token)
### HTTP request headers
- **Content-Type**: application/json
- **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)
# **notify_get_thread**
> NotificationThread notify_get_thread(id)
Get notification thread by ID
### Example
```python
from __future__ import print_function
import time
import giteapython
from giteapython.rest import ApiException
from pprint import pprint
# Configure API key authorization: AccessToken
configuration = giteapython.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 = giteapython.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 = giteapython.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# Configure API key authorization: SudoHeader
configuration = giteapython.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 = giteapython.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: Token
configuration = giteapython.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 = giteapython.NotificationApi(giteapython.ApiClient(configuration))
id = 'id_example' # str | id of notification thread
try:
# Get notification thread by ID
api_response = api_instance.notify_get_thread(id)
pprint(api_response)
except ApiException as e:
print("Exception when calling NotificationApi->notify_get_thread: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **str**| id of notification thread |
### Return type
[**NotificationThread**](NotificationThread.md)
### Authorization
[AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token)
### HTTP request headers
- **Content-Type**: application/json
- **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)
# **notify_new_available**
> NotificationCount notify_new_available()
Check if unread notifications exist
### Example
```python
from __future__ import print_function
import time
import giteapython
from giteapython.rest import ApiException
from pprint import pprint
# Configure API key authorization: AccessToken
configuration = giteapython.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 = giteapython.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 = giteapython.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# Configure API key authorization: SudoHeader
configuration = giteapython.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 = giteapython.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: Token
configuration = giteapython.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 = giteapython.NotificationApi(giteapython.ApiClient(configuration))
try:
# Check if unread notifications exist
api_response = api_instance.notify_new_available()
pprint(api_response)
except ApiException as e:
print("Exception when calling NotificationApi->notify_new_available: %s\n" % e)
```
### Parameters
This endpoint does not need any parameter.
### Return type
[**NotificationCount**](NotificationCount.md)
### Authorization
[AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [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)
# **notify_read_list**
> notify_read_list(last_read_at=last_read_at, all=all, status_types=status_types, to_status=to_status)
Mark notification threads as read, pinned or unread
### Example
```python
from __future__ import print_function
import time
import giteapython
from giteapython.rest import ApiException
from pprint import pprint
# Configure API key authorization: AccessToken
configuration = giteapython.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 = giteapython.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 = giteapython.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# Configure API key authorization: SudoHeader
configuration = giteapython.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 = giteapython.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: Token
configuration = giteapython.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 = giteapython.NotificationApi(giteapython.ApiClient(configuration))
last_read_at = '2013-10-20T19:20:30+01:00' # datetime | Describes the last point that notifications were checked. Anything updated since this time will not be updated. (optional)
all = 'all_example' # str | If true, mark all notifications on this repo. Default value is false (optional)
status_types = ['status_types_example'] # list[str] | Mark notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread. (optional)
to_status = 'to_status_example' # str | Status to mark notifications as, Defaults to read. (optional)
try:
# Mark notification threads as read, pinned or unread
api_instance.notify_read_list(last_read_at=last_read_at, all=all, status_types=status_types, to_status=to_status)
except ApiException as e:
print("Exception when calling NotificationApi->notify_read_list: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**last_read_at** | **datetime**| Describes the last point that notifications were checked. Anything updated since this time will not be updated. | [optional]
**all** | **str**| If true, mark all notifications on this repo. Default value is false | [optional]
**status_types** | [**list[str]**](str.md)| Mark notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread. | [optional]
**to_status** | **str**| Status to mark notifications as, Defaults to read. | [optional]
### 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), [Token](../README.md#Token)
### HTTP request headers
- **Content-Type**: application/json
- **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)
# **notify_read_repo_list**
> notify_read_repo_list(owner, repo, all=all, status_types=status_types, to_status=to_status, last_read_at=last_read_at)
Mark notification threads as read, pinned or unread on a specific repo
### Example
```python
from __future__ import print_function
import time
import giteapython
from giteapython.rest import ApiException
from pprint import pprint
# Configure API key authorization: AccessToken
configuration = giteapython.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 = giteapython.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 = giteapython.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# Configure API key authorization: SudoHeader
configuration = giteapython.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 = giteapython.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: Token
configuration = giteapython.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 = giteapython.NotificationApi(giteapython.ApiClient(configuration))
owner = 'owner_example' # str | owner of the repo
repo = 'repo_example' # str | name of the repo
all = 'all_example' # str | If true, mark all notifications on this repo. Default value is false (optional)
status_types = ['status_types_example'] # list[str] | Mark notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread. (optional)
to_status = 'to_status_example' # str | Status to mark notifications as. Defaults to read. (optional)
last_read_at = '2013-10-20T19:20:30+01:00' # datetime | Describes the last point that notifications were checked. Anything updated since this time will not be updated. (optional)
try:
# Mark notification threads as read, pinned or unread on a specific repo
api_instance.notify_read_repo_list(owner, repo, all=all, status_types=status_types, to_status=to_status, last_read_at=last_read_at)
except ApiException as e:
print("Exception when calling NotificationApi->notify_read_repo_list: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**owner** | **str**| owner of the repo |
**repo** | **str**| name of the repo |
**all** | **str**| If true, mark all notifications on this repo. Default value is false | [optional]
**status_types** | [**list[str]**](str.md)| Mark notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread. | [optional]
**to_status** | **str**| Status to mark notifications as. Defaults to read. | [optional]
**last_read_at** | **datetime**| Describes the last point that notifications were checked. Anything updated since this time will not be updated. | [optional]
### 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), [Token](../README.md#Token)
### HTTP request headers
- **Content-Type**: application/json
- **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)
# **notify_read_thread**
> notify_read_thread(id, to_status=to_status)
Mark notification thread as read by ID
### Example
```python
from __future__ import print_function
import time
import giteapython
from giteapython.rest import ApiException
from pprint import pprint
# Configure API key authorization: AccessToken
configuration = giteapython.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 = giteapython.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 = giteapython.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# Configure API key authorization: SudoHeader
configuration = giteapython.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 = giteapython.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: Token
configuration = giteapython.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 = giteapython.NotificationApi(giteapython.ApiClient(configuration))
id = 'id_example' # str | id of notification thread
to_status = 'read' # str | Status to mark notifications as (optional) (default to read)
try:
# Mark notification thread as read by ID
api_instance.notify_read_thread(id, to_status=to_status)
except ApiException as e:
print("Exception when calling NotificationApi->notify_read_thread: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **str**| id of notification thread |
**to_status** | **str**| Status to mark notifications as | [optional] [default to read]
### 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), [Token](../README.md#Token)
### HTTP request headers
- **Content-Type**: application/json
- **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)

10
docs/NotificationCount.md Normal file
View File

@ -0,0 +1,10 @@
# NotificationCount
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**new** | **int** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

13
docs/NotificationSubject.md Normal file
View File

@ -0,0 +1,13 @@
# NotificationSubject
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**latest_comment_url** | **str** | | [optional]
**title** | **str** | | [optional]
**type** | **str** | | [optional]
**url** | **str** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

16
docs/NotificationThread.md Normal file
View File

@ -0,0 +1,16 @@
# NotificationThread
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **int** | | [optional]
**pinned** | **bool** | | [optional]
**repository** | [**Repository**](Repository.md) | | [optional]
**subject** | [**NotificationSubject**](NotificationSubject.md) | | [optional]
**unread** | **bool** | | [optional]
**updated_at** | **datetime** | | [optional]
**url** | **str** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

15
docs/OAuth2Application.md Normal file
View File

@ -0,0 +1,15 @@
# OAuth2Application
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**client_id** | **str** | | [optional]
**client_secret** | **str** | | [optional]
**created** | **datetime** | | [optional]
**id** | **int** | | [optional]
**name** | **str** | | [optional]
**redirect_uris** | **list[str]** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

18
docs/Organization.md Normal file
View File

@ -0,0 +1,18 @@
# Organization
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**avatar_url** | **str** | | [optional]
**description** | **str** | | [optional]
**full_name** | **str** | | [optional]
**id** | **int** | | [optional]
**location** | **str** | | [optional]
**repo_admin_change_team_access** | **bool** | | [optional]
**username** | **str** | | [optional]
**visibility** | **str** | | [optional]
**website** | **str** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

3179
docs/OrganizationApi.md Normal file
View File

File diff suppressed because it is too large Load Diff

14
docs/PRBranchInfo.md Normal file
View File

@ -0,0 +1,14 @@
# PRBranchInfo
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**label** | **str** | | [optional]
**ref** | **str** | | [optional]
**repo** | [**Repository**](Repository.md) | | [optional]
**repo_id** | **int** | | [optional]
**sha** | **str** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

19
docs/PayloadCommit.md Normal file
View File

@ -0,0 +1,19 @@
# PayloadCommit
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**added** | **list[str]** | | [optional]
**author** | [**PayloadUser**](PayloadUser.md) | | [optional]
**committer** | [**PayloadUser**](PayloadUser.md) | | [optional]
**id** | **str** | sha1 hash of the commit | [optional]
**message** | **str** | | [optional]
**modified** | **list[str]** | | [optional]
**removed** | **list[str]** | | [optional]
**timestamp** | **datetime** | | [optional]
**url** | **str** | | [optional]
**verification** | [**PayloadCommitVerification**](PayloadCommitVerification.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

14
docs/PayloadCommitVerification.md Normal file
View File

@ -0,0 +1,14 @@
# PayloadCommitVerification
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**payload** | **str** | | [optional]
**reason** | **str** | | [optional]
**signature** | **str** | | [optional]
**signer** | [**PayloadUser**](PayloadUser.md) | | [optional]
**verified** | **bool** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

12
docs/PayloadUser.md Normal file
View File

@ -0,0 +1,12 @@
# PayloadUser
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**email** | **str** | | [optional]
**name** | **str** | Full name of the commit author | [optional]
**username** | **str** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

12
docs/Permission.md Normal file
View File

@ -0,0 +1,12 @@
# Permission
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**admin** | **bool** | | [optional]
**pull** | **bool** | | [optional]
**push** | **bool** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

18
docs/PublicKey.md Normal file
View File

@ -0,0 +1,18 @@
# PublicKey
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**created_at** | **datetime** | | [optional]
**fingerprint** | **str** | | [optional]
**id** | **int** | | [optional]
**key** | **str** | | [optional]
**key_type** | **str** | | [optional]
**read_only** | **bool** | | [optional]
**title** | **str** | | [optional]
**url** | **str** | | [optional]
**user** | [**User**](User.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

36
docs/PullRequest.md Normal file
View File

@ -0,0 +1,36 @@
# PullRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**assignee** | [**User**](User.md) | | [optional]
**assignees** | [**list[User]**](User.md) | | [optional]
**base** | [**PRBranchInfo**](PRBranchInfo.md) | | [optional]
**body** | **str** | | [optional]
**closed_at** | **datetime** | | [optional]
**comments** | **int** | | [optional]
**created_at** | **datetime** | | [optional]
**diff_url** | **str** | | [optional]
**due_date** | **datetime** | | [optional]
**head** | [**PRBranchInfo**](PRBranchInfo.md) | | [optional]
**html_url** | **str** | | [optional]
**id** | **int** | | [optional]
**labels** | [**list[Label]**](Label.md) | | [optional]
**merge_base** | **str** | | [optional]
**merge_commit_sha** | **str** | | [optional]
**mergeable** | **bool** | | [optional]
**merged** | **bool** | | [optional]
**merged_at** | **datetime** | | [optional]
**merged_by** | [**User**](User.md) | | [optional]
**milestone** | [**Milestone**](Milestone.md) | | [optional]
**number** | **int** | | [optional]
**patch_url** | **str** | | [optional]
**state** | [**StateType**](StateType.md) | | [optional]
**title** | **str** | | [optional]
**updated_at** | **datetime** | | [optional]
**url** | **str** | | [optional]
**user** | [**User**](User.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Some files were not shown because too many files have changed in this diff Show More