← all corpora

github-api-description

reference corpus · status live · domain API (API design and specification) · lane A · refresh weekly · tags GLOBAL · DESIGN

What an agent uses it for

an agent building a GitHub integration queries this for the machine-readable schema of a huge production REST API (the exemplar OpenGraph/OpenAPI corpus)

Use it
curl -fsSLO https://raw.githubusercontent.com/xerj-org/xerj/corpus-hub/tools/xerj-code/hub/github-api-description.json
xerj corpus add --from ./github-api-description.json
xerj corpus index github-api-description then xerj code github-api-description "your question"

Needs the xerj CLI and a local node running; the copy prompt covers both, checks each step, and shows how to stop only the node you started. No shell: the MCP tool xerj_code_search with corpus: "github-api-description", once the corpus is indexed on the node.

Sources and pins

sourcepinlicencesizereview note
github-api-description 7bdf5f005536MIT 7.3 GB / 419 files LICENSE.md at pin: MIT (README names it). G7 graded 2026-10-03/04: 3/5 relevant (3 pass) on the pre-registered wave-1 suite: protocol.html + descriptions surfaced; the schema-enum queries graded on hit content. Evidence: backlog/g7-tonight-2026-10-03-graded.json.

7.3 GB across 419 files. Added 2026-10-02.

People behind this corpus

Upstream authors (1)

Owners of the pinned repositories, credited under each repository's licence. They have not signed up here; their pages are attribution.

All contributors.

Rights

MIT. Redistribution permitted with attribution per the licence review. The review block records a human opening each licence file at the pin. Detector output is a hint, never the verdict.

Retrieval spot-check (G7)

3.0/5 relevant. Graded .

Q: What is the maximum number of results per page you can request from a GitHub REST API listing endpoint?
expect:
top-5: github-api-description/descriptions/ghes-2.19/ghes-2.19.yaml / github-api-description/descriptions/ghes-2.18/ghes-2.18.yaml / github-api-description/descriptions/ghes-2.21/ghes-2.21.yaml / github-api-description/descriptions/ghes-2.20/ghes-2.20.yaml / github-api-description/descriptions/ghes-2.18/dereferenced/ghes-2.18.deref.yaml
grade: miss
Q: Does calling the endpoint that reports my remaining GitHub API quota use up part of that quota?
expect:
top-5: github-api-description/descriptions/ghes-2.18/dereferenced/ghes-2.18.deref.yaml / github-api-description/descriptions/ghes-2.20/dereferenced/ghes-2.20.deref.yaml / github-api-description/descriptions/ghes-2.21/dereferenced/ghes-2.21.deref.yaml / github-api-description/descriptions/ghes-2.19/dereferenced/ghes-2.19.deref.yaml / github-api-description/descriptions/ghes-2.21/ghes-2.21.yaml
grade: pass
Q: In the GitHub REST search API, what can go into the q query parameter besides plain keywords?
expect:
top-5: github-api-description/descriptions/ghes-2.18/dereferenced/ghes-2.18.deref.yaml / github-api-description/descriptions/ghes-2.20/dereferenced/ghes-2.20.deref.yaml / github-api-description/descriptions/ghes-2.21/dereferenced/ghes-2.21.deref.yaml / github-api-description/descriptions/ghes-2.19/dereferenced/ghes-2.19.deref.yaml / github-api-description/descriptions/ghes-2.18/dereferenced/ghes-2.18.deref.yaml
grade: pass
Q: How do I list only closed issues with the GitHub REST API instead of just the open ones?
expect:
top-5: github-api-description/descriptions/ghes-2.18/dereferenced/ghes-2.18.deref.yaml / github-api-description/descriptions/ghes-2.20/dereferenced/ghes-2.20.deref.yaml / github-api-description/descriptions/ghes-2.21/dereferenced/ghes-2.21.deref.yaml / github-api-description/descriptions/ghes-2.19/dereferenced/ghes-2.19.deref.yaml / github-api-description/descriptions/ghes-2.19/ghes-2.19.yaml
grade: pass
Q: When merging a pull request through the GitHub REST API, how do I choose between a merge commit, squash, or rebase?
expect:
top-5: github-api-description/descriptions/ghes-2.18/dereferenced/ghes-2.18.deref.yaml / github-api-description/descriptions/ghes-2.20/dereferenced/ghes-2.20.deref.yaml / github-api-description/descriptions/ghes-2.21/dereferenced/ghes-2.21.deref.yaml / github-api-description/descriptions/ghes-2.19/dereferenced/ghes-2.19.deref.yaml / github-api-description/descriptions/ghes-2.19/ghes-2.19.yaml
grade: miss

Agent score

From structured reviews that AI agents send after they use this corpus: through xerj hub pull, MCP queries, or the xerj_corpus_feedback tool. Each review rates usefulness 1–5, whether the answer was found, and freshness. This is not the human hub star count shown above. The two are never mixed.

Loading agent reviews…

Score = Bayesian mean of usefulness (prior 3.0 with weight 5), so a few reviews cannot swing it. One voice per installation per corpus per week; abnormal-volume reviewers are dropped. Coverage gaps appear only once 3 or more agents report the same one. How it works.

Traffic

Traffic stats load from /api/hub-traffic when this page runs JavaScript.

Views: visits to this page (search-engine crawlers excluded). Unique: distinct visitors per day, by a hash salted with the day, so the 14-day unique figure adds up daily uniques. Pulls: growth of the GitHub release download count of this corpus’s pack (xerj hub pull downloads from there; includes our own pack-verification downloads). Searches: hosted-hub queries for this corpus. Referring sites appear after 3 views. What is collected.

Agent usage

Usage stats load from /api/hub-usage when this page runs JavaScript.

Counted: requests agents send to the hosted hub API (hub.xerj.org/api/v1/code, /def) for this corpus. Queries on your own node (xerj code, xerj ask with a local pack, the MCP tools) never leave your machine and are not counted. Templates replace identifiers, versions, paths, numbers and quoted text with placeholders; one is shown only once it has been seen 3 times in 30 days, and any word asked fewer than 3 times shows as <term>. Raw queries are never published. What is collected.