Skip to content

Commit a481e7f

Browse files
committed
docs(api): note seg parent containment kind rules
1 parent 58ed264 commit a481e7f

File tree

1 file changed

+16
-3
lines changed

1 file changed

+16
-3
lines changed

openapi.yaml

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3263,9 +3263,22 @@ components:
32633263
examples:
32643264
- seg:42
32653265
- type: 'null'
3266-
description: The unique identifier of the 'parent' segment immediately containing
3267-
this segment or `null` if the segment has no parent (i.e., it is a root-level
3268-
segment).
3266+
description: 'The unique identifier of the ''parent'' segment immediately
3267+
containing this segment or `null` if the segment has no parent (i.e.,
3268+
it is a root-level segment).
3269+
3270+
3271+
A segment with the `container` kind can be the parent of segments of any
3272+
kind, including other `container`s.
3273+
3274+
3275+
A segment with the `unit` kind can only be the parent of `item`s and `figure`s.
3276+
3277+
3278+
A segment with the `item` kind can only be the parent of other `item`s.
3279+
3280+
3281+
A segment with the `figure` kind cannot be the parent of any segments.'
32693282
examples:
32703283
- seg:0
32713284
children:

0 commit comments

Comments
 (0)