Bitbucket Data Center API Client
    Preparing search index...

    Interface CompareParams

    Query parameters shared by the compare endpoints (GET /rest/api/latest/projects/{key}/repos/{slug}/compare/…).

    from/to accept a branch, tag, or commit SHA. When comparing across a fork, fromRepo identifies the source repository (its numeric id or '{projectKey}/{repoSlug}').

    interface CompareParams {
        from?: string;
        fromRepo?: string;
        limit?: number;
        start?: number;
        to?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    from? fromRepo? limit? start? to?

    Properties

    from?: string

    Source ref or commit of the comparison

    fromRepo?: string

    Source repository when comparing across forks

    limit?: number

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

    start?: number

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

    to?: string

    Target ref or commit of the comparison

    Settings

    Member Visibility

    On This Page

    Properties