docs: fix mocking config note and invalid JSON in elasticsearch-logger examples#13543
Open
AlinsRan wants to merge 1 commit into
Open
docs: fix mocking config note and invalid JSON in elasticsearch-logger examples#13543AlinsRan wants to merge 1 commit into
AlinsRan wants to merge 1 commit into
Conversation
…r examples
- mocking: the docs say response_example and response_schema must not be
configured together, but the schema uses anyOf (at least one) and the
plugin prefers response_example when both are set. Correct the en/zh
description accordingly.
- elasticsearch-logger: the Admin API examples had a trailing comma after
the only field ("index": "gateway",), making the JSON invalid for
copy-paste. Remove it (en + zh, two places each).
Signed-off-by: AlinsRan <alinsran@apache.org>
5457d34 to
7a5b4e1
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What this fixes
Two documentation issues found during a docs audit:
1. mocking — inaccurate constraint description
docs/{en,zh}/latest/plugins/mocking.mdstate thatresponse_exampleandresponse_schema"must not be configured together". That is wrong: the schema usesanyOf(at least one required), so configuring both is valid, and the plugin prefersresponse_examplewhen both are set:Corrected to: at least one must be configured; if both are configured,
response_exampletakes precedence andresponse_schemais ignored.2. elasticsearch-logger — invalid JSON in examples
The Admin API examples had a trailing comma after the only key (
"index": "gateway",), which makes the JSON invalid on copy-paste. Removed it (en + zh, two places each).Checklist