Logo DataHubClient

MergeRequestsApi Type

Client for GitLab merge request operations. See the .

Constructors

Constructor Description

MergeRequestsApi(baseUrl, auth, http)

Full Usage: MergeRequestsApi(baseUrl, auth, http)

Parameters:
Returns: MergeRequestsApi
baseUrl : string
auth : Authentication
http : IHttpClient
Returns: MergeRequestsApi

Instance members

Instance member Description

this.CloseAsync

Full Usage: this.CloseAsync

Parameters:
    projectId : int - The project identifier.
    iid : int - The project-local merge request number.

Returns: Async<MergeRequest>

Closes a merge request.

projectId : int

The project identifier.

iid : int

The project-local merge request number.

Returns: Async<MergeRequest>

this.CreateAsync

Full Usage: this.CreateAsync

Parameters:
    projectId : int - The project identifier.
    sourceBranch : string - The branch containing proposed changes.
    targetBranch : string - The branch that should receive the changes.
    title : string - The merge request title.
    ?description : string - Optional merge request description.

Returns: Async<MergeRequest>

Creates a new merge request.

projectId : int

The project identifier.

sourceBranch : string

The branch containing proposed changes.

targetBranch : string

The branch that should receive the changes.

title : string

The merge request title.

?description : string

Optional merge request description.

Returns: Async<MergeRequest>

this.CreateNoteAsync

Full Usage: this.CreateNoteAsync

Parameters:
    projectId : int - The project identifier.
    iid : int - The project-local merge request number.
    body : string - The note text.

Returns: Async<Note>

Creates a note on a merge request.

projectId : int

The project identifier.

iid : int

The project-local merge request number.

body : string

The note text.

Returns: Async<Note>

this.GetAsync

Full Usage: this.GetAsync

Parameters:
    projectId : int - The project identifier.
    iid : int - The project-local merge request number.

Returns: Async<MergeRequest>

Gets a single merge request by project-local merge request number.

projectId : int

The project identifier.

iid : int

The project-local merge request number.

Returns: Async<MergeRequest>

this.ListAsync

Full Usage: this.ListAsync

Parameters:
    projectId : int - The project identifier.
    ?state : string - Optional state filter, such as opened, merged, or closed.

Returns: Async<ResizeArray<MergeRequest>>

Lists merge requests for a project.

projectId : int

The project identifier.

?state : string

Optional state filter, such as opened, merged, or closed.

Returns: Async<ResizeArray<MergeRequest>>

this.NotesAsync

Full Usage: this.NotesAsync

Parameters:
    projectId : int - The project identifier.
    iid : int - The project-local merge request number.

Returns: Async<ResizeArray<Note>>

Lists notes on a merge request.

projectId : int

The project identifier.

iid : int

The project-local merge request number.

Returns: Async<ResizeArray<Note>>

this.UpdateAsync

Full Usage: this.UpdateAsync

Parameters:
    projectId : int - The project identifier.
    iid : int - The project-local merge request number.
    ?title : string - Optional replacement title.
    ?description : string - Optional replacement description.
    ?stateEvent : string - Optional state transition, such as close or reopen.

Returns: Async<MergeRequest>

Updates a merge request.

projectId : int

The project identifier.

iid : int

The project-local merge request number.

?title : string

Optional replacement title.

?description : string

Optional replacement description.

?stateEvent : string

Optional state transition, such as close or reopen.

Returns: Async<MergeRequest>

Type something to start searching.