Interface CommitsParams

Query parameters accepted by GET /rest/api/latest/projects/{key}/repos/{slug}/commits.

See

https://developer.atlassian.com/server/bitbucket/rest/v819/api-group-repository/#api-api-latest-projects-projectkey-repos-repositoryslug-commits-get

interface CommitsParams {
    followRenames?: boolean;
    ignoreMissing?: boolean;
    limit?: number;
    merges?: "include" | "exclude" | "only";
    path?: string;
    since?: string;
    start?: number;
    until?: string;
}

Hierarchy (View Summary)

Properties

followRenames? ignoreMissing? limit? merges? path? since? start? until?

Properties

OptionalfollowRenames

followRenames?: boolean

Follow file renames when filtering by path

OptionalignoreMissing

ignoreMissing?: boolean

Silently ignore missing commits referenced by since or until

Optionallimit

limit?: number

Maximum number of results to return per page. Bitbucket default is 25, maximum is 1000.

Optionalmerges

merges?: "include" | "exclude" | "only"

How to handle merge commits

Optionalpath

path?: string

Filter commits that touch this file path

Optionalsince

since?: string

Exclude commits reachable from this commit ID or ref

Optionalstart

start?: number

0-based index of the first result to return. Use nextPageStart from the previous response to paginate forward.

Optionaluntil

until?: string

The commit ID or ref to list commits reachable from. Defaults to the repository's default branch.

Settings

Member Visibility

On This Page

Properties