🏷️ Discussion Type

Question

💬 Feature/Topic Area

API

Body

I'm auditing a fairly large chunk of code that integrates with GitHub via the REST API. I'm not intimately familiar with the API, so I headed over to https://docs.github.com/en/rest?apiVersion=2026-03-10 so I could verify that all of the API endpoints referenced in the code actually exist, are being called correctly, and that their responses are properly handled. I need an API reference for that reason. The reference documentation for the API is broken into a ton of smaller articles though, each one targeted to some specific purpose (sometimes seemingly niche purposes). This means that, for every API call I see, I have to:

• Guess the name of the article it's going to be in
• Find that article, which is non-trivial because the article search only provides "fuzzy search" and so searching for "rest api endpoints for repositories" gives me six pages of results, with the article "Rest API endpoints for repositories" on page 4
• Click the article, at which point I'm presented with a bunch of API endpoint titles that bear little relationship with the actual endpoint path
• Hunt through the page for the endpoint I want to look up, hopefully finding it
• If I don't find it, resume the steps from the start

I can't search for (partial) endpoint names because the article search function apparently only works on article names, not contents. I can't just Ctrl+F through the reference docs to find what I need because there is no monolithic reference doc. The combo box for selecting an article category is rather unhelpful because it has no "Reference documentation" section. The "REST reference documentation" link on https://docs.github.com/en/rest/using-the-rest-api/getting-started-with-the-rest-api?apiVersion=2026-03-10 just takes me back to the home page.

I'm able to stumble my way through this well enough to still do my job, but it's very painful. Something like https://git.lubuntu.me/api/swagger would be very helpful. Does something like this exist, or could it exist in the future?