HTTP API: brief

Co obklopuje jednu pracovní relaci, na jednom řádku i v několika: její epizoda a úloha, peeři ze všech nástěnek, mesh, integrační fronta a fronta derive, přičemž každá sekce se ptá svého vlastníka jednou a říká, zda se dala přečíst. Odpověď, kterou relace hlásí o sobě sama, aniž by se jí kdo ptal, a kterou provider mod zobrazuje jako svůj stavový řádek (ADR 0136). Nic nezapisuje.

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.

brief

GET /api/v1/brief brief.session

Brief relace

Jeden řádek a několik dalších: epizoda a úloha této relace (ta, kterou vlastní daná relace providera, jinak ta, na kterou ukazuje ukazatel), peeři každé nástěnky s pojmenovanými nástěnkami, které nešlo přečíst, linky meshe a to, co jeho žurnál adresuje tomuto runtimu, fronta integrace tak, jak ji říká `majordomus prs brief`, a zámek odvozování stroje. Skládá ji server držící lease tohoto checkoutu, který drží nástěnku a mesh: příkazová řádka se ho ptá a brief skládá sama, jen když neodpoví žádný, a řekne to; nahrazený server říká, že jeho vlastní nástěnka je pro sběr repozitáře nedosažitelná. Nese interval hlášení, který politika deklaruje (`session.brief_interval_minutes`), a text keep-awake, který se relaci řekne na začátku. Nic nezapisuje.

query
behaviorally_verified
vyžaduje se měření výkonu
cache vypnuta
nástroj MCP majordomus_brief
$ brief

Parametry dotazu

název	typ	povinné	popis	příklady
session	string	ne	Vlastní identita relace providera (id relace Claude Code): brief pojmenuje otevřenou epizodu, kterou ta relace vlastní. Pokud chybí, epizoda, na kterou se rozliší ukazatel.	výchozí: "00000000-0000-0000-0000-000000000000"
checkouty	Checkouty	ne	Které checkouty pokrývá sekce peers: `repository` (každá nástěnka, výchozí) nebo `this`.	výchozí: "this"
lokální	boolean	ne	Skládat v procesu, který odpovídá, a nikdy se neptat držitele leasu checkoutu: co říká přeposlaný požadavek, aby se nikdy nepřeposílal znovu.	výchozí: true

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/brief?session=00000000-0000-0000-0000-000000000000&checkouts=this&local=true"

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	SessionBrief	Brief relace: výsledek.
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.

BriefDeriveSection

object

Fronta derive stroje: její zámek a značka priority (lib/machine_lock.sh).

vlastnost	typ	povinné	popis
state	BriefSectionState → BriefSectionState	ano	`undeclared`, když repozitář nedodává žádný zámek derive.
držitel	string \| null	ne	Řádek vlastníka zámku, když je zámek držen.
pid	integer \| null	ne	Id procesu držitele, když ho jeho řádek jmenuje.
živý	boolean \| null	ne	Zda tento proces běží na tomto stroji.
held_seconds	integer \| null	ne	Sekundy od převzetí zámku.
priorita	string \| null	ne	Větve, které jmenuje značka priority, pokud je přítomna.
summary	string	ano	Sekce slovy.

Používá SessionBrief

BriefIntegrationSection

object

Integrační fronta, jak ji vyjadřuje majordomus prs brief.

vlastnost	typ	povinné	popis
state	BriefSectionState → BriefSectionState	ano	Zda tento checkout kdy forge pozoroval.
summary	string	ano	Sekce slovy.

Používá SessionBrief

BriefMeshSection

object

Mesh: linky tohoto runtimu a to, co mu žurnál adresuje.

vlastnost	typ	povinné	popis
state	BriefSectionState → BriefSectionState	ano	Zda šlo spolupráci přečíst.
aktivní	boolean	ano	Zda spolupráce běží ve skládajícím procesu.
důvod	string \| null	ne	Proč ne, když ne.
odkazy	integer (uint)	ano	Spojení s ostatními runtimy.
připojeno	integer (uint)	ano	Z nich připojených.
selhávající	integer (uint)	ano	Z nich: degradované, nedostupné nebo prošlé.
claims_held	integer (uint)	ano	Nároky držené napříč meshem.
own_claims	integer (uint)	ano	Z nich drží tento runtime.
reviews_for_you	integer (uint)	ano	Otevřené žádosti o review, které jako recenzenta pojmenovávají tento runtime.
handovers_waiting	integer (uint)	ano	Předávky, které publikoval jiný runtime a které nikdo nespotřeboval.
overlaps_for_you	integer (uint)	ano	Překryvy mezi nárokem tohoto runtime a nárokem jiného.
summary	string	ano	Sekce slovy.

Používá SessionBrief

BriefOrigin

object

Který proces briefing sestavil a proč právě tento.

vlastnost	typ	povinné	popis
proces	string	ano	`leaseholder` (server, který jmenuje lease tohoto checkoutu), `superseded` (server, který lease ztratil), nebo `this_process` (žádný server neodpověděl, nebo volání požádalo o `local`).
url	string \| null	ne	Adresa serveru, který ji složil, pokud nějaký.
poznámka	string \| null	ne	Proč tento proces a ne držitel leasu, když není držitelem leasu.

Používá SessionBrief

BriefPeersSection

object

Workeři tohoto repozitáře ze všech nástěnek, které brief dokázal přečíst.

vlastnost	typ	povinné	popis
state	BriefSectionState → BriefSectionState	ano	Zda bylo možné přečíst každou nástěnku.
připojeno	integer (uint)	ano	Připojení peeři napříč přečtenými nástěnkami, včetně volajícího.
nástěnky	integer (uint)	ano	Kolik nástěnek odpověď pokrývá.
nepřečteno	array of string	ne	Každá nástěnka, kterou nešlo přečíst, jako `<worktree>: <reason>`.
překryvy	integer (uint)	ano	Dvojice peerů, jejichž nárokované rozsahy se setkávají.
nahrazeno	string \| null	ne	Nastaveno, když je skládající server nahrazen: jeho vlastní nástěnka je pro sběr repozitáře nedosažitelná.
pojmenováno	array of string	ano	Připojení peers, jeden krátký řádek každý, nejvýše omezený počet.
summary	string	ano	Sekce slovy.

Používá SessionBrief

BriefSectionState

"read" | "partial" | "unread" | "undeclared"

Zda šlo přečíst sekci briefu.

readJeho vlastník odpověděl v plném rozsahu.
partialJeho vlastník odpověděl a část toho, co pokrývá, se nepodařilo zjistit; souhrn říká, kterou.
unreadJeho vlastník neodpověděl; shrnutí říká proč.
undeclaredRepozitář pro to nic nedeklaruje (žádný derive lock, vypnutý mesh).

Používá BriefDeriveSection BriefIntegrationSection BriefMeshSection BriefPeersSection BriefSessionSection

BriefSessionSection

object

Relace, o které brief je.

vlastnost	typ	povinné	popis
state	BriefSectionState → BriefSectionState	ano	Zda šlo přečíst.
epizoda	string \| null	ne	Otevřená epizoda, když se najde.
provider_session	string \| null	ne	Relace poskytovatele, která ho vlastní.
větev	string	ano	Větev checkoutu.
head	string	ano	Head checkoutu, zkráceně.
task_id	string \| null	ne	ID aktivní úlohy, je-li nějaká aktivní.
úloha	string \| null	ne	Slova aktivní úlohy.
volající	string \| null	ne	Místo volající relace MCP na této nástěnce, když volání přišlo přes jednu z nich.
summary	string	ano	Sekce slovy.

Používá SessionBrief

SessionBrief

object

Odpověď brief.session: co obklopuje jednu relaci, v jednom řádku a v několika.

vlastnost	typ	povinné	popis
v	string	ano	Kdy byl složen, RFC 3339.
řádek	string	ano	Brief jednou řádkou: text stavového řádku.
řádky	array of string	ano	Brief v několika řádcích: jeden na sekci, pak peery, které jmenuje.
interval_minutes	integer (uint64)	ano	Jak často relace hlásí sama o sobě, v minutách (`session.brief_interval_minutes`).
keep_awake	string	ano	Co se relaci na jejím začátku říká o tom, jak se udržet vzhůru.
answered_by	BriefOrigin → BriefOrigin	ano	Který proces ji sestavil.
session	BriefSessionSection → BriefSessionSection	ano	Tato relace: její epizoda a úloha.
peers	BriefPeersSection → BriefPeersSection	ano	Pracovníci všech nástěnek.
mesh	BriefMeshSection → BriefMeshSection	ano	Mesh.
integrace	BriefIntegrationSection → BriefIntegrationSection	ano	Integrační fronta.
derive	BriefDeriveSection → BriefDeriveSection	ano	Fronta derive.

Používá brief.session