API Request URL for listing the articles within a GitHub repo wiki

[theballaam96]

Select Topic Area

Question

Body

I would like to get a list of wiki articles that are contained within a GitHub wiki. I can't find any documentation of this on the REST API docs, nor does appending /wiki or .wiki to the end of the repository name in the URL yield any benefits with the API call

[dkt147]

Here's a step-by-step approach using the GitHub REST API:

1. Get the Repository's Git Tree SHA:
   You can use the following endpoint to get the SHA of the repository's default branch:

   GET /repos/:owner/:repo/git/refs/heads/:branch

   Replace :owner, :repo, and :branch with your repository's owner, name, and the default branch, respectively.

   Example:

   GET /repos/octocat/Hello-World/git/refs/heads/main

2. Get the Git Tree for the Wiki:
   Use the obtained SHA to get the tree of the repository. The recursive parameter should be set to 1 to include the content of the entire tree:

   GET /repos/:owner/:repo/git/trees/:tree_sha?recursive=1

   Replace :owner, :repo, and :tree_sha with your repository's owner, name, and the SHA from the previous step.

   Example:

   GET /repos/octocat/Hello-World/git/trees/<tree_sha>?recursive=1

3. Parse the Tree for Wiki Articles:
   Parse the response to identify the entries within the tree array that correspond to the wiki articles. The entries would typically be under a path like /<repo_name>/wiki/.

   Each wiki article may be represented by a blob entry in the tree.

Please note that GitHub's APIs might have been updated after my last knowledge update in January 2022, and it's a good idea to check the latest GitHub API documentation for any new features or changes.

As an alternative, consider using the GitHub GraphQL API, as it might offer more flexibility in querying for specific data. The GraphQL API allows you to request only the data you need, which can be beneficial for complex queries.

[theballaam96]

Hello dkt, thanks for the response to this. Unfortunately, your suggestion didn't work, likewise I didn't find anything on the REST API docs to suggest that the structure or format would change.

• Step 1 output
• Step 2 output

There's no presence of the wiki article markdown files in the output. However, I recognize that this might be as a result of the repository having a ./wiki directory inside it already (perhaps causing some issues), so I tested it with another repo which has a wiki but not a ./wiki directory in the repository:

• Step 1 output
• Step 2 output

Despite the repository having a wiki with an article, there is no presence of "wiki" or "tamper" in the output.

[ghostinhershell]

Hi @theballaam96,

Thanks so much for reaching out in our community. Unfortunately, there are no APIs for repository wikis, only a has_wiki field when looking at a repository that identifies if a repository has a wiki. If you would like, I can open a feature request for this on your behalf.

[theballaam96]

That would be amazing. Thanks!

[ghostinhershell]

I gotcha, thanks so much for following up here and have a great day!

[usman-careem]

Hi @ghostinhershell , any update on this feature? I was also kindda hoping to access the wiki docs via REST API.

[hmartinez82]

+1️⃣ from me

[jmnarloch]

Interested as well in this feature.