Mark output-only fields with doNotSuggest (#3599)

## Changes
1. Mark output-only fields with `doNotSuggest: true` to exclude them
from autocompletion
2. Remove output-only fields from docs

## Why
Currently, we suggest all fields in code-completion, but fields marked
in the OpenAPI spec as output-only are not used by the CLI

## Tests
Added unit test

<!-- If your PR needs to be included in the release notes for next
release,
add a separate entry in NEXT_CHANGELOG.md as part of your PR. -->

Author: ilyakuz-db

bundle/docsgen/main.go

@@ -141,6 +141,9 @@ func assignAnnotation(s *jsonschema.Schema, a annotation.Descriptor) {
 		s.DoNotSuggest = true
 		s.Preview = a.Preview
 	}
+	if a.OutputOnly != nil && *a.OutputOnly {
+		s.DoNotSuggest = true
+	}
 }
 
 func fillTemplateVariables(s string) string {

bundle/docsgen/nodes.go

@@ -61,12 +61,15 @@ func buildNodes(s jsonschema.Schema, refs map[string]*jsonschema.Schema, ownFiel
 			continue
 		}
 		visited[k] = true
+		v = resolveRefs(v, refs)
 
 		if v.Deprecated {
 			continue
 		}
+		if v.DoNotSuggest {
+			continue
+		}
 
-		v = resolveRefs(v, refs)
 		node := rootNode{
 			Title:       k,
 			Description: getDescription(v),
@@ -172,6 +175,9 @@ func getAttributes(props, refs map[string]*jsonschema.Schema, ownFields map[stri
 	var attributes []attributeNode
 	for k, v := range props {
 		v = resolveRefs(v, refs)
+		if v.DoNotSuggest {
+			continue
+		}
 		typeString := getHumanReadableType(v.Type)
 		if typeString == "" {
 			typeString = "Any"

bundle/docsgen/nodes_test.go

@@ -142,6 +142,35 @@ func TestDeprecatedFields(t *testing.T) {
 	assert.Equal(t, "nested deprecation message", nodes[0].Attributes[0].Description)
 }
 
+func TestDoNotSuggestFields(t *testing.T) {
+	s := jsonschema.Schema{
+		Type: "object",
+		Properties: map[string]*jsonschema.Schema{
+			"doNotSuggestField": {Extension: jsonschema.Extension{DoNotSuggest: true}},
+			"notDoNotSuggestField": {
+				Properties: map[string]*jsonschema.Schema{
+					"nestedDoNotSuggestField": {
+						Description: "nested description",
+						Extension: jsonschema.Extension{
+							DeprecationMessage: "nested do message",
+							DoNotSuggest:       true,
+						},
+					},
+					"nestedNotDoNotSuggestField": {
+						Description: "nested suggested field",
+					},
+				},
+			},
+		},
+	}
+	nodes := buildNodes(s, nil, nil)
+	assert.Len(t, nodes, 1)
+	assert.Equal(t, "notDoNotSuggestField", nodes[0].Title)
+
+	assert.Len(t, nodes[0].Attributes, 1)
+	assert.Equal(t, "nestedNotDoNotSuggestField", nodes[0].Attributes[0].Title)
+}
+
 func strPtr(s string) *string {
 	return &s
 }