HTTP API: board

The documents the delivery board reads, derived from the plan, the roadmap, the intents, the recorded pull request queue and the release currency, with the lanes share/board.yaml declares once. Every open milestone is in a lane or the snapshot refuses, naming it.

Vykresleno z docs/generated/openapi.json, který spustitelný soubor generuje ze svého registru schopností a CI jej odmítne, je-li zastaralý. Surový dokument je na /openapi.json; běžící server servíruje stejný dokument na vlastní /openapi.json a Swagger UI na /swagger.

board

GET /api/v1/board/snapshot board.snapshot

The delivery board's documents

Every document of the delivery board by id: meta (the commit, the lanes, the issue counts, the release), milestones in roadmap order, intents, the pull request queue from the last recorded observation, and the open issues of each lane as issues-<lane>, split into issues-<lane>-2 and onwards so that no document serializes past 250000 bytes. The digest is a SHA-256 over the canonical JSON of the documents with meta.syncedAt and meta.syncedBy left out, so equal state is an equal digest. A milestone that is not DONE and is in no lane of share/board.yaml is refused by name, never filed under other. An unobserved queue is said in prs.unavailable and the diagnostics, never refused. Mesh seats, live work, CI runners and blockers are the sync step's and are not here. Reads only; nothing is cached.

query
experimentální
benchmark waived: repository_declaration
cache vypnuta
MCP tool majordomus_board_snapshot
$ board snapshot

Parametry dotazu

název	typ	povinné	popis	příklady
by	string	ne	Who takes the snapshot, as `meta.syncedBy` names it; `board.snapshot` when absent. Left out of the digest.	named: "a mesh session"

Vyzkoušejte

Port je ten, který server zalogoval; 8741 je ten, o který žádá jako první. Hodnoty jsou první příklad operace.

curl -s "http://127.0.0.1:8741/api/v1/board/snapshot?by=a%20mesh%20session"

Testováno v apps/majordomus-cli/tests/http_serve.rs, který přehrává routu s těmito hodnotami proti serveru na skutečném socketu.

Odpovědi

status	tělo	význam
200	BoardSnapshot	The delivery board's documents: the result.
400	ErrorBody	`invalid_input`: Vstup neodpovídá schématu: parametr špatného typu, neznámý parametr nebo hodnota, kterou schopnost odmítne.
404	ErrorBody	`not_found`: Vstup pojmenovává něco, co repozitář nemá.
500	ErrorBody	`internal`: Schopnost selhala z vlastního důvodu; zpráva ho pojmenovává.
výchozí	ErrorBody	Jakékoli jiné selhání, které transport hlásí: 405 `method_not_allowed` pro jinou metodu na této cestě, 400 `invalid_input` pro tělo, které není objektem JSON.

Schémata

Komponenty, které používají jen operace tohoto tagu. Každý řádek je pole daného typu, jeho doc komentář je popis; typ vlastněný jinou stránkou na ni odkazuje.

BoardSnapshot

object

The answer of board.snapshot: every document of the board by id, and the digest that says whether two snapshots describe the same state.

vlastnost	typ	povinné	popis
otisk	string	ano	`sha256:<hex>` over the canonical JSON of the documents, `meta.syncedAt` and `meta.syncedBy` left out: equal state, equal digest.
master_sha	string	ano	The commit described, empty when the checkout has none.
master_committed_at	string	ano	Its committer time, RFC 3339.
master_ref	string	ano	The ref it was read from: `refs/remotes/origin/master`, else `HEAD`.
document_limit	integer (uint)	ano	The bound every document is under, in bytes of compact JSON.
sizes	mapa celých čísel (uint)	ano	Each document's compact size, in bytes, by id.
dokumenty	object	ano	The documents, by id: `meta`, `milestones`, `intents`, `prs`, and `issues-<lane>` (then `issues-<lane>-2`, ...) for each lane with open work.
diagnostika	array of string	ne	What could not be read, in words: an unobserved pull request queue, a lane naming a milestone the plan lacks. Empty is the ordinary case.

Used by board.snapshot