Skip to content

GitDataAI/jzfs-client-python

BranchesTags

Repository files navigation

jiaozifs-api

jiaozifs HTTP API

This Python package is automatically generated by the Swagger Codegen project:

  • API version: 1.0.0
  • Package version: 1.0.0
  • Build package: io.swagger.codegen.v3.generators.python.PythonClientCodegen

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

If the python package is hosted on Github, you can install directly from Github

pip install git+https://github.com/GitDataAI/jiaozifs_client_py.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GitDataAI/jiaozifs_client_py.git)

Then import the package:

import jiaozifs_client

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import jiaozifs_client

Getting Started

Please follow the installation procedure and then run the following:

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.AksksApi(jiaozifs_client.ApiClient(configuration))
description = 'description_example' # str |  (optional)

try:
    # create aksk
    api_response = api_instance.create_aksk(description=description)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AksksApi->create_aksk: %s\n" % e)
# 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.AksksApi(jiaozifs_client.ApiClient(configuration))
id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str |  (optional)
access_key = 'access_key_example' # str |  (optional)

try:
    # delete aksk
    api_instance.delete_aksk(id=id, access_key=access_key)
except ApiException as e:
    print("Exception when calling AksksApi->delete_aksk: %s\n" % e)
# 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.AksksApi(jiaozifs_client.ApiClient(configuration))
id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str |  (optional)
access_key = 'access_key_example' # str |  (optional)

try:
    # get aksk
    api_response = api_instance.get_aksk(id=id, access_key=access_key)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AksksApi->get_aksk: %s\n" % e)
# 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.AksksApi(jiaozifs_client.ApiClient(configuration))
after = 789 # int | return items after this value (optional)
amount = 100 # int | how many items to return (optional) (default to 100)

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

Documentation for API Endpoints

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

Class Method HTTP request Description
AksksApi create_aksk POST /users/aksk create aksk
AksksApi delete_aksk DELETE /users/aksk delete aksk
AksksApi get_aksk GET /users/aksk get aksk
AksksApi list_aksks GET /users/aksks list aksks
AuthApi get_user_info GET /users/user get information of the currently logged-in user
AuthApi login POST /auth/login perform a login
AuthApi logout POST /auth/logout perform a logout
AuthApi refresh_token GET /users/refreshtoken refresh token for more time
AuthApi register POST /users/register perform user registration
BranchesApi create_branch POST /repos/{owner}/{repository}/branch create branch
BranchesApi delete_branch DELETE /repos/{owner}/{repository}/branch delete branch
BranchesApi get_branch GET /repos/{owner}/{repository}/branch get branch
BranchesApi list_branches GET /repos/{owner}/{repository}/branches list branches
CommitApi compare_commit GET /repos/{owner}/{repository}/compare/{basehead} compare two commit
CommitApi get_commit_changes GET /repos/{owner}/{repository}/changes/{commit_id} get changes in commit
CommitApi get_entries_in_ref GET /repos/{owner}/{repository}/contents list entries in ref
CommonApi get_setup_state GET /setup check if jiaozifs setup
CommonApi get_version GET /version return program and runtime version
GroupApi list_repo_group GET /groups/repo list groups for repo
ListMembersApi list_members GET /repos/{owner}/{repository}/members get list of members in repository
MemberApi invite_member POST /repos/{owner}/{repository}/member/invite invite member
MemberApi revoke_member DELETE /repos/{owner}/{repository}/member Revoke member in repository
MemberApi update_member_group POST /repos/{owner}/{repository}/member update member by user id and change group role
MergerequestApi create_merge_request POST /repos/{owner}/{repository}/mergerequest create merge request
MergerequestApi get_merge_request GET /repos/{owner}/{repository}/mergerequest/{mrSeq} get merge request
MergerequestApi list_merge_requests GET /repos/{owner}/{repository}/mergerequest get list of merge request in repository
MergerequestApi merge POST /repos/{owner}/{repository}/mergerequest/{mrSeq}/merge merge a mergerequest
MergerequestApi update_merge_request POST /repos/{owner}/{repository}/mergerequest/{mrSeq} update merge request
ObjectsApi delete_object DELETE /object/{owner}/{repository} delete object. Missing objects will not return a NotFound error.
ObjectsApi get_files GET /object/{owner}/{repository}/files get files by pattern
ObjectsApi get_object GET /object/{owner}/{repository} get object content
ObjectsApi head_object HEAD /object/{owner}/{repository} check if object exists
ObjectsApi upload_object POST /object/{owner}/{repository}
RepoApi change_visible POST /repos/{owner}/{repository}/visible change repository visible(true for public, false for private)
RepoApi create_repository POST /users/repos create repository
RepoApi delete_repository DELETE /repos/{owner}/{repository} delete repository
RepoApi get_commits_in_ref GET /repos/{owner}/{repository}/commits get commits in ref
RepoApi get_repository GET /repos/{owner}/{repository} get repository
RepoApi list_public_repository GET /repos/public list public repository in all system
RepoApi list_repository GET /users/{owner}/repos list repository in specific owner
RepoApi list_repository_of_authenticated_user GET /users/repos list repository
RepoApi update_repository POST /repos/{owner}/{repository} update repository
WipApi commit_wip POST /wip/{owner}/{repository}/commit commit working in process to branch
WipApi delete_wip DELETE /wip/{owner}/{repository} remove working in process
WipApi get_wip GET /wip/{owner}/{repository} get working in process
WipApi get_wip_changes GET /wip/{owner}/{repository}/changes get working in process changes
WipApi list_wip GET /wip/{owner}/{repository}/list list wip in specific project and user
WipApi revert_wip_changes POST /wip/{owner}/{repository}/revert revert changes in working in process, empty path will revert all
WipApi update_wip POST /wip/{owner}/{repository} update wip

Documentation For Models

Documentation For Authorization

access_key_id

  • Type: API key
  • API key parameter name: JiaozifsAccessKeyId
  • Location: URL query string

basic_auth

  • Type: HTTP basic authentication

cookie_auth

  • Type: API key
  • API key parameter name: internal_auth_session
  • Location: URL query string

jwt_token

signature

  • Type: API key
  • API key parameter name: Signature
  • Location: URL query string

signature_method

  • Type: API key
  • API key parameter name: SignatureMethod
  • Location: URL query string

signature_version

  • Type: API key
  • API key parameter name: SignatureVersion
  • Location: URL query string

timestamp

  • Type: API key
  • API key parameter name: Timestamp
  • Location: URL query string

Author

About

jiaozifs client for python

Resources

Readme

License

Apache-2.0 license
Activity
Custom properties

Stars

0 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Languages