Skip to content

Research the number of necessary API calls

Task description

Figure out in detail how many API calls are necessary per project and group to retrieve the statistics that we want. You may ignore lines of code for this issue as that is covered in #74. Statistics that must be included are:

  • Number of MRs created, closed, and merged
  • Number of issues created and closed
  • Number of MR comments
  • Length of MR comments
  • Number of issue comments
  • Number of MR approvals
  • Number of MRs assigned
  • MR labels
  • Issue labels
  • Issue weights
  • Number of commits
  • Test coverage
  • Issue time tracking
  • Number of issues assigned
  • Programming languages used
  • Epics created and closed (group only)
  • Number of epic comments (group only)
  • Every statistic per timestamp (if applicable)

For a group, all repository-level statistics should be aggregated.

It is not necessary to implement this. For now, only focus on GitLab's REST API.

Deliverables

  • For group and repository level, a table with three columns: data point(s), endpoint, and #calls.
  • The data point(s) column contains all types of statistic we can get in one go.
  • The endpoint column contains the API endpoint that provides that information.
  • The #calls column contains a formula of the number of API calls necessary in terms of all variables
  • Example (probably not accurate)
    • data point(s): Number of MR comments, length of MR comments
    • endpoint: /project/:projectId/merge_requests/:mergeRequestIId/notes
    • #calls: 2m where m is the number of merge requests

Resources

Edited by Ruben Backx