SpecBlock
One heading in a spec document. A heading is identified by its name and linked to by its
anchor; its number, when it has one, is for display only.
Shape
- anchorstring
- end_lineinteger · int32
- headingstring
- kindstring
- levelinteger · int32
- namestring
- ordinalinteger · int32
- start_lineinteger · int32
- heading_numberstring or nulloptional
- markerstring or nulloptional
- parent_ordinalinteger · int32 or nulloptionalThe enclosing block's
ordinal, not its id — the tree is addressed the way it is read. - summarystring or nulloptional
Example
Synthesized example{
"anchor": "anchor-6bbd",
"end_line": 11,
"heading": "heading-414d",
"kind": "kind-8a0c",
"level": 48,
"name": "payments-api",
"ordinal": 76,
"start_line": 58,
"heading_number": "heading-number-cb28",
"marker": "marker-7220",
"parent_ordinal": 73,
"summary": "summary-a030"
}
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.