feat: More explicit type for arrays

This commit is contained in:
Ilya Kuznetsov 2025-01-02 16:56:36 +01:00
parent 460a4558e0
commit 541c3e3fb5
No known key found for this signature in database
GPG Key ID: 91F3DDCF5D21CDDF
2 changed files with 11 additions and 1 deletions

View File

@ -100,6 +100,8 @@ func buildMarkdown(nodes []rootNode, outputFile string) error {
m := md.NewMarkdown(f)
m = m.PlainText(header)
for _, node := range nodes {
isArray := len(node.ArrayItemAttributes) > 0
m = m.LF()
if node.TopLevel {
m = m.H2(node.Title)
@ -107,7 +109,13 @@ func buildMarkdown(nodes []rootNode, outputFile string) error {
m = m.H3(node.Title)
}
m = m.LF()
m = m.PlainText(node.Description)
if isArray {
m = m.PlainText("**`Type: Array`**")
m = m.LF()
m = m.PlainText(node.Description)
} else {
m = m.PlainText(node.Description)
}
m = m.LF()
if len(node.ObjectKeyAttributes) > 0 {

View File

@ -235,6 +235,8 @@ Specifies a list of path globs that contain configuration files to include withi
## permissions
**`Type: Array`**
Defines the permissions to apply to experiments, jobs, pipelines, and models defined in the bundle. See [_](/dev-tools/bundles/settings.md#permissions) and [_](/dev-tools/bundles/permissions.md).
Each item of `permissions` has the following attributes: