Adds a required type tag to the open API spec of Logstash APIs.

[mashhurs]

Release notes

[rn:skip]

What does this PR do?

Adds required type for open API spec in logstash-yaml.

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

N.A

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

Author's Checklist

• [ ]

How to test this PR locally

Related issues

• Closes [DOCS] OpenAPI discriminator error #18022

Use cases

Screenshots

Logs

[github-actions]

🤖 GitHub comments

Expand to view the GitHub comments

Just comment with:

• run docs-build : Re-trigger the docs validation. (use unformatted text in the comment!)

[mergify]

This pull request does not have a backport label. Could you fix it @mashhurs? 🙏
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.
• If no backport is necessary, please add the backport-skip label

[mashhurs]

@karenzone Can you please 🙏 assign this to someone who is familiar with open API specs in docs team. Thank you!

[kaisecheng]

It isn’t required to set the type under schema. Since PipelinesStats is defined as type: object, the allOf will already produce an object type. This section passed the Swagger editor check. Are you encountering any issues?

[mashhurs]

Ah, I have zero knowledge about this domain here. The issue says discriminator: "type" must be required. As my understanding, it is about queue.type of the PipelineQueueStats. Since it always present (memory or persisted), I am going to add required.
I have updated the PR with this commit

[karenzone]

@lcawl FYI. Take a look, please?

[mashhurs]

@lcawl FYI. Take a look, please?

My this comment would be helpful to clarify suggested option B)

[lcawl]

Thanks, that addresses the linting error.