Skip to main content

List pull request creators​

Querying the pull request creators list in a given repository.

This API provides multiple ways to sort the query results, for example:

  • sort=prs-desc (Default): Sorted in descending order based on prs field (the number of PRs they have contributed), meaning that the contributor with the most PRs is at the top.
  • sort=first_pr_merged_at-desc: Sorted in descending order based on first_pr_merged_at field (the time of their first merged PR), which means you can got a list of new code contributors of the repository.
Path Parameters
    owner string required

    The owner of the repo.

    Example: pingcap
    repo string required

    The name of the repo.

    Example: tidb
Query Parameters
    sort string

    Possible values: [login, prs, prs-desc, first_pr_opened_at, first_pr_opened_at-desc, first_pr_merged_at, first_pr_merged_at-desc]

    Default value: prs-desc

    Specify the field by which to sort the pull request creators list (values with a -desc suffix indicate descending sorting)

    exclude_bots boolean

    Default value: true

    Whether to exclude robot accounts (includes GitHub App and normal users whose username matches the pattern, for example: ti-chi-bot).

    page integer

    Default value: 1

    Page number of the results to fetch.

    page_size integer

    Default value: 30

    The number of results per page (max 100).

Responses

Default Response

Schema
    type string required

    Possible values: [sql_endpoint]

    The type of the endpoint.

    data object required
    columns object[] required
  • Array [
    • col string required

    The name of the column in the query result.

    data_type string required

    Possible values: [CHAR, BIGINT, DECIMAL, INT, UNSIGNED BIGINT, TINYINT, TIMESTAMP, TEXT, VARCHAR, DATETIME, DOUBLE, FLOAT, DATE, TIME, YEAR, MEDIUMINT, SMALLINT, BIT, BINARY, VARBINARY, JSON, ENUM, SET, TINYTEXT, MEDIUMTEXT, LONGTEXT, TINYBLOB, MEDIUMBLOB, BLOB, LONGBLOB]

    The data type of the column.

    nullable boolean required

    Whether the column is nullable.

  • ]
    • rows object[] required
  • Array [
    • id string

    The ID of the pull request creator

    login string

    The login (username) of the pull request creator

    name string

    The name of the pull request creator

    prs string

    The number of pull requests created by the pull request creator

    first_pr_opened_at string

    The date of the first pull request created by the pull request creator

    first_pr_merged_at string

    The date of the first merged pull request be merged into the repository

  • ]
    • result object required
    code number

    The code of the response.

    message string

    The message of the response.

    start_ms number

    The start time of the query in milliseconds.

    end_ms number

    The end time of the query in milliseconds.

    latency string

    The latency of the query.

    row_count number

    The number of rows in the query result.

    row_affect number

    The number of rows affected by the query.

    limit number

    The maximum number of rows in the query result.

    databases string[]

    The databases used in the query.

    property name* any
Loading...