Developer tools
Does the GitHub REST API match its OpenAPI spec?
YesAll 20 operations we tested return responses that match GitHub REST's published OpenAPI spec (last run 1 Nov 2026).
github.contract[*]
Spec match
100%
20 of 20 operations
Mismatches
0
distinct findings
First response
0.25s
median of tested calls
Last run
1 Nov
05:36 UTC
Contract vs. published spec
Every tested operation returned a 2xx response whose body matches the spec.
20 common read endpoints, no token.
Vendor-reported status · 45 days
45 days agotoday
- API now
- operational
- Incident-free days
- 95.6%
- API incidents
- 2
- Mean time to resolve
- 1h 18m
- degradedDisruption with some GitHub services5 Oct, 23:47 UTC
- outageCopilot Code Review is unable to complete reviews28 Sep, 21:16 UTC
Mirrored from www.githubstatus.com. Counts incidents tagged to the API component plus untagged, vendor-wide ones.
Test the GitHub REST API yourself
Portman turns the published spec into contract tests and runs them with Newman.
Star Portman685Portman is open source. A star helps other teams find it.
Questions
- Does the GitHub REST API match its OpenAPI spec?
- Yes. All 20 operations we tested return responses that match GitHub REST's published OpenAPI spec (last run 1 Nov 2026).
- Where is the GitHub REST OpenAPI spec?
- GitHub REST publishes its OpenAPI description at https://github.com/github/rest-api-description.
- Is the GitHub REST API down?
- GitHub REST's status page reported the API as operational at our last check. Over the last 45 days, 95.6% of days had no API incident, with 2 incidents in total. Live status: https://www.githubstatus.com.
- How can I contract-test the GitHub REST API myself?
- Run Portman against the spec: npx @apideck/portman -u https://raw.githubusercontent.com/github/rest-api-description/main/descriptions/api.github.com/api.github.com.json --runNewman. Portman generates contract tests for every operation and checks status codes, content types and response schemas.