From 541c3e3fb5773f123082af50e0ff68be881bba50 Mon Sep 17 00:00:00 2001 From: Ilya Kuznetsov Date: Thu, 2 Jan 2025 16:56:36 +0100 Subject: [PATCH] feat: More explicit type for arrays --- bundle/internal/docs/docs.go | 10 +++++++++- bundle/internal/docs/docs.md | 2 ++ 2 files changed, 11 insertions(+), 1 deletion(-) diff --git a/bundle/internal/docs/docs.go b/bundle/internal/docs/docs.go index 4948cc992..57d42ce14 100644 --- a/bundle/internal/docs/docs.go +++ b/bundle/internal/docs/docs.go @@ -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 { diff --git a/bundle/internal/docs/docs.md b/bundle/internal/docs/docs.md index 94f556157..04b1e83d3 100644 --- a/bundle/internal/docs/docs.md +++ b/bundle/internal/docs/docs.md @@ -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: