The GitHub repos, branches, and folders that Speccy reads bundles from (REQ-123).

GET

/github/sources

curl --request GET \
  --url https://example.com/api/v1/github/sources

Responses

200

The sources.

Media typeapplication/json

object

items

required

Array<object>

A repo, a branch and a folder whose bundles Speccy reads.

object

id

required

string format: uuid

repo

required

string

branch

required

string

path

required

The folder, relative to the repo root.

string

head_commit

required

string

synced_at

string format: date-time

error

required

string

bundles

required

integer

adopted

How many docs of this source have a type accepted in Speccy (REQ-133).

integer

Example^generated

{
  "items": [
    {
      "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "repo": "example",
      "branch": "example",
      "path": "example",
      "head_commit": "example",
      "synced_at": "2026-04-15T12:00:00Z",
      "error": "example",
      "bundles": 1,
      "adopted": 1
    }
  ]
}

default

An error.

Media typeapplication/problem+json

RFC 9457 problem details with a stable code.

object

type

required

string

title

required

string

status

required

integer

detail

string

instance

string

code

required

A stable machine-readable error code.

string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "code": "example"
}