-
Notifications
You must be signed in to change notification settings - Fork 0
Public API
This document is a draft of our public API. Please refer to issue #4 for general discussion, or to issues #1, #2 and #3 for discussions of specific features provided by the API.
The public API is read-only, so the only HTTP verb supported is GET
; everything else results in 400 Bad Request
.
Empty fields might be omitted.
/organizations/codingteam/news
Body:
[ { "subject": "issue"
, "action": "assigned|unassigned|labeled|unlabeled|opened|closed|reopened|commented_on"
, "issue_url": "https://github.com/orgs/codingteam/world-domination/issues/1"
, "issue_title": "An awful lot of the code is still unwritten"
, "user": "Minoru"
, "user_url": "https://github.com/Minoru"
, "assignee": "ForNeVeR"
, "assignee_url": "https://github.com/ForNeVeR"
, "label": "bug|feature etc."
, "status": "open|closed|reopened"
, "datetime": "2015-04-17T01:23:45Z"
}
, { "subject": "pull_request"
, "action": "assigned|unassigned|labeled|unlabeled|opened|closed|reopened"
, "pull_request_url": "https://github.com/orgs/codingteam/world-domination/pulls/1"
, "pull_request_title": "All the Erlang code ever written, in a nice tar.gz.bz2.xz.zip.rar.7z bundle"
, "user": "Minoru"
, "user_url": "https://github.com/Minoru"
, "merged": false
, "datetime": "2015-04-17T01:23:45Z"
}
, { "subject": "push"
, "user": "Minoru"
, "user_url": "https://github.com/Minoru"
, "repo": "world-domination"
, "repo_url": "https://github.com/orgs/codingteam/world-domination"
, "branch": "develop"
, "count": "42"
, "datetime": "2015-04-17T01:23:45Z"
} ]
assignee
and assignee_url
are only present when action
is assigned
or unassigned
.
label
is only present when action
is labeled
or unlabeled
.
status
is only present when action
is opened
, closed
or reopened
.
merged
is only present if action
is closed
.
Body: empty
/organizations/codingteam/activity
For each user and for each repo, provides average number of commits pushed today, in the last 7 days (week) and last 30 days (month).
[ { "type": "user_stats"
, "stats": [ {
"user": "Minoru"
, "user_url": "https://github.com/Minoru"
, "day_average": 1
, "week_average": 1
, "month_average": 1
} ] }
, { "type": "repo_stats"
, "stats": [ {
"repo": "world-domination"
, "repo_url": "https://github.com/orgs/codingteam/world-domination"
, "day_average": 15
, "week_average": 1050
, "month_average": 100500
} ] } ]
Body: empty
/organizations/codingteam/analytics
Body:
[ { "user": "Minoru"
, "user-url": "http://github.com/Minoru"
, "repos-per-language": {
"haskell": 1
, "shell": 1
} } ]
Body: empty