Skip to content
GitmoapAPIBeta
Schema

SpecDocSummary

One indexed spec document: its metadata, its counts and the commit it was indexed at.

Shape

  • block_countinteger · int32
  • byte_leninteger · int32
  • corpus_idCorpusId (string · uuid)
  • doc_idstring
  • finding_countinteger · int32
  • last_seen_shastring
  • pathstring
  • postureSpecPosturedeclareduntypedWhether a document claims to follow the spec format. A declared document carries gsf: 1 in its frontmatter and is checked in full; an untyped one made no claim and is never reported for not following it.
  • profilestring
  • record_countinteger · int32
  • staleboolean
  • stemstring
  • synced_atstring
  • titlestring
  • createdstring or nulloptional
  • depends_onarray of stringoptional
  • gsf_versioninteger · int32 or nulloptional
  • kindstring or nulloptional
  • last_reviewedstring or nulloptionalISO YYYY-MM-DD, verbatim from the frontmatter.
  • orphaned_atstring or nulloptionalWhen the file stopped being present in the repository. The record is kept rather than deleted, so an existing link still resolves and tells you it moved.
  • owner_group_idGroupId (string · uuid) or nulloptional
  • owner_principal_idPrincipalId (string · uuid) or nulloptional
  • parent_doc_idstring or nulloptional
  • part_of_doc_idstring or nulloptional
  • statusSpecStatusdraftreviewapprovedimplementedpartialsupersededlivingnoneor nulloptionalA document's declared lifecycle state. none is a real value rather than an absence: a document that declares status: none has said the question does not apply to it, which is a different fact from one that declared nothing.
  • status_notestring or nulloptional
  • summarystring or nulloptional
  • superseded_bystring or nulloptional
  • tagsarray of stringoptional

Example

Synthesized example
{
"block_count": 4,
"byte_len": 76,
"corpus_id": "56380012-b49c-44a6-a31f-d42710b6fb60",
"doc_id": "e2b838b9-b172-4b0a-8d76-111b586ead75",
"finding_count": 2,
"last_seen_sha": "2fbce2dbfb99b1f6f7a6672a00590b4fb12b2d8f",
"path": "path-52ad",
"posture": "declared",
"profile": "profile-560f",
"record_count": 0,
"stale": false,
"stem": "stem-c57f",
"synced_at": "2026-10-14T22:11:39Z",
"title": "Label every synthesized example",
"created": "created-7eec",
"depends_on": [
"depends-on-9e8f"
],
"gsf_version": 29,
"kind": "kind-c481",
"last_reviewed": "last-reviewed-ef7d",
"orphaned_at": "2026-10-14T01:24:50Z",
"owner_group_id": "4c1d8e2f-6a3b-4f90-b7c5-1e2d3c4b5a69",
"owner_principal_id": "30e3e005-fcc4-4ef1-9be8-3728aeef0f9e",
"parent_doc_id": "c21a5499-583f-48a3-a8de-a6bedfb7d1d3",
"part_of_doc_id": "d64faf06-87f4-468a-b92e-e0fa707fda59",
"status": "draft",
"status_note": "status-note-5b1e",
"summary": "summary-fee1",
"superseded_by": "b7e2d1c0-9f8e-4d7c-a6b5-c4d3e2f1a0b9",
"tags": [
"tags-889f",
"tags-de95"
]
}

Graph

Used inside
Contains

No named schema inside.

Used by

Sent by 0 operations

No operation takes it as a request body.

Returned by 0 operations

No operation returns it directly.