elastic / elastic/crd-ref-docs

Support for expanding embedded structs

Open
#158 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
Go
Stars
173
Forks
81
PR merge metrics
No merged PRs in 30d

Description

Hello everyone! I am from Prometheus-Operator 👋

We want to use `crd-ref-docs` in Prometheus-Operator for API reference. But, we are currently facing a problem while testing it 😫 . There is a struct called `ProxyConfig` that does not expand while generating the API-reference and looks like [this](https://deploy-preview-136--sleepy-hopper-0fdb6b.netlify.app/docs/api-reference/elastic-api/#proxyconfig) in the docs. I believe that `crd-ref-docs` cannot expand embedded structs. Here is the [link](https://github.com/prometheus-operator/prometheus-operator/blob/9be68efafca772687346ffa8b8cc0cbeba88d1e7/pkg/apis/monitoring/v1/types.go#L93) to the `ProxyConfig` struct code.

I want assistance with this if possible.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.