xia_engine_gitlab.engine_snippet.GitlabSnippetEngineClient

class xia_engine_gitlab.engine_snippet.GitlabSnippetEngineClient(api_host: str, api_token: str, **kwargs)

Bases: GitlabEngineClient

__init__(api_host: str, api_token: str, **kwargs)

Methods

__init__(api_host, api_token, **kwargs)
check_file_exists(project_id, branch, path)
check_response(response)
commit_file(project_id, branch, path, ...[, ...])
create_branch(project_id, branch_name, ref)
create_merge_request(project_id, title, ...)
create_snippet(snippet_name, snippet_content)	Create snippet content
delete_branch(project_id, branch_name)
delete_snippet(snippet_name)	Delete snippet
get_branch_info(project_id, branch_name)
get_default_branch_from_name(api_endpoint, ...)	Get default branch name from the given name
get_file_content(project_id, branch, path[, ...])	Get file content
get_group_id_from_name(api_endpoint, ...)
get_issue_branch_name(issue_name, issue_iid)
get_issue_commit_name(issue_name, issue_iid)
get_issue_iid_from_name(api_endpoint, ...)
get_issue_mr_name(issue_name, issue_iid)
get_merge_request_commits(project_id, title)
get_milestone_branch_name(milestone_name)
get_milestone_id_from_name(api_endpoint, ...)
get_milestone_info_from_issue(api_endpoint, ...)
get_milestone_mr_name(milestone_name)
get_mr_iid_from_branch(api_endpoint, ...[, ...])
get_mr_iid_from_name(api_endpoint, ...)
get_mr_iid_from_title(api_endpoint, ...)
get_project_id_from_name(api_endpoint, ...)
get_snippet(snippet_name)	Get snippet page content
get_snippet_from_name(api_endpoint, ...)
merge_merge_request(project_id, title[, ...])
pipeline_exists(api_endpoint, api_token, ...)
rebase_merge_request(project_id, title)
split_header_body(full_content)
update_snippet(snippet_name, snippet_content)	Update snippet page

create_snippet(snippet_name: str, snippet_content: str)

Create snippet content

Parameters

• snippet_name – Project name

• snippet_content – database content

delete_snippet(snippet_name: str)

Delete snippet

Parameters

snippet_name – Snippet name

classmethod get_default_branch_from_name(api_endpoint: str, api_token: str, project_id: int) → str

Get default branch name from the given name

Parameters

• api_endpoint –

• api_token –

• project_id –

Returns:

get_file_content(project_id, branch: str, path: str, with_encoding: bool = False)

Get file content

Returns

when with_encoding is true and the content is binary, will return base64 string instead binary result

get_snippet(snippet_name: str)

Get snippet page content

Parameters

snippet_name – Snippet name

update_snippet(snippet_name: str, snippet_content: str)

Update snippet page

Parameters

• snippet_name – Project name

• snippet_content – database content