GitHub

GitHub API

Article indexing, repo content retrieval, and webhook handling.

Auth

Most endpoints use AuthGuard with PUBLIC permission.

Repo access requires owner session unless repo is "gitbook".

GET /github/:repo/articles

Get paginated articles for a repo.

Permission: PUBLIC Guard: AuthGuard

Name	Type	Required	Notes
page	number	No	Default 1.
limit	number	No	Default 10, max 100.

{ "articles": [], "total": 0, "page": 1, "limit": 10, "totalPages": 0 }

If repo is not "gitbook", the session user must have owner == true.

POST /github/:repo/reindex

Reindex a repo path for articles.

Permission: READ_WRITE Guard: AuthGuard

Name	Type	Required	Notes
path	string	Yes	File or directory path.
refresh	boolean	No	Clear cache before reindex.

{ "message": "Reindex process completed", "success": true, "repo": "repo", "path": "docs", "indexed": 10, "errors": 0 }

GET /github/:repo/*

Fetch repo content for a given path. The wildcard captures everything after the repo name.

Permission: PUBLIC Guard: AuthGuard

Name	Type	Required	Notes
repo	string	Yes	Repo slug.
*	string	No	Path segment after /github/:repo/

GitHub contents API payload.

POST /github/:repo/webhook

Handle GitHub webhook events for repo indexing.

Permission: PUBLIC

Name	Required	Notes
x-github-event	Yes	Event type, e.g. push or ping.
x-hub-signature-256	Yes	HMAC signature for verification.

Raw JSON payload from GitHub.

Raw body must be available for signature verification.