docs(external): fix enrichment_table
and secret
docs
#22319
+101
−128
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
I try to fix the issue mentioned in #22234, and I also find the similar change is needed in
enrichment_table
when I dive deep into the document.I find the
secret
is not a simple enum, and it's more like a classic Rust enum which may have different optional fields.Listened the hint by @pront, I find the
kind
field is optional field whentype
iscounter
inlog_to_metrics transform
, which is similar to our case.The log_to_metrics docs insert a optional
relevant_when
field to let the reader knows that this is a optional field in certain case. I try to insert the same notice to bothenrichment_table
andsecret
.Please note that there are some big change in the PR. At first, I put all of the type descriptions above, and try to merge them into concise one. Secondly, I would merge the optional field description as well when there are conflicted name (
path
) for differenttype
.Change Type
Is this a breaking change?
How did you test this PR?
Does this PR include user facing changes?
Checklist
make check-all
is a good command to run locally. This check isdefined here. Some of these
checks might not be relevant to your PR. For Rust changes, at the very least you should run:
cargo fmt --all
cargo clippy --workspace --all-targets -- -D warnings
cargo nextest run --workspace
(alternatively, you can runcargo test --all
)Cargo.lock
), pleaserun
dd-rust-license-tool write
to regenerate the license inventory and commit the changes (if any). More details here.References
Closes: #22234
It looks strange in this PR, but I think a picture worths thousands of world.
Secret description:
Secret type:
Secret optional fields: