[Bug]: --with-doc flag not working about k8sgpt HOT 3 OPEN

@golgoth31 if I am correct, this actually just checks to see if there is an error from OpenAPIschema right? Do we think there needs to be some more work done to clarify what this command really does?

	// we get the openapi schema from the server only if required by the flag "with-doc"
	openapiSchema := &openapi_v2.Document{}
	if a.WithDoc {
		var openApiErr error

		openapiSchema, openApiErr = a.Client.Client.Discovery().OpenAPISchema()
		if openApiErr != nil {
			a.Errors = append(a.Errors, fmt.Sprintf("[KubernetesDoc] %s", openApiErr))
		}
	}

from k8sgpt.

Hi @AlexsJones , The command you mention is the command to extract the full openapi schema from the target kubernetes cluster only if requested by the "with-doc" flag.

Unfortunatly, this is not used if not requested by an analyser. For exemple, the cronjob analyser:

• configure the openapi schema parser https://github.com/k8sgpt-ai/k8sgpt/blob/main/pkg/analyzer/cronjob.go#L33
• perse the schema when needed https://github.com/k8sgpt-ai/k8sgpt/blob/main/pkg/analyzer/cronjob.go#L56

If the nothing is found or the schema not parsed, the kubernetesDoc string is empty and the output is not shown https://github.com/k8sgpt-ai/k8sgpt/blob/main/pkg/analysis/output.go#L81

We have multiple ways to fix this:

• always add a kubernetesDoc value to "not available"; replaced by the real value if found
• update the documentation to say that nothing is displayed if not found

In a first run, I can add all the missing openapi parsing requests to the known objects.

Do you have any guide lines for the analysers writing, if yes, we schould add this part.

from k8sgpt.

@AlexsJones Can I work on this issue?

from k8sgpt.