Summarize Push

GET /github-intake/summarisePush/:githubIntakeId

Summarize Push

cURL

curl --request GET \
  --url https://www.api.baselink.tech/github-intake/summarisePush/:githubIntakeId \
  --header 'bearer: <api-key>'

200

{
  "summary": {},
  "summary.commitCount": 123,
  "summary.filesChanged": 123,
  "summary.additions": 123,
  "summary.deletions": 123,
  "summary.description": "<string>",
  "summary.commits": [
    {}
  ],
  "summary.commits[].sha": "<string>",
  "summary.commits[].message": "<string>",
  "summary.commits[].author": "<string>"
}

Generate a summary of push data for a specific GitHub intake record.

summary · object

The generated push summary.

summary.commitCount · number

The number of commits in the push.

summary.filesChanged · number

The number of files changed in the push.

summary.additions · number

The number of lines added.

summary.deletions · number

The number of lines deleted.

summary.description · string

A human-readable summary of the push changes.

summary.commits · array

Array of commit summaries.

summary.commits[].sha · string

The SHA hash of the commit.

summary.commits[].message · string

The commit message.

summary.commits[].author · string

The commit author.