Openapi followup

[yaauie]

Release notes

[rn: skip]

What does this PR do?

I missed the boat reviewing #17292 before it was merged, so this PR is a series of improvements to the already-merged PR.

Why is it important/What is the impact to the user?

• Improves clarity of generated documentation
• Improves clarity of documentation source for maintainability

Checklist

• My code follows the style guidelines of this project
• [ ] I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• [ ] I have made corresponding change to the default configuration files (and/or docker env variables)
• [ ] I have added tests that prove my fix is effective or that my feature works

Review Notes

NOTE: This PR is a series of independent changes, each as its own commit, and is likely best reviewed commit-by-commit.

How to test this PR locally

Render `docs/static/spec/openapi/logstash-api.yml in https://editor-next.swagger.io/

[mergify]

This pull request does not have a backport label. Could you fix it @yaauie? 🙏
To fixup this pull request, you need to add the backport labels for the needed
branches, such as:

• backport-8./d is the label to automatically backport to the 8./d branch. /d is the digit.
• backport-8.x is the label to automatically backport to the 8.x branch.
• If no backport is necessary, please add the backport-skip label

[yaauie]

474e73f is best reviewed ignoring whitespace

[github-actions]

📃 DOCS PREVIEW ✨ https://logstash_bk_17341.docs-preview.app.elstc.co/diff

[github-actions]

📃 DOCS PREVIEW ✨ https://logstash_bk_17341.docs-preview.app.elstc.co/diff

[github-actions]

📃 DOCS PREVIEW ✨ https://logstash_bk_17341.docs-preview.app.elstc.co/diff

[karenzone]

I get a clean build/preview with BUMP. In slack, I provided a link to instructions for installing and testing locally.

[robbavey]

Running a bump preview on this [PR](https://bump.sh/preview/ae
c6e80e-4740-4a20-ad25-d7088e3cf810/operation/operation-healthreport), I see Additional Properties are NOT allowed rendered for the indicators object:

Whereas the existing content shows:

Is this expected?

[yaauie]

Running a bump preview on this PR, I see Additional Properties are NOT allowed rendered for the indicators object:
...
Is this expected?

Yes; in 2d9b197 we declared (among other things) that the the object at address /indicators/pipelines on the health report does not have additional properties (beyond the specified status, symptom, and indicators).

If this adds undesirable noise, we can back that one out.

[robbavey]

@yaauie Perfect - thank you. Just wanted to double check.

[robbavey]

lgtm

[kaisecheng]

Thanks for adding require fields, changing pipeline name to patternProperties and more improvements. Left one suggestion, otherwise, LGTM

[kaisecheng]

Suggested change

	default: 9600
	default: "9600"

swagger said default must be a string