# github/rest-api-description

An OpenAPI description for GitHub's REST API

Repository: https://github.com/github/rest-api-description
Canonical: https://ross.abutalabs.com/products/rest-api-description
License: MIT
License Family: permissive
Last push: 2026-08-26T16:15:38+00:00

## Health v2 (maintenance only)
Score: 67/100 (v2, computed 2026-09-02T17:46:02.011165+00:00)
- activity 99, release rhythm 8, longevity 100
- inputs: {"age_days": 2263, "days_push": 7, "days_rel": null, "gap_med": null, "n_releases_24m": 0}
- flags: none
- formula: round(0.45*activity + 0.35*rhythm + 0.20*longevity); archived -> min(score, 10)

## Adoption (not part of the score)
Stars 1628, forks 336 (observed 2026-08-28T04:05:13.302497+00:00)

## What it is
OpenAPI (Swagger) descriptions of GitHub's REST API, published as bundled and dereferenced JSON documents in OpenAPI 3.0 and 3.1 formats. It is a machine-readable specification dataset rather than executable software.

## Use cases
- generate a GitHub API client SDK for my language
- validate my GitHub API requests against the official spec
- browse GitHub REST API endpoints in an OpenAPI viewer
- build a mock server for GitHub's REST API
- auto-generate documentation for GitHub API integrations
- type-check my GitHub API wrapper code

## When to choose
- you need a machine-readable spec of GitHub's REST API for codegen, validation, or mocking
- you're building tooling that consumes GitHub API metadata
- you want the official, GitHub-maintained OpenAPI description

## When to avoid
- you need human-readable API documentation (use docs.github.com instead)
- you need a client library rather than a specification
- you need full coverage of every header or alias path, which are still incomplete

## Facets
- artifact type: dataset
- maturity: stable
- function: api-documentation, documentation, sdk
- domain: apis, developer-tools, documentation
- platform: cross-platform
- tags: openapi, github-rest-api, api-specification, code-generation

## Member repositories
- github/rest-api-description (main) score 67

## Provenance
- Observed fields: from GitHub, fetched 2026-08-28T04:05:13.302497+00:00.
- Health v2: computed from the inputs above; adoption is never an input.
- Inferred fields (summary, facets, guidance): AI-extracted, prompt v1, taxonomy v1, on 2026-08-30T03:48:19.861778+00:00, confidence not recorded.
  - readme: https://github.com/github/rest-api-description (fetched 2026-08-28T04:05:13.302497+00:00, sha 501543de968b)
- Data as of 2026-08-30T08:39:29.467469+00:00.