jiaozifs_client.RepoApi

All URIs are relative to http://localhost:34913/api/v1

Method	HTTP request	Description
change_visible	POST /repos/{owner}/{repository}/visible	change repository visible(true for public, false for private)
create_repository	POST /users/repos	create repository
delete_repository	DELETE /repos/{owner}/{repository}	delete repository
get_commits_in_ref	GET /repos/{owner}/{repository}/commits	get commits in ref
get_repository	GET /repos/{owner}/{repository}	get repository
list_public_repository	GET /repos/public	list public repository in all system
list_repository	GET /users/{owner}/repos	list repository in specific owner
list_repository_of_authenticated_user	GET /users/repos	list repository
update_repository	POST /repos/{owner}/{repository}	update repository

change_visible

change_visible(owner, repository, visible)

change repository visible(true for public, false for private)

Example

from __future__ import print_function
import time
import jiaozifs_client
from jiaozifs_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic_auth
configuration = jiaozifs_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# Configure API key authorization: cookie_auth
configuration = jiaozifs_client.Configuration()
configuration.api_key['internal_auth_session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['internal_auth_session'] = 'Bearer'

# create an instance of the API class
api_instance = jiaozifs_client.RepoApi(jiaozifs_client.ApiClient(configuration))
owner = 'owner_example' # str | 
repository = 'repository_example' # str | 
visible = true # bool | 

try:
    # change repository visible(true for public, false for private)
    api_instance.change_visible(owner, repository, visible)
except ApiException as e:
    print("Exception when calling RepoApi->change_visible: %s\n" % e)

Parameters

Name	Type	Description	Notes
owner	str
repository	str
visible	bool

Return type

void (empty response body)

Authorization

basic_auth, cookie_auth, jwt_token

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

create_repository

Repository create_repository(body)

create repository

Example

from __future__ import print_function
import time
import jiaozifs_client
from jiaozifs_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic_auth
configuration = jiaozifs_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# Configure API key authorization: cookie_auth
configuration = jiaozifs_client.Configuration()
configuration.api_key['internal_auth_session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['internal_auth_session'] = 'Bearer'

# create an instance of the API class
api_instance = jiaozifs_client.RepoApi(jiaozifs_client.ApiClient(configuration))
body = jiaozifs_client.CreateRepository() # CreateRepository | 

try:
    # create repository
    api_response = api_instance.create_repository(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RepoApi->create_repository: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	CreateRepository

Return type

Repository

Authorization

basic_auth, cookie_auth, jwt_token

HTTP request headers

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

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

delete_repository

delete_repository(owner, repository, is_clean_data=is_clean_data)

delete repository

Example

from __future__ import print_function
import time
import jiaozifs_client
from jiaozifs_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic_auth
configuration = jiaozifs_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# Configure API key authorization: cookie_auth
configuration = jiaozifs_client.Configuration()
configuration.api_key['internal_auth_session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['internal_auth_session'] = 'Bearer'

# create an instance of the API class
api_instance = jiaozifs_client.RepoApi(jiaozifs_client.ApiClient(configuration))
owner = 'owner_example' # str | 
repository = 'repository_example' # str | 
is_clean_data = true # bool |  (optional)

try:
    # delete repository
    api_instance.delete_repository(owner, repository, is_clean_data=is_clean_data)
except ApiException as e:
    print("Exception when calling RepoApi->delete_repository: %s\n" % e)

Parameters

Name	Type	Notes
owner	str
repository	str
is_clean_data	bool	[optional]

Return type

void (empty response body)

Authorization

basic_auth, cookie_auth, jwt_token

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

get_commits_in_ref

list[Commit] get_commits_in_ref(owner, repository, after=after, amount=amount, ref_name=ref_name)

get commits in ref

Example

from __future__ import print_function
import time
import jiaozifs_client
from jiaozifs_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic_auth
configuration = jiaozifs_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# Configure API key authorization: cookie_auth
configuration = jiaozifs_client.Configuration()
configuration.api_key['internal_auth_session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['internal_auth_session'] = 'Bearer'

# create an instance of the API class
api_instance = jiaozifs_client.RepoApi(jiaozifs_client.ApiClient(configuration))
owner = 'owner_example' # str | 
repository = 'repository_example' # str | 
after = 789 # int | return items after this value (optional)
amount = 100 # int | how many items to return (optional) (default to 100)
ref_name = 'ref_name_example' # str | ref(branch/tag) name (optional)

try:
    # get commits in ref
    api_response = api_instance.get_commits_in_ref(owner, repository, after=after, amount=amount, ref_name=ref_name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RepoApi->get_commits_in_ref: %s\n" % e)

Parameters

Name	Type	Description	Notes
owner	str
repository	str
after	int	return items after this value	[optional]
amount	int	how many items to return	[optional] [default to 100]
ref_name	str	ref(branch/tag) name	[optional]

Return type

list[Commit]

Authorization

basic_auth, cookie_auth, jwt_token

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

get_repository

Repository get_repository(owner, repository)

get repository

Example

from __future__ import print_function
import time
import jiaozifs_client
from jiaozifs_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic_auth
configuration = jiaozifs_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# Configure API key authorization: cookie_auth
configuration = jiaozifs_client.Configuration()
configuration.api_key['internal_auth_session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['internal_auth_session'] = 'Bearer'

# create an instance of the API class
api_instance = jiaozifs_client.RepoApi(jiaozifs_client.ApiClient(configuration))
owner = 'owner_example' # str | 
repository = 'repository_example' # str | 

try:
    # get repository
    api_response = api_instance.get_repository(owner, repository)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RepoApi->get_repository: %s\n" % e)

Parameters

Name	Type	Description	Notes
owner	str
repository	str

Return type

Repository

Authorization

basic_auth, cookie_auth, jwt_token

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

list_public_repository

RepositoryList list_public_repository(prefix=prefix, after=after, amount=amount)

list public repository in all system

Example

from __future__ import print_function
import time
import jiaozifs_client
from jiaozifs_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic_auth
configuration = jiaozifs_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# Configure API key authorization: cookie_auth
configuration = jiaozifs_client.Configuration()
configuration.api_key['internal_auth_session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['internal_auth_session'] = 'Bearer'

# create an instance of the API class
api_instance = jiaozifs_client.RepoApi(jiaozifs_client.ApiClient(configuration))
prefix = 'prefix_example' # str | return items prefixed with this value (optional)
after = 789 # int | return items after this value (optional)
amount = 100 # int | how many items to return (optional) (default to 100)

try:
    # list public repository in all system
    api_response = api_instance.list_public_repository(prefix=prefix, after=after, amount=amount)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RepoApi->list_public_repository: %s\n" % e)

Parameters

Name	Type	Description	Notes
prefix	str	return items prefixed with this value	[optional]
after	int	return items after this value	[optional]
amount	int	how many items to return	[optional] [default to 100]

Return type

RepositoryList

Authorization

basic_auth, cookie_auth, jwt_token

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

list_repository

RepositoryList list_repository(owner, prefix=prefix, after=after, amount=amount)

list repository in specific owner

Example

from __future__ import print_function
import time
import jiaozifs_client
from jiaozifs_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic_auth
configuration = jiaozifs_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# Configure API key authorization: cookie_auth
configuration = jiaozifs_client.Configuration()
configuration.api_key['internal_auth_session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['internal_auth_session'] = 'Bearer'

# create an instance of the API class
api_instance = jiaozifs_client.RepoApi(jiaozifs_client.ApiClient(configuration))
owner = 'owner_example' # str | 
prefix = 'prefix_example' # str | return items prefixed with this value (optional)
after = 789 # int | return items after this value (optional)
amount = 100 # int | how many items to return (optional) (default to 100)

try:
    # list repository in specific owner
    api_response = api_instance.list_repository(owner, prefix=prefix, after=after, amount=amount)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RepoApi->list_repository: %s\n" % e)

Parameters

Name	Type	Description	Notes
owner	str
prefix	str	return items prefixed with this value	[optional]
after	int	return items after this value	[optional]
amount	int	how many items to return	[optional] [default to 100]

Return type

RepositoryList

Authorization

basic_auth, cookie_auth, jwt_token

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

list_repository_of_authenticated_user

RepositoryList list_repository_of_authenticated_user(prefix=prefix, after=after, amount=amount)

list repository

Example

from __future__ import print_function
import time
import jiaozifs_client
from jiaozifs_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic_auth
configuration = jiaozifs_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# Configure API key authorization: cookie_auth
configuration = jiaozifs_client.Configuration()
configuration.api_key['internal_auth_session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['internal_auth_session'] = 'Bearer'

# create an instance of the API class
api_instance = jiaozifs_client.RepoApi(jiaozifs_client.ApiClient(configuration))
prefix = 'prefix_example' # str | return items prefixed with this value (optional)
after = 789 # int | return items after this value (optional)
amount = 100 # int | how many items to return (optional) (default to 100)

try:
    # list repository
    api_response = api_instance.list_repository_of_authenticated_user(prefix=prefix, after=after, amount=amount)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RepoApi->list_repository_of_authenticated_user: %s\n" % e)

Parameters

Name	Type	Description	Notes
prefix	str	return items prefixed with this value	[optional]
after	int	return items after this value	[optional]
amount	int	how many items to return	[optional] [default to 100]

Return type

RepositoryList

Authorization

basic_auth, cookie_auth, jwt_token

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

update_repository

update_repository(body, owner, repository)

update repository

Example

from __future__ import print_function
import time
import jiaozifs_client
from jiaozifs_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic_auth
configuration = jiaozifs_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# Configure API key authorization: cookie_auth
configuration = jiaozifs_client.Configuration()
configuration.api_key['internal_auth_session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['internal_auth_session'] = 'Bearer'

# create an instance of the API class
api_instance = jiaozifs_client.RepoApi(jiaozifs_client.ApiClient(configuration))
body = jiaozifs_client.UpdateRepository() # UpdateRepository | 
owner = 'owner_example' # str | 
repository = 'repository_example' # str | 

try:
    # update repository
    api_instance.update_repository(body, owner, repository)
except ApiException as e:
    print("Exception when calling RepoApi->update_repository: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	UpdateRepository
owner	str
repository	str

Return type

void (empty response body)

Authorization

basic_auth, cookie_auth, jwt_token

HTTP request headers

Content-Type: application/json
Accept: Not defined

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

Files

RepoApi.md

Latest commit

History

RepoApi.md

File metadata and controls

jiaozifs_client.RepoApi

change_visible

Example

Parameters

Return type

Authorization

HTTP request headers

create_repository

Example

Parameters

Return type

Authorization

HTTP request headers

delete_repository

Example

Parameters

Return type

Authorization

HTTP request headers

get_commits_in_ref

Example

Parameters

Return type

Authorization

HTTP request headers

get_repository

Example

Parameters

Return type

Authorization

HTTP request headers

list_public_repository

Example

Parameters

Return type

Authorization

HTTP request headers

list_repository

Example

Parameters

Return type

Authorization

HTTP request headers

list_repository_of_authenticated_user

Example

Parameters

Return type

Authorization

HTTP request headers

update_repository

Example

Parameters

Return type

Authorization

HTTP request headers